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 Amazon Cognito Identity. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Cognito Federated Identities

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

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, 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.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all Amazon Cognito Identity exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, 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
CreateIdentityPoolResult	createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest) Creates a new identity pool.
DeleteIdentitiesResult	deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest) Deletes identities from an identity pool.
void	deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest) Deletes an identity pool.
DescribeIdentityResult	describeIdentity(DescribeIdentityRequest describeIdentityRequest) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
DescribeIdentityPoolResult	describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
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.
GetIdentityPoolRolesResult	getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) Gets the roles for an identity pool.
GetOpenIdTokenResult	getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest) Gets an OpenID token, using a known Cognito ID.
GetOpenIdTokenForDeveloperIdentityResult	getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest) Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.
GetPrincipalTagAttributeMapResult	getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest) Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.
ListIdentitiesResult	listIdentities(ListIdentitiesRequest listIdentitiesRequest) Lists the identities in an identity pool.
ListIdentityPoolsResult	listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest) Lists all of the Cognito identity pools registered for your account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are assigned to an Amazon Cognito identity pool.
LookupDeveloperIdentityResult	lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
MergeDeveloperIdentitiesResult	mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider.
void	setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) Sets the roles for an identity pool.
SetPrincipalTagAttributeMapResult	setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest) You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns a set of tags to the specified Amazon Cognito identity pool.
void	unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest) Unlinks a DeveloperUserIdentifier from an existing identity.
void	unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest) Unlinks a federated identity from an existing account.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Cognito identity pool.
UpdateIdentityPoolResult	updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) Updates an identity pool.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, 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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected java.util.List<JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all Amazon Cognito Identity 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.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonCognitoIdentityClient client = new AmazonCognitoIdentityClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonCognitoIdentityClient client = new AmazonCognitoIdentityClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonCognitoIdentityClient client = new AmazonCognitoIdentityClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonCognitoIdentityClient client = new AmazonCognitoIdentityClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonCognitoIdentityClient client = new AmazonCognitoIdentityClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

createIdentityPool

public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

• Facebook: graph.facebook.com

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Specified by:

createIdentityPool in interface AmazonCognitoIdentity

Parameters:

createIdentityPoolRequest -

Input to the CreateIdentityPool action.

Returns:

createIdentityPoolResult The response from the CreateIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

LimitExceededException

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

deleteIdentities

public DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Specified by:

deleteIdentities in interface AmazonCognitoIdentity

Parameters:

deleteIdentitiesRequest -

Input to the DeleteIdentities action.

Returns:

deleteIdentitiesResult The response from the DeleteIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

TooManyRequestsException

InternalErrorException

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

deleteIdentityPool

public void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use AWS Developer credentials to call this API.

Specified by:

deleteIdentityPool in interface AmazonCognitoIdentity

Parameters:

deleteIdentityPoolRequest -

Input to the DeleteIdentityPool action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

describeIdentity

