com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sts Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.securitytoken;
import org.w3c.dom.*;
import java.net.*;
import java.util.*;
import javax.annotation.Generated;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AdvancedConfig;
import com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClientBuilder;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.securitytoken.model.*;
import com.amazonaws.services.securitytoken.model.transform.*;
/**
* Client for accessing AWS STS. All service calls made using this client are blocking, and will not return until the
* service call completes.
*
* AWS Security Token Service
*
* AWS Security Token Service (STS) 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 STS API. For more information about using this service, see Temporary Security Credentials.
*
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AWSSecurityTokenServiceClient extends AmazonWebServiceClient implements AWSSecurityTokenService {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AWSSecurityTokenService.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "sts";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final AdvancedConfig advancedConfig;
/**
* List of exception unmarshallers for all modeled exceptions
*/
protected final List> exceptionUnmarshallers = new ArrayList>();
// STS regions that originally mapped to the global endpoint but now have region-specific endpoints
private static final Set LEGACY_ENABLED_REGIONS;
static {
Set legacyEnabledRegions = new HashSet();
legacyEnabledRegions.add("ap-northeast-1");
legacyEnabledRegions.add("ap-south-1");
legacyEnabledRegions.add("ap-southeast-1");
legacyEnabledRegions.add("ap-southeast-2");
legacyEnabledRegions.add("aws-global");
legacyEnabledRegions.add("ca-central-1");
legacyEnabledRegions.add("eu-central-1");
legacyEnabledRegions.add("eu-north-1");
legacyEnabledRegions.add("eu-west-1");
legacyEnabledRegions.add("eu-west-2");
legacyEnabledRegions.add("eu-west-3");
legacyEnabledRegions.add("sa-east-1");
legacyEnabledRegions.add("us-east-1");
legacyEnabledRegions.add("us-east-2");
legacyEnabledRegions.add("us-west-1");
legacyEnabledRegions.add("us-west-2");
LEGACY_ENABLED_REGIONS = Collections.unmodifiableSet(legacyEnabledRegions);
}
private static RegionalEndpointsOptionResolver REGIONAL_ENDPOINTS_OPTION_RESOLVER = new RegionalEndpointsOptionResolver();
/**
* Constructs a new client to invoke service methods on AWS STS. 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 DefaultAWSCredentialsProviderChain
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#defaultClient()}
*/
@Deprecated
public AWSSecurityTokenServiceClient() {
this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on AWS STS. 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.
*
* @param clientConfiguration
* The client configuration options controlling how this client connects to AWS STS (ex: proxy settings,
* retry counts, etc.).
*
* @see DefaultAWSCredentialsProviderChain
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AWSSecurityTokenServiceClient(ClientConfiguration clientConfiguration) {
this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on AWS STS 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.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withCredentials(AWSCredentialsProvider)} for example:
* {@code AWSSecurityTokenServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();}
*/
@Deprecated
public AWSSecurityTokenServiceClient(AWSCredentials awsCredentials) {
this(awsCredentials, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on AWS STS 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.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to AWS STS (ex: proxy settings,
* retry counts, etc.).
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AWSSecurityTokenServiceClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AWSSecurityTokenServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
this.advancedConfig = AdvancedConfig.EMPTY;
init();
}
/**
* Constructs a new client to invoke service methods on AWS STS 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.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withCredentials(AWSCredentialsProvider)}
*/
@Deprecated
public AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on AWS STS 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.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to AWS STS (ex: proxy settings,
* retry counts, etc.).
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AWSSecurityTokenServiceClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
this(awsCredentialsProvider, clientConfiguration, null);
}
/**
* Constructs a new client to invoke service methods on AWS STS using the specified AWS account credentials
* provider, client configuration options, and request metric collector.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to AWS STS (ex: proxy settings,
* retry counts, etc.).
* @param requestMetricCollector
* optional request metric collector
* @deprecated use {@link AWSSecurityTokenServiceClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AWSSecurityTokenServiceClientBuilder#withClientConfiguration(ClientConfiguration)} and
* {@link AWSSecurityTokenServiceClientBuilder#withMetricsCollector(RequestMetricCollector)}
*/
@Deprecated
public AWSSecurityTokenServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(clientConfiguration, requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
this.advancedConfig = AdvancedConfig.EMPTY;
init();
}
public static AWSSecurityTokenServiceClientBuilder builder() {
return AWSSecurityTokenServiceClientBuilder.standard();
}
/**
* Constructs a new client to invoke service methods on AWS STS using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSSecurityTokenServiceClient(AwsSyncClientParams clientParams) {
this(clientParams, false);
}
/**
* Constructs a new client to invoke service methods on AWS STS using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSSecurityTokenServiceClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
this.advancedConfig = clientParams.getAdvancedConfig();
init();
}
private void init() {
exceptionUnmarshallers.add(new InvalidAuthorizationMessageExceptionUnmarshaller());
exceptionUnmarshallers.add(new ExpiredTokenExceptionUnmarshaller());
exceptionUnmarshallers.add(new PackedPolicyTooLargeExceptionUnmarshaller());
exceptionUnmarshallers.add(new RegionDisabledExceptionUnmarshaller());
exceptionUnmarshallers.add(new MalformedPolicyDocumentExceptionUnmarshaller());
exceptionUnmarshallers.add(new IDPCommunicationErrorExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidIdentityTokenExceptionUnmarshaller());
exceptionUnmarshallers.add(new IDPRejectedClaimExceptionUnmarshaller());
exceptionUnmarshallers.add(new StandardErrorUnmarshaller(com.amazonaws.services.securitytoken.model.AWSSecurityTokenServiceException.class));
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
this.setEndpoint("sts.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/securitytoken/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/securitytoken/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
*
* Returns a set of temporary security credentials that you can use to access AWS resources that you might not
* normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a
* security token. Typically, you use AssumeRole within your account or for cross-account access. For a
* comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary
* Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.
*
*
*
* You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an
* IAM user or an IAM role to call AssumeRole.
*
*
*
* 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. Then use temporary security credentials to access all the other
* accounts by assuming roles in those accounts. For more information about roles, see IAM Roles in the IAM User Guide.
*
*
* Session Duration
*
*
* By default, the temporary security credentials created by AssumeRole last for one hour. However, you
* can use the optional DurationSeconds parameter to specify the duration of your session. You can
* provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This
* setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View
* the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration
* limit applies when you use the AssumeRole* API operations or the assume-role* CLI
* commands. However the limit does not apply when you use those operations to create a console URL. For more
* information, see Using IAM Roles
* in the IAM User Guide.
*
*
* Permissions
*
*
* The temporary security credentials created by AssumeRole can be used to make API calls to any AWS
* service with the following exception: You cannot call the AWS STS GetFederationToken or
* GetSessionToken API operations.
*
*
* (Optional) You can pass inline or managed session
* policies to this operation. You can pass a single JSON policy document to use as an inline session policy.
* You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use
* for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation
* returns new temporary credentials. The resulting session's permissions are the intersection of the role's
* identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS
* API calls to access resources in the account that owns the role. You cannot use session policies to grant more
* permissions than those allowed by the identity-based policy of the role that is being assumed. For more
* information, see Session
* Policies in the IAM User Guide.
*
*
* To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship
* is defined in the role's trust policy when the role is created. That trust policy states which accounts are
* allowed to delegate that access to users in the account.
*
*
* A user who wants to access a role in a different account must also have permissions that are delegated from the
* user account administrator. The administrator must attach a policy that allows the user to call
* AssumeRole for the ARN of the role in the other account. If the user is in the same account as the
* role, then you can do either of the following:
*
*
* -
*
* Attach a policy to the user (identical to the previous user in a different account).
*
*
* -
*
* Add the user as a principal directly in the role's trust policy.
*
*
*
*
* In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not
* need explicit permission to assume the role. For more information about trust policies and resource-based
* policies, see IAM Policies in
* the IAM User Guide.
*
*
* Tags
*
*
* (Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more
* information about session tags, see Passing Session Tags in STS in
* the IAM User Guide.
*
*
* An administrator must grant you the permissions necessary to pass session tags. The administrator can also create
* granular permissions to allow you to pass only specific session tags. For more information, see Tutorial:
* Using Tags for Attribute-Based Access Control in the IAM User Guide.
*
*
* You can set the session tags as transitive. Transitive tags persist during role chaining. For more information,
* see
* Chaining Roles with Session Tags in the IAM User Guide.
*
*
* Using MFA with AssumeRole
*
*
* (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole.
* This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated
* with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that
* tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the
* role is denied. The condition in a trust policy that tests for MFA authentication might look like the following
* example.
*
*
* "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}
*
*
* For more information, see Configuring MFA-Protected API
* Access in the IAM User Guide guide.
*
*
* To use MFA with AssumeRole, you pass values for the SerialNumber and
* TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual
* MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.
*
*
* @param assumeRoleRequest
* @return Result of the AssumeRole operation returned by the service.
* @throws MalformedPolicyDocumentException
* The request was rejected because the policy document was malformed. The error message describes the
* specific error.
* @throws PackedPolicyTooLargeException
* The request was rejected because the total packed size of the session policies and session tags combined
* was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session
* tags into a packed binary format that has a separate limit. The error message indicates by percentage how
* close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in
* STS in the IAM User Guide.
*
* You could receive this error even though you meet other defined session policy and session tag limits.
* For more information, see IAM and
* STS Entity Character Limits in the IAM User Guide.
* @throws RegionDisabledException
* STS is not activated in the requested region for the account that is being asked to generate credentials.
* The account administrator must use the IAM console to activate STS in that region. For more information,
* see
* Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
* @throws ExpiredTokenException
* The web identity token that was passed is expired or is not valid. Get a new identity token from the
* identity provider and then retry the request.
* @sample AWSSecurityTokenService.AssumeRole
* @see AWS API
* Documentation
*/
@Override
public AssumeRoleResult assumeRole(AssumeRoleRequest request) {
request = beforeClientExecution(request);
return executeAssumeRole(request);
}
@SdkInternalApi
final AssumeRoleResult executeAssumeRole(AssumeRoleRequest assumeRoleRequest) {
ExecutionContext executionContext = createExecutionContext(assumeRoleRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AssumeRoleRequestMarshaller().marshall(super.beforeMarshalling(assumeRoleRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "AssumeRole");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(new AssumeRoleResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication
* response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based
* AWS access without user-specific credentials or configuration. For a comparison of
* AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary
* Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.
*
*
* The temporary security credentials returned by this operation 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 services.
*
*
* Session Duration
*
*
* By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour.
* However, you can use the optional DurationSeconds parameter to specify the duration of your session.
* Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication
* response's SessionNotOnOrAfter value, whichever is shorter. You can provide a
* DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for
* the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your
* role, see View
* the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration
* limit applies when you use the AssumeRole* API operations or the assume-role* CLI
* commands. However the limit does not apply when you use those operations to create a console URL. For more
* information, see Using IAM Roles
* in the IAM User Guide.
*
*
* Permissions
*
*
* The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to
* any AWS service with the following exception: you cannot call the STS GetFederationToken or
* GetSessionToken API operations.
*
*
* (Optional) You can pass inline or managed session
* policies to this operation. You can pass a single JSON policy document to use as an inline session policy.
* You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use
* for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation
* returns new temporary credentials. The resulting session's permissions are the intersection of the role's
* identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS
* API calls to access resources in the account that owns the role. You cannot use session policies to grant more
* permissions than those allowed by the identity-based policy of the role that is being assumed. For more
* information, see Session
* Policies in the IAM User Guide.
*
*
* Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the
* caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your
* identity provider.
*
*
*
* Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes
* the value in the NameID element of the SAML assertion. We recommend that you use a
* NameIDType that is not associated with any personally identifiable information (PII). For example,
* you could instead use the persistent identifier (
* urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
*
*
*
* Tags
*
*
* (Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session
* tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in
* the IAM User Guide.
*
*
* You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters and the values
* can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
*
*
*
* An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a
* separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The
* PackedPolicySize response element indicates by percentage how close the policies and tags for your
* request are to the upper size limit.
*
*
*
* You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags
* override the role's tags with the same key.
*
*
* An administrator must grant you the permissions necessary to pass session tags. The administrator can also create
* granular permissions to allow you to pass only specific session tags. For more information, see Tutorial:
* Using Tags for Attribute-Based Access Control in the IAM User Guide.
*
*
* You can set the session tags as transitive. Transitive tags persist during role chaining. For more information,
* see
* Chaining Roles with Session Tags in the IAM User Guide.
*
*
* SAML Configuration
*
*
* Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider
* (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to
* create a SAML provider entity in your AWS account that represents your identity provider. You must also create an
* IAM role that specifies this SAML provider in its trust policy.
*
*
* For more information, see the following resources:
*
*
* -
*
* About SAML 2.0-based
* Federation in the IAM User Guide.
*
*
* -
*
* Creating SAML
* Identity Providers in the IAM User Guide.
*
*
* -
*
*
* Configuring a Relying Party and Claims in the IAM User Guide.
*
*
* -
*
* Creating a Role for
* SAML 2.0 Federation in the IAM User Guide.
*
*
*
*
* @param assumeRoleWithSAMLRequest
* @return Result of the AssumeRoleWithSAML operation returned by the service.
* @throws MalformedPolicyDocumentException
* The request was rejected because the policy document was malformed. The error message describes the
* specific error.
* @throws PackedPolicyTooLargeException
* The request was rejected because the total packed size of the session policies and session tags combined
* was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session
* tags into a packed binary format that has a separate limit. The error message indicates by percentage how
* close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in
* STS in the IAM User Guide.
*
* You could receive this error even though you meet other defined session policy and session tag limits.
* For more information, see IAM and
* STS Entity Character Limits in the IAM User Guide.
* @throws IDPRejectedClaimException
* The identity provider (IdP) reported that authentication failed. This might be because the claim is
* invalid.
*
*
* If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that
* the claim has expired or has been explicitly revoked.
* @throws InvalidIdentityTokenException
* The web identity token that was passed could not be validated by AWS. Get a new identity token from the
* identity provider and then retry the request.
* @throws ExpiredTokenException
* The web identity token that was passed is expired or is not valid. Get a new identity token from the
* identity provider and then retry the request.
* @throws RegionDisabledException
* STS is not activated in the requested region for the account that is being asked to generate credentials.
* The account administrator must use the IAM console to activate STS in that region. For more information,
* see
* Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
* @sample AWSSecurityTokenService.AssumeRoleWithSAML
* @see AWS API
* Documentation
*/
@Override
public AssumeRoleWithSAMLResult assumeRoleWithSAML(AssumeRoleWithSAMLRequest request) {
request = beforeClientExecution(request);
return executeAssumeRoleWithSAML(request);
}
@SdkInternalApi
final AssumeRoleWithSAMLResult executeAssumeRoleWithSAML(AssumeRoleWithSAMLRequest assumeRoleWithSAMLRequest) {
ExecutionContext executionContext = createExecutionContext(assumeRoleWithSAMLRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AssumeRoleWithSAMLRequestMarshaller().marshall(super.beforeMarshalling(assumeRoleWithSAMLRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "AssumeRoleWithSAML");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new AssumeRoleWithSAMLResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns a set of temporary security credentials for users who have been authenticated in a mobile or web
* application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook,
* Google, or any OpenID Connect-compatible identity provider.
*
*
*
* For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user.
* You can also supply the user with a consistent identity throughout the lifetime of an application.
*
*
* To learn more about Amazon Cognito, see Amazon Cognito
* Overview in AWS SDK for Android Developer Guide and Amazon Cognito
* Overview in the AWS SDK for iOS Developer Guide.
*
*
*
* Calling AssumeRoleWithWebIdentity 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. You also don't need to deploy server-based proxy
* services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token
* from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API
* operations that produce temporary credentials, see Requesting Temporary
* Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.
*
*
* The temporary security credentials returned by this API 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 API
* operations.
*
*
* Session Duration
*
*
* By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one
* hour. However, you can use the optional DurationSeconds parameter to specify the duration of your
* session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the
* role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your
* role, see View
* the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration
* limit applies when you use the AssumeRole* API operations or the assume-role* CLI
* commands. However the limit does not apply when you use those operations to create a console URL. For more
* information, see Using IAM Roles
* in the IAM User Guide.
*
*
* Permissions
*
*
* The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API
* calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or
* GetSessionToken API operations.
*
*
* (Optional) You can pass inline or managed session
* policies to this operation. You can pass a single JSON policy document to use as an inline session policy.
* You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use
* for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation
* returns new temporary credentials. The resulting session's permissions are the intersection of the role's
* identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS
* API calls to access resources in the account that owns the role. You cannot use session policies to grant more
* permissions than those allowed by the identity-based policy of the role that is being assumed. For more
* information, see Session
* Policies in the IAM User Guide.
*
*
* Tags
*
*
* (Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each
* session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in
* the IAM User Guide.
*
*
* You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters and the values
* can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
*
*
*
* An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a
* separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The
* PackedPolicySize response element indicates by percentage how close the policies and tags for your
* request are to the upper size limit.
*
*
*
* You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag
* overrides the role tag with the same key.
*
*
* An administrator must grant you the permissions necessary to pass session tags. The administrator can also create
* granular permissions to allow you to pass only specific session tags. For more information, see Tutorial:
* Using Tags for Attribute-Based Access Control in the IAM User Guide.
*
*
* You can set the session tags as transitive. Transitive tags persist during role chaining. For more information,
* see
* Chaining Roles with Session Tags in the IAM User Guide.
*
*
* Identities
*
*
* 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.
*
*
*
* Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry
* includes the Subject of the provided
* Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this
* field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC
* specification.
*
*
*
* For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API,
* see the following resources:
*
*
* -
*
* Using Web Identity
* Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
*
*
* -
*
* Web Identity Federation
* Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google,
* getting temporary security credentials, and then using those credentials to make a request to AWS.
*
*
* -
*
* AWS SDK for iOS Developer Guide and AWS SDK for Android Developer Guide. These toolkits contain
* sample apps that show how to invoke the identity providers. The toolkits then show how to use the information
* from these providers to get and use temporary security credentials.
*
*
* -
*
* Web Identity Federation
* with Mobile Applications. This article discusses web identity federation and shows an example of how to use
* web identity federation to get access to content in Amazon S3.
*
*
*
*
* @param assumeRoleWithWebIdentityRequest
* @return Result of the AssumeRoleWithWebIdentity operation returned by the service.
* @throws MalformedPolicyDocumentException
* The request was rejected because the policy document was malformed. The error message describes the
* specific error.
* @throws PackedPolicyTooLargeException
* The request was rejected because the total packed size of the session policies and session tags combined
* was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session
* tags into a packed binary format that has a separate limit. The error message indicates by percentage how
* close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in
* STS in the IAM User Guide.
*
* You could receive this error even though you meet other defined session policy and session tag limits.
* For more information, see IAM and
* STS Entity Character Limits in the IAM User Guide.
* @throws IDPRejectedClaimException
* The identity provider (IdP) reported that authentication failed. This might be because the claim is
* invalid.
*
*
* If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that
* the claim has expired or has been explicitly revoked.
* @throws IDPCommunicationErrorException
* The request could not be fulfilled because the identity provider (IDP) that was asked to verify the
* incoming identity token could not be reached. This is often a transient error caused by network
* conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the
* error persists, the identity provider might be down or not responding.
* @throws InvalidIdentityTokenException
* The web identity token that was passed could not be validated by AWS. Get a new identity token from the
* identity provider and then retry the request.
* @throws ExpiredTokenException
* The web identity token that was passed is expired or is not valid. Get a new identity token from the
* identity provider and then retry the request.
* @throws RegionDisabledException
* STS is not activated in the requested region for the account that is being asked to generate credentials.
* The account administrator must use the IAM console to activate STS in that region. For more information,
* see
* Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
* @sample AWSSecurityTokenService.AssumeRoleWithWebIdentity
* @see AWS
* API Documentation
*/
@Override
public AssumeRoleWithWebIdentityResult assumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest request) {
request = beforeClientExecution(request);
return executeAssumeRoleWithWebIdentity(request);
}
@SdkInternalApi
final AssumeRoleWithWebIdentityResult executeAssumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest) {
ExecutionContext executionContext = createExecutionContext(assumeRoleWithWebIdentityRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AssumeRoleWithWebIdentityRequestMarshaller().marshall(super.beforeMarshalling(assumeRoleWithWebIdentityRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "AssumeRoleWithWebIdentity");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new AssumeRoleWithWebIdentityResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 operation that he or she has requested, the request
* returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations
* additionally return an encoded message that can provide details about this authorization failure.
*
*
*
* Only certain AWS operations return an encoded authorization message. The documentation for an individual
* operation indicates whether that operation 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 operation 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 the IAM User Guide.
*
*
* -
*
* 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.
*
*
*
*
* @param decodeAuthorizationMessageRequest
* @return Result of the DecodeAuthorizationMessage operation returned by the service.
* @throws InvalidAuthorizationMessageException
* The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can
* happen if the token contains invalid characters, such as linebreaks.
* @sample AWSSecurityTokenService.DecodeAuthorizationMessage
* @see AWS
* API Documentation
*/
@Override
public DecodeAuthorizationMessageResult decodeAuthorizationMessage(DecodeAuthorizationMessageRequest request) {
request = beforeClientExecution(request);
return executeDecodeAuthorizationMessage(request);
}
@SdkInternalApi
final DecodeAuthorizationMessageResult executeDecodeAuthorizationMessage(DecodeAuthorizationMessageRequest decodeAuthorizationMessageRequest) {
ExecutionContext executionContext = createExecutionContext(decodeAuthorizationMessageRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DecodeAuthorizationMessageRequestMarshaller().marshall(super.beforeMarshalling(decodeAuthorizationMessageRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DecodeAuthorizationMessage");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new DecodeAuthorizationMessageResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns the account identifier for the specified access key ID.
*
*
* Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret
* access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about
* access keys, see Managing Access Keys for
* IAM Users in the IAM User Guide.
*
*
* When you pass an access key ID to this operation, it returns the ID of the AWS account to which the keys belong.
* Access key IDs beginning with AKIA are long-term credentials for an IAM user or the AWS account root
* user. Access key IDs beginning with ASIA are temporary credentials that are created using STS
* operations. If the account in the response belongs to you, you can sign in as the root user and review your root
* user access keys. Then, you can pull a credentials report
* to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA
* access key, view the STS events in your CloudTrail logs in the
* IAM User Guide.
*
*
* This operation does not indicate the state of the access key. The key might be active, inactive, or deleted.
* Active keys might not have permissions to perform an operation. Providing a deleted access key might return an
* error that the key doesn't exist.
*
*
* @param getAccessKeyInfoRequest
* @return Result of the GetAccessKeyInfo operation returned by the service.
* @sample AWSSecurityTokenService.GetAccessKeyInfo
* @see AWS API
* Documentation
*/
@Override
public GetAccessKeyInfoResult getAccessKeyInfo(GetAccessKeyInfoRequest request) {
request = beforeClientExecution(request);
return executeGetAccessKeyInfo(request);
}
@SdkInternalApi
final GetAccessKeyInfoResult executeGetAccessKeyInfo(GetAccessKeyInfoRequest getAccessKeyInfoRequest) {
ExecutionContext executionContext = createExecutionContext(getAccessKeyInfoRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetAccessKeyInfoRequestMarshaller().marshall(super.beforeMarshalling(getAccessKeyInfoRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetAccessKeyInfo");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new GetAccessKeyInfoResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns details about the IAM user or role whose credentials are used to call the operation.
*
*
*
* No permissions are required to perform this operation. If an administrator adds a policy to your IAM user or role
* that explicitly denies access to the sts:GetCallerIdentity action, you can still perform this
* operation. Permissions are not required because the same information is returned when an IAM user or role is
* denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide.
*
*
*
* @param getCallerIdentityRequest
* @return Result of the GetCallerIdentity operation returned by the service.
* @sample AWSSecurityTokenService.GetCallerIdentity
* @see AWS API
* Documentation
*/
@Override
public GetCallerIdentityResult getCallerIdentity(GetCallerIdentityRequest request) {
request = beforeClientExecution(request);
return executeGetCallerIdentity(request);
}
@SdkInternalApi
final GetCallerIdentityResult executeGetCallerIdentity(GetCallerIdentityRequest getCallerIdentityRequest) {
ExecutionContext executionContext = createExecutionContext(getCallerIdentityRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetCallerIdentityRequestMarshaller().marshall(super.beforeMarshalling(getCallerIdentityRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCallerIdentity");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new GetCallerIdentityResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 gets temporary security
* credentials on behalf of distributed applications inside a corporate network. You must call the
* GetFederationToken operation using the long-term security credentials of an IAM user. As a result,
* this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based
* application. For a comparison of GetFederationToken with the other API operations that produce
* temporary credentials, see Requesting Temporary
* Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.
*
*
*
* You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like
* Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we
* recommend that you use Amazon Cognito or
* AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
*
*
*
* You can also call GetFederationToken using the security credentials of an AWS account root user, but
* we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy
* application. Then attach a policy to the IAM user that limits federated users to only the actions and resources
* that they need to access. For more information, see IAM Best Practices in the IAM
* User Guide.
*
*
* Session duration
*
*
* The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of
* 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials that
* are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).
*
*
* Permissions
*
*
* You can use the temporary credentials created by GetFederationToken in any AWS service except the
* following:
*
*
* -
*
* You cannot call any IAM operations using the AWS CLI or the AWS API.
*
*
* -
*
* You cannot call any STS operations except GetCallerIdentity.
*
*
*
*
* You must pass an inline or managed session policy
* to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also
* specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline
* and managed session policies can't exceed 2,048 characters.
*
*
* Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user
* session has no permissions. When you pass session policies, the session permissions are the intersection of the
* IAM user policies and the session policies that you pass. This gives you a way to further restrict the
* permissions for a federated user. You cannot use session policies to grant more permissions than those that are
* defined in the permissions policy of the IAM user. For more information, see Session
* Policies in the IAM User Guide. For information about using GetFederationToken to create
* temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
*
*
* You can use the credentials to access a resource that has a resource-based policy. If that policy specifically
* references the federated user session in the Principal element of the policy, the session has the
* permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the
* session policies.
*
*
* Tags
*
*
* (Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information
* about session tags, see Passing
* Session Tags in STS in the IAM User Guide.
*
*
* An administrator must grant you the permissions necessary to pass session tags. The administrator can also create
* granular permissions to allow you to pass only specific session tags. For more information, see Tutorial:
* Using Tags for Attribute-Based Access Control in the IAM User Guide.
*
*
* Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
* Department and department tag keys. Assume that the user that you are federating has
* the Department=Marketing tag and you pass the department=
* engineering session tag. Department and department are not saved as
* separate tags, and the session tag passed in the request takes precedence over the user tag.
*
*
* @param getFederationTokenRequest
* @return Result of the GetFederationToken operation returned by the service.
* @throws MalformedPolicyDocumentException
* The request was rejected because the policy document was malformed. The error message describes the
* specific error.
* @throws PackedPolicyTooLargeException
* The request was rejected because the total packed size of the session policies and session tags combined
* was too large. An AWS conversion compresses the session policy document, session policy ARNs, and session
* tags into a packed binary format that has a separate limit. The error message indicates by percentage how
* close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in
* STS in the IAM User Guide.
*
* You could receive this error even though you meet other defined session policy and session tag limits.
* For more information, see IAM and
* STS Entity Character Limits in the IAM User Guide.
* @throws RegionDisabledException
* STS is not activated in the requested region for the account that is being asked to generate credentials.
* The account administrator must use the IAM console to activate STS in that region. For more information,
* see
* Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
* @sample AWSSecurityTokenService.GetFederationToken
* @see AWS API
* Documentation
*/
@Override
public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request) {
request = beforeClientExecution(request);
return executeGetFederationToken(request);
}
@SdkInternalApi
final GetFederationTokenResult executeGetFederationToken(GetFederationTokenRequest getFederationTokenRequest) {
ExecutionContext executionContext = createExecutionContext(getFederationTokenRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetFederationTokenRequestMarshaller().marshall(super.beforeMarshalling(getFederationTokenRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetFederationToken");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new GetFederationTokenResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 to use
* MFA to protect programmatic calls to specific AWS API operations 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 API operations that require MFA authentication. If you do not supply a correct
* MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the
* other API operations that produce temporary credentials, see Requesting Temporary
* Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.
*
*
* Session Duration
*
*
* The GetSessionToken operation must be called by using the long-term AWS security credentials of the
* AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that
* you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours),
* with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds
* (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
*
*
* Permissions
*
*
* The temporary security credentials created by GetSessionToken can be used to make API calls to any
* AWS service with the following exceptions:
*
*
* -
*
* You cannot call any IAM API operations unless MFA authentication information is included in the request.
*
*
* -
*
* You cannot call any STS API except AssumeRole or GetCallerIdentity.
*
*
*
*
*
* We recommend that you do not call GetSessionToken with AWS account root user credentials. Instead,
* follow our best
* practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for
* everyday interaction with AWS.
*
*
*
* The credentials that are returned by GetSessionToken are based on permissions associated with the
* user whose credentials were used to call the operation. If GetSessionToken is called using AWS
* account root user credentials, the temporary credentials have root user permissions. Similarly, if
* GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the
* same permissions as the IAM user.
*
*
* For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.
*
*
* @param getSessionTokenRequest
* @return Result of the GetSessionToken operation returned by the service.
* @throws RegionDisabledException
* STS is not activated in the requested region for the account that is being asked to generate credentials.
* The account administrator must use the IAM console to activate STS in that region. For more information,
* see
* Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
* @sample AWSSecurityTokenService.GetSessionToken
* @see AWS API
* Documentation
*/
@Override
public GetSessionTokenResult getSessionToken(GetSessionTokenRequest request) {
request = beforeClientExecution(request);
return executeGetSessionToken(request);
}
@SdkInternalApi
final GetSessionTokenResult executeGetSessionToken(GetSessionTokenRequest getSessionTokenRequest) {
ExecutionContext executionContext = createExecutionContext(getSessionTokenRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetSessionTokenRequestMarshaller().marshall(super.beforeMarshalling(getSessionTokenRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "STS");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetSessionToken");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
StaxResponseHandler responseHandler = new StaxResponseHandler(
new GetSessionTokenResultStaxUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
@Override
public GetSessionTokenResult getSessionToken() {
return getSessionToken(new GetSessionTokenRequest());
}
@Override
@Deprecated
public void setRegion(Region region) {
Region mappedRegion = mapToLegacyRegionIfNecessary(region);
super.setRegion(mappedRegion);
}
private Region mapToLegacyRegionIfNecessary(Region region) {
if (legacyRegionModeEnabled() && LEGACY_ENABLED_REGIONS.contains(region.getName())) {
return RegionUtils.getRegion("aws-global");
}
return region;
}
private boolean legacyRegionModeEnabled() {
return REGIONAL_ENDPOINTS_OPTION_RESOLVER.useLegacyMode();
}
@com.amazonaws.annotation.SdkTestInternalApi
static void setRegionalEndpointsOptionResolver(RegionalEndpointsOptionResolver resolver) {
REGIONAL_ENDPOINTS_OPTION_RESOLVER = resolver;
}
/**
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
return invoke(request, responseHandler, executionContext, null, null);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) {
executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait);
}
/**
* Invoke with no authentication. Credentials are not required and any credentials set on the client or request will
* be ignored for this operation.
**/
private Response anonymousInvoke(Request request,
HttpResponseHandler> responseHandler, ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext, null, null);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the
* ExecutionContext beforehand.
**/
private Response doInvoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) {
if (discoveredEndpoint != null) {
request.setEndpoint(discoveredEndpoint);
request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery");
} else if (uriFromEndpointTrait != null) {
request.setEndpoint(uriFromEndpointTrait);
} else {
request.setEndpoint(endpoint);
}
request.setTimeOffset(timeOffset);
DefaultErrorResponseHandler errorResponseHandler = new DefaultErrorResponseHandler(exceptionUnmarshallers);
return client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
}