public interface AWSSecurityTokenService
The AWS Security Token Service 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 AWS Security Token Service API.
For more detailed information about using this service, go to Using Temporary Security Credentials .
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/ .
We will refer to Amazon Identity and Access Management using the abbreviated form IAM. All copyrights and legal protections still apply.
| 修飾子とタイプ | メソッドと説明 |
|---|---|
AssumeRoleResult |
assumeRole(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.
|
AssumeRoleWithWebIdentityResult |
assumeRoleWithWebIdentity(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.
|
DecodeAuthorizationMessageResult |
decodeAuthorizationMessage(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest)
Decodes additional information about the authorization status of a
request from an encoded message returned in response to an AWS
request.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for
debugging issues where a service isn't acting as expected.
|
GetFederationTokenResult |
getFederationToken(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.
|
GetSessionTokenResult |
getSessionToken()
Returns a set of temporary credentials for an AWS account or IAM
user.
|
GetSessionTokenResult |
getSessionToken(GetSessionTokenRequest getSessionTokenRequest)
Returns a set of temporary credentials for an AWS account or IAM
user.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client ("https://sts.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void setEndpoint(java.lang.String endpoint)
throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex: "sts.amazonaws.com") or a full
URL, including the protocol (ex: "https://sts.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "sts.amazonaws.com") or a full URL,
including the protocol (ex: "https://sts.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.java.lang.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)GetSessionTokenResult getSessionToken(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 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).
The permissions that are granted to the federated user are the
intersection of the policy that is passed with the
GetSessionToken request and policies that are associated
with of the entity making the GetSessionToken call.
For more information about using GetSessionToken to
create temporary credentials, go to
Creating Temporary Credentials to Enable Access for IAM Users in
Using IAM .
getSessionTokenRequest - Container for the necessary parameters
to execute the GetSessionToken service method 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.DecodeAuthorizationMessageResult decodeAuthorizationMessage(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 service method on
AWSSecurityTokenService.InvalidAuthorizationMessageExceptionAmazonClientException - 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.AssumeRoleWithWebIdentityResult assumeRoleWithWebIdentity(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.
AssumeRoleWithWebIdentity is an API call that 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 or by deploying server-based proxy
services that use long-term AWS credentials. For more information, see
Creating a Mobile Application with Third-Party Sign-In in AWS
Security Token Service .
The temporary security credentials 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.
The temporary security credentials that are returned from the
AssumeRoleWithWebIdentity response have the permissions
that are associated with the access policy of the role being assumed.
You can further restrict the permissions of the temporary security
credentials by passing a policy in the request. The resulting
permissions are an intersection of the role's access policy and the
policy that you passed. These policies and any applicable
resource-based policies are evaluated when calls to AWS service APIs
are made using the 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, see
Creating Temporary Security Credentials for Mobile Apps Using
Third-Party Identity Providers .
assumeRoleWithWebIdentityRequest - Container for the necessary
parameters to execute the AssumeRoleWithWebIdentity service method on
AWSSecurityTokenService.PackedPolicyTooLargeExceptionIDPRejectedClaimExceptionMalformedPolicyDocumentExceptionInvalidIdentityTokenExceptionExpiredTokenExceptionIDPCommunicationErrorExceptionAmazonClientException - 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.GetFederationTokenResult getFederationToken(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 is
getting 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 the AWS account or an IAM
user. Credentials that are created by IAM users are valid for the
specified duration, 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).
The permissions that are granted to the federated user are the
intersection of the policy that is passed with the
GetFederationToken request and policies that are
associated with of the entity making the
GetFederationToken call.
For more information about how permissions work, see
Controlling Permissions in Temporary Credentials 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 service method on
AWSSecurityTokenService.PackedPolicyTooLargeExceptionMalformedPolicyDocumentExceptionAmazonClientException - 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.AssumeRoleResult assumeRole(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.
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 AWS Security Token
Service .
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.
The temporary security credentials that are returned from the
AssumeRoleWithWebIdentity response have the permissions
that are associated with the access policy of the role being assumed
and any policies that are associated with the AWS resource being
accessed. You can further restrict the permissions of the temporary
security credentials by passing a policy in the request. The resulting
permissions are an intersection of the role's access policy and the
policy that you passed. These policies and any applicable
resource-based policies are evaluated when calls to AWS service APIs
are made using the 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 IAM
role is created. You must also have a policy that allows you to call
sts:AssumeRole .
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 .
assumeRoleRequest - Container for the necessary parameters to
execute the AssumeRole service method on AWSSecurityTokenService.PackedPolicyTooLargeExceptionMalformedPolicyDocumentExceptionAmazonClientException - 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.GetSessionTokenResult getSessionToken() 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 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).
The permissions that are granted to the federated user are the
intersection of the policy that is passed with the
GetSessionToken request and policies that are associated
with of the entity making the GetSessionToken call.
For more information about using GetSessionToken to
create temporary credentials, go to
Creating Temporary Credentials to Enable Access for IAM Users in
Using IAM .
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.