public DescribeIdentityResult describeIdentity(DescribeIdentityRequest describeIdentityRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Specified by:

describeIdentity in interface AmazonCognitoIdentity

Parameters:

describeIdentityRequest -

Input to the DescribeIdentity action.

Returns:

describeIdentityResult The response from the DescribeIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

describeIdentityPool

public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Specified by:

describeIdentityPool in interface AmazonCognitoIdentity

Parameters:

describeIdentityPoolRequest -

Input to the DescribeIdentityPool action.

Returns:

describeIdentityPoolResult The response from the DescribeIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

getCredentialsForIdentity

public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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 -

Input to the GetCredentialsForIdentity action.

Returns:

getCredentialsForIdentityResult The response from the GetCredentialsForIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InvalidIdentityPoolConfigurationException

InternalErrorException

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

getId

public GetIdResult getId(GetIdRequest getIdRequest)
                  throws AmazonServiceException,
                         AmazonClientException

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 -

Input to the GetId action.

Returns:

getIdResult The response from the GetId service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

LimitExceededException

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

getIdentityPoolRoles

public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Specified by:

getIdentityPoolRoles in interface AmazonCognitoIdentity

Parameters:

getIdentityPoolRolesRequest -

Input to the GetIdentityPoolRoles action.

Returns:

getIdentityPoolRolesResult The response from the GetIdentityPoolRoles service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

getOpenIdToken

public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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 10 minutes.

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

Specified by:

getOpenIdToken in interface AmazonCognitoIdentity

Parameters:

getOpenIdTokenRequest -

Input to the GetOpenIdToken action.

Returns:

getOpenIdTokenResult The response from the GetOpenIdToken service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

getOpenIdTokenForDeveloperIdentity

public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use AWS Developer credentials to call this API.

Specified by:

getOpenIdTokenForDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

getOpenIdTokenForDeveloperIdentityRequest -

Input to the GetOpenIdTokenForDeveloperIdentity action.

Returns:

getOpenIdTokenForDeveloperIdentityResult The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

DeveloperUserAlreadyRegisteredException

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

getPrincipalTagAttributeMap

public GetPrincipalTagAttributeMapResult getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

Specified by:

getPrincipalTagAttributeMap in interface AmazonCognitoIdentity

Parameters:

getPrincipalTagAttributeMapRequest -

Returns:

getPrincipalTagAttributeMapResult The response from the GetPrincipalTagAttributeMap service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

listIdentities

public ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Specified by:

listIdentities in interface AmazonCognitoIdentity

Parameters:

listIdentitiesRequest -

Input to the ListIdentities action.

Returns:

listIdentitiesResult The response from the ListIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

listIdentityPools

public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

Specified by:

listIdentityPools in interface AmazonCognitoIdentity

Parameters:

listIdentityPoolsRequest -

Input to the ListIdentityPools action.

Returns:

listIdentityPoolsResult The response from the ListIdentityPools service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

ResourceNotFoundException

InternalErrorException

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

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Lists the tags that are assigned to an Amazon Cognito identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

Specified by:

listTagsForResource in interface AmazonCognitoIdentity

Parameters:

listTagsForResourceRequest -

Returns:

listTagsForResourceResult The response from the ListTagsForResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

lookupDeveloperIdentity

public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.

You must use AWS Developer credentials to call this API.

Specified by:

lookupDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

lookupDeveloperIdentityRequest -

Input to the LookupDeveloperIdentityInput action.

Returns:

lookupDeveloperIdentityResult The response from the LookupDeveloperIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

mergeDeveloperIdentities

public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use AWS Developer credentials to call this API.

Specified by:

mergeDeveloperIdentities in interface AmazonCognitoIdentity

Parameters:

mergeDeveloperIdentitiesRequest -

Input to the MergeDeveloperIdentities action.

Returns:

mergeDeveloperIdentitiesResult The response from the MergeDeveloperIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

setIdentityPoolRoles

public void setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Specified by:

setIdentityPoolRoles in interface AmazonCognitoIdentity

Parameters:

setIdentityPoolRolesRequest -

Input to the SetIdentityPoolRoles action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

ConcurrentModificationException

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

setPrincipalTagAttributeMap

public SetPrincipalTagAttributeMapResult setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

Specified by:

setPrincipalTagAttributeMap in interface AmazonCognitoIdentity

Parameters:

setPrincipalTagAttributeMapRequest -

Returns:

setPrincipalTagAttributeMapResult The response from the SetPrincipalTagAttributeMap service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

tagResource

public TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

Specified by:

tagResource in interface AmazonCognitoIdentity

Parameters:

tagResourceRequest -

Returns:

tagResourceResult The response from the TagResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

unlinkDeveloperIdentity

public void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use AWS Developer credentials to call this API.

Specified by:

unlinkDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

unlinkDeveloperIdentityRequest -

Input to the UnlinkDeveloperIdentity action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

unlinkIdentity

public void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

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

Specified by:

unlinkIdentity in interface AmazonCognitoIdentity

Parameters:

unlinkIdentityRequest -

Input to the UnlinkIdentity action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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

untagResource

public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

Specified by:

untagResource in interface AmazonCognitoIdentity

Parameters:

untagResourceRequest -

Returns:

untagResourceResult The response from the UntagResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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

updateIdentityPool

public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Specified by:

updateIdentityPool in interface AmazonCognitoIdentity

Parameters:

updateIdentityPoolRequest -

An object representing an Amazon Cognito identity pool.

Returns:

updateIdentityPoolResult The response from the UpdateIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

ConcurrentModificationException

LimitExceededException

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

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.