com.amazonaws.services.securitytoken
Class AWSSecurityTokenServiceAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClient
          com.amazonaws.services.securitytoken.AWSSecurityTokenServiceAsyncClient

All Implemented Interfaces:

AWSSecurityTokenService, AWSSecurityTokenServiceAsync

public class AWSSecurityTokenServiceAsyncClient
extends AWSSecurityTokenServiceClient
implements AWSSecurityTokenServiceAsync

Asynchronous client for accessing AWSSecurityTokenService. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. 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.

Constructor Summary

AWSSecurityTokenServiceAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService.

AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials.

AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials, executor service, and client configuration options.

AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials and executor service.

AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider.

AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider, executor service, and client configuration options.

AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider and executor service.

AWSSecurityTokenServiceAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService.

Method Summary

ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetFederationTokenResult>	getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest) The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request.
Future<GetFederationTokenResult>	getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest, AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler) The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request.
Future<GetSessionTokenResult>	getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest) The GetSessionToken action returns a set of temporary credentials for an AWS account or IAM user.
Future<GetSessionTokenResult>	getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest, AsyncHandler<GetSessionTokenRequest,GetSessionTokenResult> asyncHandler) The GetSessionToken action returns a set of temporary credentials for an AWS account or IAM user.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClient

getCachedResponseMetadata, getFederationToken, getSessionToken, getSessionToken, setEndpoint

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.securitytoken.AWSSecurityTokenService

getCachedResponseMetadata, getFederationToken, getSessionToken, getSessionToken, setEndpoint

Constructor Detail

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient()

Constructs a new asynchronous 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.

See Also:

DefaultAWSCredentialsProvider

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous 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.

Parameters:

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

See Also:

DefaultAWSCredentialsProvider

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration,
                                          ExecutorService executorService)

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

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSSecurityTokenService using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AWSSecurityTokenServiceAsyncClient

public AWSSecurityTokenServiceAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          ExecutorService executorService)

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

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() prior to calling this method.

Specified by:

shutdown in interface AWSSecurityTokenService

Overrides:

shutdown in class AmazonWebServiceClient

getSessionTokenAsync

public Future<GetSessionTokenResult> getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

The GetSessionToken action 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. These credentials are valid for the specified duration only. The session duration for IAM users can be between one and 36 hours, with a default of 12 hours. The session duration for AWS account owners is restricted to one hour. Providing the AWS Multi-Factor Authentication (MFA) device serial number and the token code is optional.

For more information about using GetSessionToken to create temporary credentials, go to Creating Temporary Credentials to Enable Access for IAM Users in Using IAM .

Specified by:

getSessionTokenAsync in interface AWSSecurityTokenServiceAsync

Parameters:

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

Returns:

A Java Future object containing the response from the GetSessionToken service method, as returned by AWSSecurityTokenService.

Throws:

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.

getSessionTokenAsync

public Future<GetSessionTokenResult> getSessionTokenAsync(GetSessionTokenRequest getSessionTokenRequest,
                                                          AsyncHandler<GetSessionTokenRequest,GetSessionTokenResult> asyncHandler)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

The GetSessionToken action 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. These credentials are valid for the specified duration only. The session duration for IAM users can be between one and 36 hours, with a default of 12 hours. The session duration for AWS account owners is restricted to one hour. Providing the AWS Multi-Factor Authentication (MFA) device serial number and the token code is optional.

For more information about using GetSessionToken to create temporary credentials, go to Creating Temporary Credentials to Enable Access for IAM Users in Using IAM .

Specified by:

getSessionTokenAsync in interface AWSSecurityTokenServiceAsync

Parameters:

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.

Returns:

A Java Future object containing the response from the GetSessionToken service method, as returned by AWSSecurityTokenService.

Throws:

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.

getFederationTokenAsync

public Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request. The credentials consist of an Access Key ID, a Secret Access Key, and a security token. Credentials created by IAM users are valid for the specified duration, between one and 36 hours; credentials created using account credentials last one hour.

The federated user who holds these credentials has any permissions allowed by the intersection of the specified policy and any resource or user policies that apply to the caller of the GetFederationToken API, and any resource policies that apply to the federated user's Amazon Resource Name (ARN). For more information about how token permissions work, see Controlling Permissions in Temporary Credentials in Using AWS Identity and Access Management . For information about using GetFederationToken to create temporary credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using AWS Identity and Access Management .

Specified by:

getFederationTokenAsync in interface AWSSecurityTokenServiceAsync

Parameters:

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

Returns:

A Java Future object containing the response from the GetFederationToken service method, as returned by AWSSecurityTokenService.

Throws:

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.

getFederationTokenAsync

public Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest,
                                                                AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request. The credentials consist of an Access Key ID, a Secret Access Key, and a security token. Credentials created by IAM users are valid for the specified duration, between one and 36 hours; credentials created using account credentials last one hour.

The federated user who holds these credentials has any permissions allowed by the intersection of the specified policy and any resource or user policies that apply to the caller of the GetFederationToken API, and any resource policies that apply to the federated user's Amazon Resource Name (ARN). For more information about how token permissions work, see Controlling Permissions in Temporary Credentials in Using AWS Identity and Access Management . For information about using GetFederationToken to create temporary credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using AWS Identity and Access Management .

Specified by:

getFederationTokenAsync in interface AWSSecurityTokenServiceAsync

Parameters:

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.

Returns:

A Java Future object containing the response from the GetFederationToken service method, as returned by AWSSecurityTokenService.

Throws:

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.