com.amazonaws.services.securitytoken
Class AWSSecurityTokenServiceClient

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

All Implemented Interfaces:

AWSSecurityTokenService

Direct Known Subclasses:

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

This is the AWS Security Token Service API Reference . 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 as well as links to related content in Using IAM .

For more detailed information about using this service, go to Granting Temporary Access to Your AWS Resources in Using IAM .

For specific information about setting up signatures and authorization through the API, go to Making Query Requests in Using IAM .

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

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.

Method Summary

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) The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request.
GetSessionTokenResult	getSessionToken() The GetSessionToken action returns a set of temporary credentials for an AWS account or IAM user.
GetSessionTokenResult	getSessionToken(GetSessionTokenRequest getSessionTokenRequest) The GetSessionToken action returns a set of temporary credentials for an AWS account or IAM user.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, shutdown

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

setEndpoint, shutdown

Constructor Detail

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.

Parameters:

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.

Parameters:

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.

Parameters:

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.

Parameters:

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

Method Detail

getSessionToken

public GetSessionTokenResult getSessionToken(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.

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:

getSessionToken in interface AWSSecurityTokenService

Parameters:

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

Returns:

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.

getFederationToken

public GetFederationTokenResult getFederationToken(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. The credentials are valid for the specified duration, between one and 36 hours.

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:

getFederationToken in interface AWSSecurityTokenService

Parameters:

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

Returns:

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

Throws:

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

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.

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:

getSessionToken in interface AWSSecurityTokenService

Returns:

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.

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.

Specified by:

getCachedResponseMetadata in interface AWSSecurityTokenService

Parameters:

request - The originally executed request

Returns:

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