Class AssumeRoleWithSamlResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sts.model.StsResponse
software.amazon.awssdk.services.sts.model.AssumeRoleWithSamlResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
@Generated("software.amazon.awssdk:codegen") public final class AssumeRoleWithSamlResponse extends StsResponse implements ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>

Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

  • Method Details

    • credentials

      public final Credentials credentials()

      The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

      The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

      Returns:
      The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

      The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    • assumedRoleUser

      public final AssumedRoleUser assumedRoleUser()

      The identifiers for the temporary security credentials that the operation returns.

      Returns:
      The identifiers for the temporary security credentials that the operation returns.

    • packedPolicySize

      public final Integer packedPolicySize()

      A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

      Returns:
      A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

    • subject

      public final String subject()

      The value of the NameID element in the Subject element of the SAML assertion.

      Returns:
      The value of the NameID element in the Subject element of the SAML assertion.

    • subjectType

      public final String subjectType()

      The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

      If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

      Returns:
      The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

      If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

    • issuer

      public final String issuer()

      The value of the Issuer element of the SAML assertion.

      Returns:
      The value of the Issuer element of the SAML assertion.

    • audience

      public final String audience()

      The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

      Returns:
      The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

    • nameQualifier

      public final String nameQualifier()

      A hash value based on the concatenation of the following:

      • The Issuer response value.

      • The Amazon Web Services account ID.

      • The friendly name (the last part of the ARN) of the SAML provider in IAM.

      The combination of NameQualifier and Subject can be used to uniquely identify a user.

      The following pseudocode shows how the hash value is calculated:

      BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

      Returns:
      A hash value based on the concatenation of the following:

      • The Issuer response value.

      • The Amazon Web Services account ID.

      • The friendly name (the last part of the ARN) of the SAML provider in IAM.

      The combination of NameQualifier and Subject can be used to uniquely identify a user.

      The following pseudocode shows how the hash value is calculated:

      BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

    • sourceIdentity

      public final String sourceIdentity()

      The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions.

      You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

      The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

      Returns:
      The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions.

      You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

      The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    • toBuilder

      public AssumeRoleWithSamlResponse.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<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static AssumeRoleWithSamlResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.