com.amazonaws.services.securitytoken
Interface AWSSecurityTokenServiceAsync

All Superinterfaces:

AWSSecurityTokenService

All Known Implementing Classes:

AWSSecurityTokenServiceAsyncClient

public interface AWSSecurityTokenServiceAsync
extends AWSSecurityTokenService

Interface for accessing AWSSecurityTokenService asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. 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.

Method Summary

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.

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

getCachedResponseMetadata, getFederationToken, getSessionToken, getSessionToken, setEndpoint, shutdown

Method Detail

getSessionTokenAsync

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 .

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

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 .

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

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 .

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

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 .

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.