public interface AWSSecurityTokenServiceAsync extends AWSSecurityTokenService
The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Using Temporary Security Credentials .
NOTE: As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference . For general information about the Query API, go to Making Query Requests in Using IAM . For information about using security tokens with other AWS products, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials .
If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/ .
Endpoints
For information about STS endpoints, see Regions and Endpoints in the AWS General Reference .
Recording API requests
STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide .
| Modifier and Type | Method and Description |
|---|---|
Future<AssumeRoleResult> |
assumeRoleAsync(AssumeRoleRequest assumeRoleRequest)
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) that you can
use to access AWS resources that you might not normally have access
to.
|
Future<AssumeRoleResult> |
assumeRoleAsync(AssumeRoleRequest assumeRoleRequest,
AsyncHandler<AssumeRoleRequest,AssumeRoleResult> asyncHandler)
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) that you can
use to access AWS resources that you might not normally have access
to.
|
Future<AssumeRoleWithSAMLResult> |
assumeRoleWithSAMLAsync(AssumeRoleWithSAMLRequest assumeRoleWithSAMLRequest)
Returns a set of temporary security credentials for users who have
been authenticated via a SAML authentication response.
|
Future<AssumeRoleWithSAMLResult> |
assumeRoleWithSAMLAsync(AssumeRoleWithSAMLRequest assumeRoleWithSAMLRequest,
AsyncHandler<AssumeRoleWithSAMLRequest,AssumeRoleWithSAMLResult> asyncHandler)
Returns a set of temporary security credentials for users who have
been authenticated via a SAML authentication response.
|
Future<AssumeRoleWithWebIdentityResult> |
assumeRoleWithWebIdentityAsync(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest)
Returns a set of temporary security credentials for users who have
been authenticated in a mobile or web application with a web identity
provider, such as Login with Amazon, Facebook, or Google.
|
Future<AssumeRoleWithWebIdentityResult> |
assumeRoleWithWebIdentityAsync(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest,
AsyncHandler<AssumeRoleWithWebIdentityRequest,AssumeRoleWithWebIdentityResult> asyncHandler)
Returns a set of temporary security credentials for users who have
been authenticated in a mobile or web application with a web identity
provider, such as Login with Amazon, Facebook, or Google.
|
Future<DecodeAuthorizationMessageResult> |
decodeAuthorizationMessageAsync(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest)
Decodes additional information about the authorization status of a
request from an encoded message returned in response to an AWS
request.
|
Future<DecodeAuthorizationMessageResult> |
decodeAuthorizationMessageAsync(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest,
AsyncHandler<DecodeAuthorizationMessageRequest,DecodeAuthorizationMessageResult> asyncHandler)
Decodes additional information about the authorization status of a
request from an encoded message returned in response to an AWS
request.
|
Future<GetFederationTokenResult> |
getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest)
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) for a
federated user.
|
Future<GetFederationTokenResult> |
getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest,
AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) for a
federated user.
|
Future<GetSessionTokenResult> |
getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest)
Returns a set of temporary credentials for an AWS account or IAM
user.
|
Future<GetSessionTokenResult> |
getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest,
AsyncHandler<GetSessionTokenRequest,GetSessionTokenResult> asyncHandler)
Returns a set of temporary credentials for an AWS account or IAM
user.
|
assumeRole, assumeRoleWithSAML, assumeRoleWithWebIdentity, decodeAuthorizationMessage, getCachedResponseMetadata, getFederationToken, getSessionToken, getSessionToken, setEndpoint, setRegion, shutdownFuture<GetSessionTokenResult> getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest) throws AmazonServiceException, AmazonClientException
Returns a set of temporary credentials for an AWS 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 AWS APIs like Amazon EC2
StopInstances . MFA-enabled IAM users would need to call
GetSessionToken and submit an MFA code that is associated
with their MFA device. Using the temporary security credentials that
are returned from the call, IAM users can then make programmatic calls
to APIs that require MFA authentication.
The GetSessionToken action must be called by using the
long-term AWS security credentials of the AWS account or an IAM user.
Credentials that are created by IAM users are valid for the duration
that you specify, between 900 seconds (15 minutes) and 129600 seconds
(36 hours); credentials that are created by using account credentials
have a maximum duration of 3600 seconds (1 hour).
NOTE: We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
The permissions associated with the temporary security credentials
returned by GetSessionToken are based on the permissions
associated with account or IAM user whose credentials are used to call
the action. If GetSessionToken is called using root
account credentials, the temporary credentials have root account
permissions. Similarly, if GetSessionToken is called
using the credentials of an IAM user, the temporary credentials have
the same permissions as the IAM user.
For more information about using GetSessionToken to
create temporary credentials, go to
Creating Temporary Credentials to Enable Access for IAM Users
in Using Temporary Security Credentials .
getSessionTokenRequest - Container for the necessary parameters
to execute the GetSessionToken operation on AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<GetSessionTokenResult> getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest, AsyncHandler<GetSessionTokenRequest,GetSessionTokenResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a set of temporary credentials for an AWS 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 AWS APIs like Amazon EC2
StopInstances . MFA-enabled IAM users would need to call
GetSessionToken and submit an MFA code that is associated
with their MFA device. Using the temporary security credentials that
are returned from the call, IAM users can then make programmatic calls
to APIs that require MFA authentication.
The GetSessionToken action must be called by using the
long-term AWS security credentials of the AWS account or an IAM user.
Credentials that are created by IAM users are valid for the duration
that you specify, between 900 seconds (15 minutes) and 129600 seconds
(36 hours); credentials that are created by using account credentials
have a maximum duration of 3600 seconds (1 hour).
NOTE: We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
The permissions associated with the temporary security credentials
returned by GetSessionToken are based on the permissions
associated with account or IAM user whose credentials are used to call
the action. If GetSessionToken is called using root
account credentials, the temporary credentials have root account
permissions. Similarly, if GetSessionToken is called
using the credentials of an IAM user, the temporary credentials have
the same permissions as the IAM user.
For more information about using GetSessionToken to
create temporary credentials, go to
Creating Temporary Credentials to Enable Access for IAM Users
in Using Temporary Security Credentials .
getSessionTokenRequest - Container for the necessary parameters
to execute the GetSessionToken operation on AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<DecodeAuthorizationMessageResult> decodeAuthorizationMessageAsync(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest) throws AmazonServiceException, AmazonClientException
Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an action that he
or she has requested, the request returns a
Client.UnauthorizedOperation response (an HTTP 403
response). Some AWS actions additionally return an encoded message
that can provide details about this authorization failure.
NOTE: Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization
status can constitute privileged information that the user who
requested the action should not see. To decode an authorization status
message, a user must be granted permissions via an IAM policy to
request the DecodeAuthorizationMessage (
sts:DecodeAuthorizationMessage ) action.
The decoded message includes the following type of information:
decodeAuthorizationMessageRequest - Container for the necessary
parameters to execute the DecodeAuthorizationMessage operation on
AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<DecodeAuthorizationMessageResult> decodeAuthorizationMessageAsync(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest, AsyncHandler<DecodeAuthorizationMessageRequest,DecodeAuthorizationMessageResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an action that he
or she has requested, the request returns a
Client.UnauthorizedOperation response (an HTTP 403
response). Some AWS actions additionally return an encoded message
that can provide details about this authorization failure.
NOTE: Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization
status can constitute privileged information that the user who
requested the action should not see. To decode an authorization status
message, a user must be granted permissions via an IAM policy to
request the DecodeAuthorizationMessage (
sts:DecodeAuthorizationMessage ) action.
The decoded message includes the following type of information:
decodeAuthorizationMessageRequest - Container for the necessary
parameters to execute the DecodeAuthorizationMessage operation on
AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleWithSAMLResult> assumeRoleWithSAMLAsync(AssumeRoleWithSAMLRequest assumeRoleWithSAMLRequest) throws AmazonServiceException, AmazonClientException
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 AWS access without user-specific credentials or configuration.
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 NotOnOrAfter value, whichever
is shorter.
NOTE:The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.
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 AssumeRoleWithSAML in Using Temporary Security Credentials .
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:
assumeRoleWithSAMLRequest - Container for the necessary
parameters to execute the AssumeRoleWithSAML operation on
AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleWithSAMLResult> assumeRoleWithSAMLAsync(AssumeRoleWithSAMLRequest assumeRoleWithSAMLRequest, AsyncHandler<AssumeRoleWithSAMLRequest,AssumeRoleWithSAMLResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 AWS access without user-specific credentials or configuration.
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 NotOnOrAfter value, whichever
is shorter.
NOTE:The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.
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 AssumeRoleWithSAML in Using Temporary Security Credentials .
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:
assumeRoleWithSAMLRequest - Container for the necessary
parameters to execute the AssumeRoleWithSAML operation on
AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleWithWebIdentityResult> assumeRoleWithWebIdentityAsync(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google.
Calling AssumeRoleWithWebIdentity does not require the
use of AWS security credentials. Therefore, you can distribute an
application (for example, on mobile devices) that requests temporary
security credentials without including long-term AWS credentials in
the application, and without deploying server-based proxy services
that use long-term AWS credentials. Instead, the identity of the
caller is validated by using a token from the web identity provider.
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 AWS
service APIs. The credentials are valid for the duration that you
specified when calling AssumeRoleWithWebIdentity , which
can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By
default, the temporary security credentials are valid for 1 hour.
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 AssumeRoleWithWebIdentity in Using Temporary Security Credentials .
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 , see the following resources:
assumeRoleWithWebIdentityRequest - Container for the necessary
parameters to execute the AssumeRoleWithWebIdentity operation on
AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleWithWebIdentityResult> assumeRoleWithWebIdentityAsync(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest, AsyncHandler<AssumeRoleWithWebIdentityRequest,AssumeRoleWithWebIdentityResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google.
Calling AssumeRoleWithWebIdentity does not require the
use of AWS security credentials. Therefore, you can distribute an
application (for example, on mobile devices) that requests temporary
security credentials without including long-term AWS credentials in
the application, and without deploying server-based proxy services
that use long-term AWS credentials. Instead, the identity of the
caller is validated by using a token from the web identity provider.
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 AWS
service APIs. The credentials are valid for the duration that you
specified when calling AssumeRoleWithWebIdentity , which
can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By
default, the temporary security credentials are valid for 1 hour.
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 AssumeRoleWithWebIdentity in Using Temporary Security Credentials .
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 , see the following resources:
assumeRoleWithWebIdentityRequest - Container for the necessary
parameters to execute the AssumeRoleWithWebIdentity operation on
AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) for a
federated user. A typical use is in a proxy application that gets
temporary security credentials on behalf of distributed applications
inside a corporate network. Because you must call the
GetFederationToken action using the long-term security
credentials of an IAM user, this call is appropriate in contexts where
those credentials can be safely stored, usually in a server-based
application.
Note: Do not use this call in mobile applications or
client-based web applications that directly get temporary security
credentials. For those types of applications, use
AssumeRoleWithWebIdentity .
The GetFederationToken action must be called by using
the long-term AWS security credentials of an IAM user. You can also
call GetFederationToken using the security credentials of
an AWS account (root), but this is not recommended. Instead, we
recommend that you create an IAM user for the purpose of the proxy
application and then attach a policy to the IAM user that limits
federated users to only the actions and resources they need access to.
For more information, see
IAM Best Practices
in Using IAM .
The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour)
Permissions
The permissions for the temporary security credentials returned by
GetFederationToken are determined by a combination of the
following:
GetFederationToken .
The passed policy is attached to the temporary security credentials
that result from the GetFederationToken API call--that
is, to the federated user . When the federated user makes an
AWS request, AWS evaluates the policy attached to the federated user
in combination with the policy or policies attached to the IAM user
whose credentials were used to call GetFederationToken .
AWS allows the federated user's request only when both the federated
user and the IAM user are explicitly allowed to perform the
requested action. The passed policy cannot grant more permissions than
those that are defined in the IAM user policy.
A typical use case is that the permissions of the IAM user whose
credentials are used to call GetFederationToken are
designed to allow access to all the actions and resources that any
federated user will need. Then, for individual users, you pass a
policy to the operation that scopes down the permissions to a level
that's appropriate to that individual user, using a policy that allows
only a subset of permissions that are granted to the IAM user.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see
Permissions for GetFederationToken in Using Temporary Security Credentials . For information about using GetFederationToken to create temporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users
in Using Temporary Security Credentials .
getFederationTokenRequest - Container for the necessary
parameters to execute the GetFederationToken operation on
AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest, AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) for a
federated user. A typical use is in a proxy application that gets
temporary security credentials on behalf of distributed applications
inside a corporate network. Because you must call the
GetFederationToken action using the long-term security
credentials of an IAM user, this call is appropriate in contexts where
those credentials can be safely stored, usually in a server-based
application.
Note: Do not use this call in mobile applications or
client-based web applications that directly get temporary security
credentials. For those types of applications, use
AssumeRoleWithWebIdentity .
The GetFederationToken action must be called by using
the long-term AWS security credentials of an IAM user. You can also
call GetFederationToken using the security credentials of
an AWS account (root), but this is not recommended. Instead, we
recommend that you create an IAM user for the purpose of the proxy
application and then attach a policy to the IAM user that limits
federated users to only the actions and resources they need access to.
For more information, see
IAM Best Practices
in Using IAM .
The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour)
Permissions
The permissions for the temporary security credentials returned by
GetFederationToken are determined by a combination of the
following:
GetFederationToken .
The passed policy is attached to the temporary security credentials
that result from the GetFederationToken API call--that
is, to the federated user . When the federated user makes an
AWS request, AWS evaluates the policy attached to the federated user
in combination with the policy or policies attached to the IAM user
whose credentials were used to call GetFederationToken .
AWS allows the federated user's request only when both the federated
user and the IAM user are explicitly allowed to perform the
requested action. The passed policy cannot grant more permissions than
those that are defined in the IAM user policy.
A typical use case is that the permissions of the IAM user whose
credentials are used to call GetFederationToken are
designed to allow access to all the actions and resources that any
federated user will need. Then, for individual users, you pass a
policy to the operation that scopes down the permissions to a level
that's appropriate to that individual user, using a policy that allows
only a subset of permissions that are granted to the IAM user.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see
Permissions for GetFederationToken in Using Temporary Security Credentials . For information about using GetFederationToken to create temporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users
in Using Temporary Security Credentials .
getFederationTokenRequest - Container for the necessary
parameters to execute the GetFederationToken operation on
AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleResult> assumeRoleAsync(AssumeRoleRequest assumeRoleRequest) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) that you can
use to access AWS resources that you might not normally have access
to. Typically, you use AssumeRole for cross-account
access or federation.
Important: You cannot call AssumeRole by using
AWS account credentials; access will be denied. You must use IAM user
credentials or temporary security credentials to call
AssumeRole .
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see Roles in Using IAM .
For federation, you can, for example, grant single sign-on access to
the AWS Management Console. If you already have an identity and
authentication system in your corporate network, you don't have to
recreate user identities in AWS in order to grant those user
identities access to AWS. Instead, after a user has been
authenticated, you call AssumeRole (and specify the role
with the appropriate permissions) to get temporary security
credentials for that user. With those temporary security credentials,
you construct a sign-in URL that users can use to access the console.
For more information, see
Scenarios for Granting Temporary Access
in Using Temporary Security Credentials .
The temporary security credentials are valid for the duration that
you specified when calling AssumeRole , which can be from
900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1
hour.
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 in Using Temporary Security Credentials .
To assume a role, your AWS account must be trusted by the role. The
trust relationship is defined in the role's trust policy when the role
is created. You must also have a policy that allows you to call
sts:AssumeRole .
Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA)
information when you call AssumeRole . This is useful for
cross-account scenarios in which you want to make sure that the user
who is assuming the role has been authenticated using an AWS 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": {"Null": {"aws:MultiFactorAuthAge": false}}
For more information, see Configuring MFA-Protected API Access in the Using IAM 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 devices produces.
assumeRoleRequest - Container for the necessary parameters to
execute the AssumeRole operation on AWSSecurityTokenService.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Future<AssumeRoleResult> assumeRoleAsync(AssumeRoleRequest assumeRoleRequest, AsyncHandler<AssumeRoleRequest,AssumeRoleResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a set of temporary security credentials (consisting of an
access key ID, a secret access key, and a security token) that you can
use to access AWS resources that you might not normally have access
to. Typically, you use AssumeRole for cross-account
access or federation.
Important: You cannot call AssumeRole by using
AWS account credentials; access will be denied. You must use IAM user
credentials or temporary security credentials to call
AssumeRole .
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see Roles in Using IAM .
For federation, you can, for example, grant single sign-on access to
the AWS Management Console. If you already have an identity and
authentication system in your corporate network, you don't have to
recreate user identities in AWS in order to grant those user
identities access to AWS. Instead, after a user has been
authenticated, you call AssumeRole (and specify the role
with the appropriate permissions) to get temporary security
credentials for that user. With those temporary security credentials,
you construct a sign-in URL that users can use to access the console.
For more information, see
Scenarios for Granting Temporary Access
in Using Temporary Security Credentials .
The temporary security credentials are valid for the duration that
you specified when calling AssumeRole , which can be from
900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1
hour.
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 in Using Temporary Security Credentials .
To assume a role, your AWS account must be trusted by the role. The
trust relationship is defined in the role's trust policy when the role
is created. You must also have a policy that allows you to call
sts:AssumeRole .
Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA)
information when you call AssumeRole . This is useful for
cross-account scenarios in which you want to make sure that the user
who is assuming the role has been authenticated using an AWS 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": {"Null": {"aws:MultiFactorAuthAge": false}}
For more information, see Configuring MFA-Protected API Access in the Using IAM 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 devices produces.
assumeRoleRequest - Container for the necessary parameters to
execute the AssumeRole operation on AWSSecurityTokenService.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AWSSecurityTokenService indicating
either a problem with the data in the request, or a server side issue.Copyright © 2014. All rights reserved.