Class DelegationRequest

java.lang.Object
software.amazon.awssdk.services.iam.model.DelegationRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DelegationRequest.Builder,DelegationRequest>
@Generated("software.amazon.awssdk:codegen") public final class DelegationRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DelegationRequest.Builder,DelegationRequest>

Contains information about a delegation request, including its status, permissions, and associated metadata.

See Also:

  • Method Details

    • delegationRequestId

      public final String delegationRequestId()

      The unique identifier for the delegation request.

      Returns:
      The unique identifier for the delegation request.

    • ownerAccountId

      public final String ownerAccountId()

      Amazon Web Services account ID of the owner of the delegation request.

      Returns:
      Amazon Web Services account ID of the owner of the delegation request.

    • description

      public final String description()

      Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

      Returns:
      Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

    • requestMessage

      public final String requestMessage()

      A custom message that is added to the delegation request by the partner.

      This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

      Returns:
      A custom message that is added to the delegation request by the partner.

      This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

    • permissions

      public final DelegationPermission permissions()
      Returns the value of the Permissions property for this object.
      Returns:
      The value of the Permissions property for this object.

    • permissionPolicy

      public final String permissionPolicy()

      JSON content of the associated permission policy of this delegation request.

      Returns:
      JSON content of the associated permission policy of this delegation request.

    • hasRolePermissionRestrictionArns

      public final boolean hasRolePermissionRestrictionArns()
      For responses, this returns true if the service returned a value for the RolePermissionRestrictionArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • rolePermissionRestrictionArns

      public final List<String> rolePermissionRestrictionArns()

      If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRolePermissionRestrictionArns() method.

      Returns:
      If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

    • ownerId

      public final String ownerId()

      ARN of the owner of this delegation request.

      Returns:
      ARN of the owner of this delegation request.

    • approverId

      public final String approverId()
      Returns the value of the ApproverId property for this object.
      Returns:
      The value of the ApproverId property for this object.

    • state

      public final StateType state()

      The state of this delegation request.

      See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

      If the service returns an enum value that is not available in the current SDK version, state will return StateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of this delegation request.

      See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of this delegation request.

      See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

      If the service returns an enum value that is not available in the current SDK version, state will return StateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of this delegation request.

      See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

      See Also:

    • requestorId

      public final String requestorId()

      Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

      Returns:
      Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

    • requestorName

      public final String requestorName()

      A friendly name of the requestor.

      Returns:
      A friendly name of the requestor.

    • createDate

      public final Instant createDate()

      Creation date (timestamp) of this delegation request.

      Returns:
      Creation date (timestamp) of this delegation request.

    • sessionDuration

      public final Integer sessionDuration()

      The life-time of the requested session credential.

      Returns:
      The life-time of the requested session credential.

    • redirectUrl

      public final String redirectUrl()

      A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

      Returns:
      A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

    • notes

      public final String notes()

      Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

      Returns:
      Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

    • rejectionReason

      public final String rejectionReason()

      Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

      Returns:
      Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

    • onlySendByOwner

      public final Boolean onlySendByOwner()

      A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

      Returns:
      A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

    • updatedTime

      public final Instant updatedTime()

      Last updated timestamp of the request.

      Returns:
      Last updated timestamp of the request.

    • toBuilder

      public DelegationRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DelegationRequest.Builder,DelegationRequest>
      Returns:
      a builder for type T

    • builder

      public static DelegationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DelegationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.