com.amazonaws.services.securitytoken

クラス AWSSecurityTokenServiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClient

すべての実装されたインタフェース:

AWSSecurityTokenService

直系の既知のサブクラス:

AWSSecurityTokenServiceAsyncClient

public class AWSSecurityTokenServiceClient
extends AmazonWebServiceClient
implements AWSSecurityTokenService

Client for accessing AWSSecurityTokenService. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Security Token Service

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.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
protected java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>>	exceptionUnmarshallers List of exception unmarshallers for all AWSSecurityTokenService exceptions.

クラスから継承されたフィールド com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, requestHandlers, timeOffset, version

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AWSSecurityTokenServiceClient() Constructs a new client to invoke service methods on AWSSecurityTokenService.
AWSSecurityTokenServiceClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials.
AWSSecurityTokenServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials and client configuration options.
AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider.
AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider and client configuration options.
AWSSecurityTokenServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSecurityTokenService.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.
protected java.lang.String	getServiceAbbreviation() リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します
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, java.lang.String serviceName, java.lang.String regionId) Overrides the default endpoint for this client ("https://sts.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceClient

addRequestHandler, convertToHttpRequest, createExecutionContext, getTimeOffset, getVersion, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, setVersion, shutdown, withTimeOffset

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド com.amazonaws.services.securitytoken.AWSSecurityTokenService

setEndpoint, setRegion, shutdown

フィールドの詳細

exceptionUnmarshallers

protected final java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers

List of exception unmarshallers for all AWSSecurityTokenService exceptions.

コンストラクタの詳細

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient()

Constructs a new client to invoke service methods on AWSSecurityTokenService. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

関連項目:

DefaultAWSCredentialsProvider

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSecurityTokenService. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

clientConfiguration - The client configuration options controlling how this client connects to AWSSecurityTokenService (ex: proxy settings, retry counts, etc.).

関連項目:

DefaultAWSCredentialsProvider

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSSecurityTokenService (ex: proxy settings, retry counts, etc.).

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSSecurityTokenServiceClient

public AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

パラメータ:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSSecurityTokenService (ex: proxy settings, retry counts, etc.).

メソッドの詳細

getSessionToken

public 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 .

定義:

getSessionToken インタフェース内 AWSSecurityTokenService

パラメータ:

getSessionTokenRequest - Container for the necessary parameters to execute the GetSessionToken service method on AWSSecurityTokenService.

戻り値:

The response from the GetSessionToken service method, as returned by 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.

decodeAuthorizationMessage

public 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:

• 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 Using IAM .
• 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.

定義:

decodeAuthorizationMessage インタフェース内 AWSSecurityTokenService

パラメータ:

decodeAuthorizationMessageRequest - Container for the necessary parameters to execute the DecodeAuthorizationMessage service method on AWSSecurityTokenService.

戻り値:

The response from the DecodeAuthorizationMessage service method, as returned by AWSSecurityTokenService.

例外:

InvalidAuthorizationMessageException

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.

assumeRoleWithWebIdentity

public 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 .

定義:

assumeRoleWithWebIdentity インタフェース内 AWSSecurityTokenService

パラメータ:

assumeRoleWithWebIdentityRequest - Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method on AWSSecurityTokenService.

戻り値:

The response from the AssumeRoleWithWebIdentity service method, as returned by AWSSecurityTokenService.

例外:

PackedPolicyTooLargeException

IDPRejectedClaimException

MalformedPolicyDocumentException

InvalidIdentityTokenException

ExpiredTokenException

IDPCommunicationErrorException

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.

getFederationToken

public 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 .

定義:

getFederationToken インタフェース内 AWSSecurityTokenService

パラメータ:

getFederationTokenRequest - Container for the necessary parameters to execute the GetFederationToken service method on AWSSecurityTokenService.

戻り値:

The response from the GetFederationToken service method, as returned by AWSSecurityTokenService.

例外:

PackedPolicyTooLargeException

MalformedPolicyDocumentException

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.

assumeRole

public 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 .

定義:

assumeRole インタフェース内 AWSSecurityTokenService

パラメータ:

assumeRoleRequest - Container for the necessary parameters to execute the AssumeRole service method on AWSSecurityTokenService.

戻り値:

The response from the AssumeRole service method, as returned by AWSSecurityTokenService.

例外:

PackedPolicyTooLargeException

MalformedPolicyDocumentException

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.

getSessionToken

public 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 .

定義:

getSessionToken インタフェース内 AWSSecurityTokenService

戻り値:

The response from the GetSessionToken service method, as returned by 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.

setEndpoint

public void setEndpoint(java.lang.String endpoint,
               java.lang.String serviceName,
               java.lang.String regionId)
                 throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://sts.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints 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.

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

パラメータ:

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.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

例外:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

getServiceAbbreviation

protected java.lang.String getServiceAbbreviation()

クラスからコピーされた説明: AmazonWebServiceClient

リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します

オーバーライド:

getServiceAbbreviation クラス内 AmazonWebServiceClient

関連項目:

ServiceAbbreviations

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

定義:

getCachedResponseMetadata インタフェース内 AWSSecurityTokenService

パラメータ:

request - The originally executed request

戻り値:

The response metadata for the specified request, or null if none is available.