class Aws::STS::Types::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.

@!attribute [rw] credentials

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

<note markdown="1"> 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.

 </note>
@return [Types::Credentials]

@!attribute [rw] assumed_role_user

The identifiers for the temporary security credentials that the
operation returns.
@return [Types::AssumedRoleUser]

@!attribute [rw] packed_policy_size

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.
@return [Integer]

@!attribute [rw] subject

The value of the `NameID` element in the `Subject` element of the
SAML assertion.
@return [String]

@!attribute [rw] subject_type

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.
@return [String]

@!attribute [rw] issuer

The value of the `Issuer` element of the SAML assertion.
@return [String]

@!attribute [rw] audience

The value of the `Recipient` attribute of the
`SubjectConfirmationData` element of the SAML assertion.
@return [String]

@!attribute [rw] name_qualifier

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" ) )`
@return [String]

@!attribute [rw] source_identity

The value in the `SourceIdentity` attribute in the SAML assertion.
The source identity value persists across [chained role][1]
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][2] 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][3] 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: =,.@-

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#iam-term-role-chaining
[2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#id_roles_terms-and-concepts
[3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAMLResponse AWS API Documentation