AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 AWS services. The credentials are valid for
the duration that you specified when calling AssumeRoleWithSAML, which
can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication
response's SessionNotOnOrAfter value, whichever is shorter.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the Using IAM.
Before your application can call AssumeRoleWithSAML, you must configure
your SAML identity provider (IdP) to issue the claims required by AWS. Additionally,
you must use AWS Identity and Access Management (IAM) to create a SAML provider entity
in your AWS account that represents your identity provider, and create an IAM role
that specifies this SAML provider in its trust policy.
Calling AssumeRoleWithSAML does not require the use of AWS 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.
For more information, see the following resources:
Namespace: Amazon.SecurityToken
Assembly: AWSSDK.dll
Version: (assembly version)
public abstract AssumeRoleWithSAMLResponse AssumeRoleWithSAML( AssumeRoleWithSAMLRequest request )
Container for the necessary parameters to execute the AssumeRoleWithSAML service method.
| Exception | Condition |
|---|---|
| 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. |
| 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 AWS. Get a new identity token from the identity provider and then retry the request. |
| 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 policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. |
| RegionDisabledException | STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see Activating and Deactivating AWS STS in an AWS Region in the Using IAM. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5