/AWS1/CL_STSASSUMEROLEWSAMLRSP

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

CONSTRUCTOR

IMPORTING

Optional arguments:

io_credentials TYPE REF TO /AWS1/CL_STSCREDENTIALS /AWS1/CL_STSCREDENTIALS

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.

io_assumedroleuser TYPE REF TO /AWS1/CL_STSASSUMEDROLEUSER /AWS1/CL_STSASSUMEDROLEUSER

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

iv_packedpolicysize TYPE /AWS1/STSNONNEGINTEGERTYPE /AWS1/STSNONNEGINTEGERTYPE

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.

iv_subject TYPE /AWS1/STSSUBJECT /AWS1/STSSUBJECT

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

iv_subjecttype TYPE /AWS1/STSSUBJECTTYPE /AWS1/STSSUBJECTTYPE

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.

iv_issuer TYPE /AWS1/STSISSUER /AWS1/STSISSUER

The value of the Issuer element of the SAML assertion.

iv_audience TYPE /AWS1/STSAUDIENCE /AWS1/STSAUDIENCE

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

iv_namequalifier TYPE /AWS1/STSNAMEQUALIFIER /AWS1/STSNAMEQUALIFIER

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" ) )

iv_sourceidentity TYPE /AWS1/STSSOURCEIDENTITYTYPE /AWS1/STSSOURCEIDENTITYTYPE

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: =,.@-

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_CREDENTIALS()	Getter for CREDENTIALS

AssumedRoleUser

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

Accessible with the following methods

Method	Description
GET_ASSUMEDROLEUSER()	Getter for ASSUMEDROLEUSER

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.

Accessible with the following methods

Method	Description
GET_PACKEDPOLICYSIZE()	Getter for PACKEDPOLICYSIZE, with configurable default
ASK_PACKEDPOLICYSIZE()	Getter for PACKEDPOLICYSIZE w/ exceptions if field has no va
HAS_PACKEDPOLICYSIZE()	Determine if PACKEDPOLICYSIZE has a value

Subject

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

Accessible with the following methods

Method	Description
GET_SUBJECT()	Getter for SUBJECT, with configurable default
ASK_SUBJECT()	Getter for SUBJECT w/ exceptions if field has no value
HAS_SUBJECT()	Determine if SUBJECT has a value

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.

Accessible with the following methods

Method	Description
GET_SUBJECTTYPE()	Getter for SUBJECTTYPE, with configurable default
ASK_SUBJECTTYPE()	Getter for SUBJECTTYPE w/ exceptions if field has no value
HAS_SUBJECTTYPE()	Determine if SUBJECTTYPE has a value

Issuer

The value of the Issuer element of the SAML assertion.

Accessible with the following methods

Method	Description
GET_ISSUER()	Getter for ISSUER, with configurable default
ASK_ISSUER()	Getter for ISSUER w/ exceptions if field has no value
HAS_ISSUER()	Determine if ISSUER has a value

Audience

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

Accessible with the following methods

Method	Description
GET_AUDIENCE()	Getter for AUDIENCE, with configurable default
ASK_AUDIENCE()	Getter for AUDIENCE w/ exceptions if field has no value
HAS_AUDIENCE()	Determine if AUDIENCE has a value

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" ) )

Accessible with the following methods

Method	Description
GET_NAMEQUALIFIER()	Getter for NAMEQUALIFIER, with configurable default
ASK_NAMEQUALIFIER()	Getter for NAMEQUALIFIER w/ exceptions if field has no value
HAS_NAMEQUALIFIER()	Determine if NAMEQUALIFIER has a value

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: =,.@-

Accessible with the following methods

Method	Description
GET_SOURCEIDENTITY()	Getter for SOURCEIDENTITY, with configurable default
ASK_SOURCEIDENTITY()	Getter for SOURCEIDENTITY w/ exceptions if field has no valu
HAS_SOURCEIDENTITY()	Determine if SOURCEIDENTITY has a value