AssumeRole

$result = $client->assumeRole([/* ... */]);
$promise = $client->assumeRoleAsync([/* ... */]);

Returns a set of temporary security credentials that you can use to access Amazon Web Services resources. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.

Permissions

The temporary security credentials created by AssumeRole can be used to make API calls to any Amazon Web Services service with the following exception: You cannot call the Amazon Web Services STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

When you create a role, you create two policies: a role trust policy that specifies who can assume the role, and a permissions policy that specifies what can be done with the role. You specify the trusted principal that is allowed to assume the role in the role trust policy.

To assume a role from a different account, your Amazon Web Services account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.

A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account.

To allow a user to assume a role in the same account, you can do either of the following:

• Attach a policy to the user that allows the user to call AssumeRole (as long as the role's trust policy trusts the account).

• Add the user as a principal directly in the role's trust policy.

You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.

Tags

(Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.

An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.

You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.

Using MFA with AssumeRole

(Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.

"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}

For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.

To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.

Parameter Syntax

$result = $client->assumeRole([
    'DurationSeconds' => <integer>,
    'ExternalId' => '<string>',
    'Policy' => '<string>',
    'PolicyArns' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'ProvidedContexts' => [
        [
            'ContextAssertion' => '<string>',
            'ProviderArn' => '<string>',
        ],
        // ...
    ],
    'RoleArn' => '<string>', // REQUIRED
    'RoleSessionName' => '<string>', // REQUIRED
    'SerialNumber' => '<string>',
    'SourceIdentity' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TokenCode' => '<string>',
    'TransitiveTagKeys' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AssumedRoleUser' => [
        'Arn' => '<string>',
        'AssumedRoleId' => '<string>',
    ],
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'PackedPolicySize' => <integer>,
    'SourceIdentity' => '<string>',
]

Result Details

Errors

MalformedPolicyDocumentException:

The request was rejected because the policy document was malformed. The error message describes the specific error.

PackedPolicyTooLargeException:

The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in STS in the IAM User Guide.

You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User Guide.

RegionDisabledException:

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.

ExpiredTokenException:

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

Examples

Example 1: To assume a role

$result = $client->assumeRole([
    'ExternalId' => '123ABC',
    'Policy' => '{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:ListAllMyBuckets","Resource":"*"}]}',
    'RoleArn' => 'arn:aws:iam::123456789012:role/demo',
    'RoleSessionName' => 'testAssumeRoleSession',
    'Tags' => [
        [
            'Key' => 'Project',
            'Value' => 'Unicorn',
        ],
        [
            'Key' => 'Team',
            'Value' => 'Automation',
        ],
        [
            'Key' => 'Cost-Center',
            'Value' => '12345',
        ],
    ],
    'TransitiveTagKeys' => [
        'Project',
        'Cost-Center',
    ],
]);

Result syntax:

[
    'AssumedRoleUser' => [
        'Arn' => 'arn:aws:sts::123456789012:assumed-role/demo/Bob',
        'AssumedRoleId' => 'ARO123EXAMPLE123:Bob',
    ],
    'Credentials' => [
        'AccessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'Expiration' => ,
        'SecretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY',
        'SessionToken' => 'AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==',
    ],
    'PackedPolicySize' => 8,
]

AssumeRoleWithSAML

$result = $client->assumeRoleWithSAML([/* ... */]);
$promise = $client->assumeRoleWithSAMLAsync([/* ... */]);

Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based Amazon Web Services access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.

The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services services.

Session Duration

By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

Permissions

The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

Tags

(Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key.

An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.

You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.

SAML Configuration

Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.

For more information, see the following resources:

• About SAML 2.0-based Federation in the IAM User Guide.

• Creating SAML Identity Providers in the IAM User Guide.

• Configuring a Relying Party and Claims in the IAM User Guide.

• Creating a Role for SAML 2.0 Federation in the IAM User Guide.

Parameter Syntax

$result = $client->assumeRoleWithSAML([
    'DurationSeconds' => <integer>,
    'Policy' => '<string>',
    'PolicyArns' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'PrincipalArn' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SAMLAssertion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AssumedRoleUser' => [
        'Arn' => '<string>',
        'AssumedRoleId' => '<string>',
    ],
    'Audience' => '<string>',
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'Issuer' => '<string>',
    'NameQualifier' => '<string>',
    'PackedPolicySize' => <integer>,
    'SourceIdentity' => '<string>',
    'Subject' => '<string>',
    'SubjectType' => '<string>',
]

Result Details

Errors

MalformedPolicyDocumentException:

The request was rejected because the policy document was malformed. The error message describes the specific error.

PackedPolicyTooLargeException:

The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in STS in the IAM User Guide.

You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User Guide.

IDPRejectedClaimException:

The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.

If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.

InvalidIdentityTokenException:

The web identity token that was passed could not be validated by Amazon Web Services. Get a new identity token from the identity provider and then retry the request.

ExpiredTokenException:

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

RegionDisabledException:

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.

Examples

Example 1: To assume a role using a SAML assertion

$result = $client->assumeRoleWithSAML([
    'DurationSeconds' => 3600,
    'PrincipalArn' => 'arn:aws:iam::123456789012:saml-provider/SAML-test',
    'RoleArn' => 'arn:aws:iam::123456789012:role/TestSaml',
    'SAMLAssertion' => 'VERYLONGENCODEDASSERTIONEXAMPLExzYW1sOkF1ZGllbmNlPmJsYW5rPC9zYW1sOkF1ZGllbmNlPjwvc2FtbDpBdWRpZW5jZVJlc3RyaWN0aW9uPjwvc2FtbDpDb25kaXRpb25zPjxzYW1sOlN1YmplY3Q+PHNhbWw6TmFtZUlEIEZvcm1hdD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm5hbWVpZC1mb3JtYXQ6dHJhbnNpZW50Ij5TYW1sRXhhbXBsZTwvc2FtbDpOYW1lSUQ+PHNhbWw6U3ViamVjdENvbmZpcm1hdGlvbiBNZXRob2Q9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpjbTpiZWFyZXIiPjxzYW1sOlN1YmplY3RDb25maXJtYXRpb25EYXRhIE5vdE9uT3JBZnRlcj0iMjAxOS0xMS0wMVQyMDoyNTowNS4xNDVaIiBSZWNpcGllbnQ9Imh0dHBzOi8vc2lnbmluLmF3cy5hbWF6b24uY29tL3NhbWwiLz48L3NhbWw6U3ViamVjdENvbmZpcm1hdGlvbj48L3NhbWw6U3ViamVjdD48c2FtbDpBdXRoblN0YXRlbWVudCBBdXRoPD94bWwgdmpSZXNwb25zZT4=',
]);

Result syntax:

[
    'AssumedRoleUser' => [
        'Arn' => 'arn:aws:sts::123456789012:assumed-role/TestSaml',
        'AssumedRoleId' => 'ARO456EXAMPLE789:TestSaml',
    ],
    'Audience' => 'https://signin.aws.amazon.com/saml',
    'Credentials' => [
        'AccessKeyId' => 'ASIAV3ZUEFP6EXAMPLE',
        'Expiration' => ,
        'SecretAccessKey' => '8P+SQvWIuLnKhh8d++jpw0nNmQRBZvNEXAMPLEKEY',
        'SessionToken' => 'IQoJb3JpZ2luX2VjEOz////////////////////wEXAMPLEtMSJHMEUCIDoKK3JH9uGQE1z0sINr5M4jk+Na8KHDcCYRVjJCZEvOAiEA3OvJGtw1EcViOleS2vhs8VdCKFJQWPQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==',
    ],
    'Issuer' => 'https://integ.example.com/idp/shibboleth',
    'NameQualifier' => 'SbdGOnUkh1i4+EXAMPLExL/jEvs=',
    'PackedPolicySize' => 6,
    'Subject' => 'SamlExample',
    'SubjectType' => 'transient',
]

AssumeRoleWithWebIdentity

$result = $client->assumeRoleWithWebIdentity([/* ... */]);
$promise = $client->assumeRoleWithWebIdentityAsync([/* ... */]);

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities.

Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.

The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations.

Session Duration

By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

Permissions

The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Tags

(Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key.

An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.

You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.

Identities

Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

• Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.

• Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services.

• Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials.

• Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3.

Parameter Syntax

$result = $client->assumeRoleWithWebIdentity([
    'DurationSeconds' => <integer>,
    'Policy' => '<string>',
    'PolicyArns' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'ProviderId' => '<string>',
    'RoleArn' => '<string>', // REQUIRED
    'RoleSessionName' => '<string>', // REQUIRED
    'WebIdentityToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AssumedRoleUser' => [
        'Arn' => '<string>',
        'AssumedRoleId' => '<string>',
    ],
    'Audience' => '<string>',
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'PackedPolicySize' => <integer>,
    'Provider' => '<string>',
    'SourceIdentity' => '<string>',
    'SubjectFromWebIdentityToken' => '<string>',
]

Result Details

Errors

MalformedPolicyDocumentException:

The request was rejected because the policy document was malformed. The error message describes the specific error.

PackedPolicyTooLargeException:

The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in STS in the IAM User Guide.

You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User Guide.

IDPRejectedClaimException:

The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.

If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.

IDPCommunicationErrorException:

The request could not be fulfilled because the identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the identity provider might be down or not responding.

InvalidIdentityTokenException:

The web identity token that was passed could not be validated by Amazon Web Services. Get a new identity token from the identity provider and then retry the request.

ExpiredTokenException:

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

RegionDisabledException:

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.

Examples

Example 1: To assume a role as an OpenID Connect-federated user

$result = $client->assumeRoleWithWebIdentity([
    'DurationSeconds' => 3600,
    'Policy' => '{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:ListAllMyBuckets","Resource":"*"}]}',
    'ProviderId' => 'www.amazon.com',
    'RoleArn' => 'arn:aws:iam::123456789012:role/FederatedWebIdentityRole',
    'RoleSessionName' => 'app1',
    'WebIdentityToken' => 'Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ',
]);

Result syntax:

[
    'AssumedRoleUser' => [
        'Arn' => 'arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1',
        'AssumedRoleId' => 'AROACLKWSDQRAOEXAMPLE:app1',
    ],
    'Audience' => 'client.5498841531868486423.1548@apps.example.com',
    'Credentials' => [
        'AccessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'Expiration' => ,
        'SecretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY',
        'SessionToken' => 'AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE',
    ],
    'PackedPolicySize' => 123,
    'Provider' => 'www.amazon.com',
    'SubjectFromWebIdentityToken' => 'amzn1.account.AF6RHO7KZU5XRVQJGXK6HEXAMPLE',
]

DecodeAuthorizationMessage

$result = $client->decodeAuthorizationMessage([/* ... */]);
$promise = $client->decodeAuthorizationMessageAsync([/* ... */]);

Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request.

For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can provide details about this authorization failure.

The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.

The decoded message includes the following type of information:

• Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.

• The principal who made the request.

• The requested action.

• The requested resource.

• The values of condition keys in the context of the user's request.

Parameter Syntax

$result = $client->decodeAuthorizationMessage([
    'EncodedMessage' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DecodedMessage' => '<string>',
]

Result Details

Errors

InvalidAuthorizationMessageException:

The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.

Examples

Example 1: To decode information about an authorization status of a request

$result = $client->decodeAuthorizationMessage([
    'EncodedMessage' => '',
]);

Result syntax:

[
    'DecodedMessage' => '{"allowed": "false","explicitDeny": "false","matchedStatements": "","failures": "","context": {"principal": {"id": "AIDACKCEVSQ6C2EXAMPLE","name": "Bob","arn": "arn:aws:iam::123456789012:user/Bob"},"action": "ec2:StopInstances","resource": "arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd","conditions": [{"item": {"key": "ec2:Tenancy","values": ["default"]},{"item": {"key": "ec2:ResourceTag/elasticbeanstalk:environment-name","values": ["Default-Environment"]}},(Additional items ...)]}}',
]

GetAccessKeyInfo

$result = $client->getAccessKeyInfo([/* ... */]);
$promise = $client->getAccessKeyInfoAsync([/* ... */]);

Returns the account identifier for the specified access key ID.

Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys, see Managing Access Keys for IAM Users in the IAM User Guide.

When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account to which the keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with ASIA are temporary credentials that are created using STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the STS events in your CloudTrail logs in the IAM User Guide.

This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist.

Parameter Syntax

$result = $client->getAccessKeyInfo([
    'AccessKeyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Account' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetCallerIdentity

$result = $client->getCallerIdentity([/* ... */]);
$promise = $client->getCallerIdentityAsync([/* ... */]);

Returns details about the IAM user or role whose credentials are used to call the operation.

Parameter Syntax

$result = $client->getCallerIdentity([
]);

Parameter Details

Result Syntax

[
    'Account' => '<string>',
    'Arn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: To get details about a calling IAM user

This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.

$result = $client->getCallerIdentity([
]);

Result syntax:

[
    'Account' => '123456789012',
    'Arn' => 'arn:aws:iam::123456789012:user/Alice',
    'UserId' => 'AKIAI44QH8DHBEXAMPLE',
]

Example 2: To get details about a calling user federated with AssumeRole

This example shows a request and response made with temporary credentials created by AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name.

$result = $client->getCallerIdentity([
]);

Result syntax:

[
    'Account' => '123456789012',
    'Arn' => 'arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name',
    'UserId' => 'AKIAI44QH8DHBEXAMPLE:my-role-session-name',
]

Example 3: To get details about a calling user federated with GetFederationToken

This example shows a request and response made with temporary credentials created by using GetFederationToken. The Name parameter is set to my-federated-user-name.

$result = $client->getCallerIdentity([
]);

Result syntax:

[
    'Account' => '123456789012',
    'Arn' => 'arn:aws:sts::123456789012:federated-user/my-federated-user-name',
    'UserId' => '123456789012:my-federated-user-name',
]

GetFederationToken

$result = $client->getFederationToken([/* ... */]);
$promise = $client->getFederationTokenAsync([/* ... */]);

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network.

You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safeguarded, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.

Although it is possible to call GetFederationToken using the security credentials of an Amazon Web Services account root user rather than an IAM user that you create for the purpose of a proxy application, we do not recommend it. For more information, see Safeguard your root user credentials and don't use them for everyday tasks in the IAM User Guide.

Session duration

The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the root user credentials have a maximum duration of 3,600 seconds (1 hour).

Permissions

You can use the temporary credentials created by GetFederationToken in any Amazon Web Services service with the following exceptions:

• You cannot call any IAM operations using the CLI or the Amazon Web Services API. This limitation does not apply to console sessions.

• You cannot call any STS operations except GetCallerIdentity.

You can use temporary credentials for single sign-on (SSO) to the console.

You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters.

Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

You can use the credentials to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the session policies.

Tags

(Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.

An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.

Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the user that you are federating has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the user tag.

Parameter Syntax

$result = $client->getFederationToken([
    'DurationSeconds' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Policy' => '<string>',
    'PolicyArns' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'FederatedUser' => [
        'Arn' => '<string>',
        'FederatedUserId' => '<string>',
    ],
    'PackedPolicySize' => <integer>,
]

Result Details

Errors

MalformedPolicyDocumentException:

The request was rejected because the policy document was malformed. The error message describes the specific error.

PackedPolicyTooLargeException:

The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in STS in the IAM User Guide.

You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User Guide.

RegionDisabledException:

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.

Examples

Example 1: To get temporary credentials for a role by using GetFederationToken

$result = $client->getFederationToken([
    'DurationSeconds' => 3600,
    'Name' => 'testFedUserSession',
    'Policy' => '{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:ListAllMyBuckets","Resource":"*"}]}',
    'Tags' => [
        [
            'Key' => 'Project',
            'Value' => 'Pegasus',
        ],
        [
            'Key' => 'Cost-Center',
            'Value' => '98765',
        ],
    ],
]);

Result syntax:

[
    'Credentials' => [
        'AccessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'Expiration' => ,
        'SecretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY',
        'SessionToken' => 'AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==',
    ],
    'FederatedUser' => [
        'Arn' => 'arn:aws:sts::123456789012:federated-user/Bob',
        'FederatedUserId' => '123456789012:Bob',
    ],
    'PackedPolicySize' => 8,
]

GetSessionToken

$result = $client->getSessionToken([/* ... */]);
$promise = $client->getSessionTokenAsync([/* ... */]);

Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances.

MFA-enabled IAM users must call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that the call returns, IAM users can then make programmatic calls to API operations that require MFA authentication. An incorrect MFA code causes the API to return an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.

Session Duration

The GetSessionToken operation must be called by using the long-term Amazon Web Services security credentials of an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.

Permissions

The temporary security credentials created by GetSessionToken can be used to make API calls to any Amazon Web Services service with the following exceptions:

• You cannot call any IAM API operations unless MFA authentication information is included in the request.

• You cannot call any STS API except AssumeRole or GetCallerIdentity.

The credentials that GetSessionToken returns are based on permissions associated with the IAM user whose credentials were used to call the operation. The temporary credentials have the same permissions as the IAM user.

For more information about using GetSessionToken to create temporary credentials, see Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.

Parameter Syntax

$result = $client->getSessionToken([
    'DurationSeconds' => <integer>,
    'SerialNumber' => '<string>',
    'TokenCode' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
]

Result Details

Errors

RegionDisabledException:

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.

Examples

Example 1: To get temporary credentials for an IAM user or an AWS account

$result = $client->getSessionToken([
    'DurationSeconds' => 3600,
    'SerialNumber' => 'YourMFASerialNumber',
    'TokenCode' => '123456',
]);

Result syntax:

[
    'Credentials' => [
        'AccessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'Expiration' => ,
        'SecretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY',
        'SessionToken' => 'AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE',
    ],
]