Class AssumeRoleWithSamlResponse
- All Implemented Interfaces:
SdkPojo
,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.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.final String
audience()
The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.builder()
final Credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
issuer()
The value of theIssuer
element of the SAML assertion.final String
A hash value based on the concatenation of the following:final Integer
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.static Class
<? extends AssumeRoleWithSamlResponse.Builder> final String
The value in theSourceIdentity
attribute in the SAML assertion.final String
subject()
The value of theNameID
element in theSubject
element of the SAML assertion.final String
The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.sts.model.StsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The identifiers for the temporary security credentials that the operation returns.
- Returns:
- The identifiers for the temporary security credentials that the operation returns.
-
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
The value of the
NameID
element in theSubject
element of the SAML assertion.- Returns:
- The value of the
NameID
element in theSubject
element of the SAML assertion.
-
subjectType
The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. 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 theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.
-
issuer
The value of the
Issuer
element of the SAML assertion.- Returns:
- The value of the
Issuer
element of the SAML assertion.
-
audience
The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.- Returns:
- The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.
-
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
andSubject
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
andSubject
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
The value in the
SourceIdentity
attribute in the SAML assertion.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 callingAssumeRoleWithSAML
. 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.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 callingAssumeRoleWithSAML
. 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
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 interfaceToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,
AssumeRoleWithSamlResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-