com.amazonaws.services.cognitoidentity

Class AmazonCognitoIdentityClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityClient

All Implemented Interfaces:

AmazonCognitoIdentity

public class AmazonCognitoIdentityClient
extends AmazonWebServiceClient
implements AmazonCognitoIdentity

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

Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId . Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles , or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId . The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide .

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonCognitoIdentity exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCognitoIdentityClient() Deprecated.
AmazonCognitoIdentityClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials.
AmazonCognitoIdentityClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials and client configuration options.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider and client configuration options.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetCredentialsForIdentityResult	getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) Returns credentials for the provided identity ID.
GetIdResult	getId(GetIdRequest getIdRequest) Generates (or retrieves) a Cognito ID.
GetOpenIdTokenResult	getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest) Gets an OpenID token, using a known Cognito ID.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonCognitoIdentity exceptions.

Constructor Detail

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonCognitoIdentity. 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:

DefaultAWSCredentialsProviderChain

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonCognitoIdentity. 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 AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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.

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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 AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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.

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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 AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration,
                                               RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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.

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 AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonCognitoIdentity 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.

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 AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

getId

public GetIdResult getId(GetIdRequest getIdRequest)

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

Specified by:

getId in interface AmazonCognitoIdentity

Parameters:

getIdRequest - Container for the necessary parameters to execute the GetId service method on AmazonCognitoIdentity.

Returns:

The response from the GetId service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

LimitExceededException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

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 AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getCredentialsForIdentity

public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

Specified by:

getCredentialsForIdentity in interface AmazonCognitoIdentity

Parameters:

getCredentialsForIdentityRequest - Container for the necessary parameters to execute the GetCredentialsForIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the GetCredentialsForIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

InvalidIdentityPoolConfigurationException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

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 AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getOpenIdToken

public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

This is a public API. You do not need any credentials to call this API.

Specified by:

getOpenIdToken in interface AmazonCognitoIdentity

Parameters:

getOpenIdTokenRequest - Container for the necessary parameters to execute the GetOpenIdToken service method on AmazonCognitoIdentity.

Returns:

The response from the GetOpenIdToken service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

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 AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Specified by:

setEndpoint in interface AmazonCognitoIdentity

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

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

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

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

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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 AmazonCognitoIdentity

Parameters:

request - The originally executed request

Returns:

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