com.amazonaws.services.cognitoidentity

Class AmazonCognitoIdentityClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityClient

All Implemented Interfaces:

AmazonCognitoIdentity

Direct Known Subclasses:

AmazonCognitoIdentityAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonCognitoIdentityClient() Deprecated. use AmazonCognitoIdentityClientBuilder.defaultClient()
AmazonCognitoIdentityClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCognitoIdentityClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonCognitoIdentityClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonCognitoIdentityClientBuilder	builder()
CreateIdentityPoolResult	createIdentityPool(CreateIdentityPoolRequest request) Creates a new identity pool.
DeleteIdentitiesResult	deleteIdentities(DeleteIdentitiesRequest request) Deletes identities from an identity pool.
DeleteIdentityPoolResult	deleteIdentityPool(DeleteIdentityPoolRequest request) Deletes an identity pool.
DescribeIdentityResult	describeIdentity(DescribeIdentityRequest request) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
DescribeIdentityPoolResult	describeIdentityPool(DescribeIdentityPoolRequest request) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCredentialsForIdentityResult	getCredentialsForIdentity(GetCredentialsForIdentityRequest request) Returns credentials for the provided identity ID.
GetIdResult	getId(GetIdRequest request) Generates (or retrieves) a Cognito ID.
GetIdentityPoolRolesResult	getIdentityPoolRoles(GetIdentityPoolRolesRequest request) Gets the roles for an identity pool.
GetOpenIdTokenResult	getOpenIdToken(GetOpenIdTokenRequest request) Gets an OpenID token, using a known Cognito ID.
GetOpenIdTokenForDeveloperIdentityResult	getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request) Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.
GetPrincipalTagAttributeMapResult	getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest request) Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.
ListIdentitiesResult	listIdentities(ListIdentitiesRequest request) Lists the identities in an identity pool.
ListIdentityPoolsResult	listIdentityPools(ListIdentityPoolsRequest request) Lists all of the Cognito identity pools registered for your account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags that are assigned to an Amazon Cognito identity pool.
LookupDeveloperIdentityResult	lookupDeveloperIdentity(LookupDeveloperIdentityRequest request) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
MergeDeveloperIdentitiesResult	mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request) Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider.
SetIdentityPoolRolesResult	setIdentityPoolRoles(SetIdentityPoolRolesRequest request) Sets the roles for an identity pool.
SetPrincipalTagAttributeMapResult	setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest request) You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns a set of tags to the specified Amazon Cognito identity pool.
UnlinkDeveloperIdentityResult	unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest request) Unlinks a DeveloperUserIdentifier from an existing identity.
UnlinkIdentityResult	unlinkIdentity(UnlinkIdentityRequest request) Unlinks a federated identity from an existing account.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified Amazon Cognito identity pool.
UpdateIdentityPoolResult	updateIdentityPool(UpdateIdentityPoolRequest request) Updates an identity pool.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion

Constructor Detail

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient()

Deprecated. use AmazonCognitoIdentityClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon Cognito Identity. 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. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCognitoIdentityClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon Cognito Identity 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

@Deprecated
public AmazonCognitoIdentityClient(AWSCredentials awsCredentials,
                                               ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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

AmazonCognitoIdentityClient

@Deprecated
public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon Cognito Identity 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

@Deprecated
public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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

AmazonCognitoIdentityClient

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

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

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

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonCognitoIdentityClientBuilder builder()

createIdentityPool

public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest request)

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:

Result of the CreateIdentityPool operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

LimitExceededException - Thrown when the total number of user pools has exceeded a preset limit.

See Also:

AWS API Documentation

deleteIdentities

public DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest request)

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:

Result of the DeleteIdentities operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

deleteIdentityPool

public DeleteIdentityPoolResult deleteIdentityPool(DeleteIdentityPoolRequest request)

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.

Returns:

Result of the DeleteIdentityPool operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

describeIdentity

public DescribeIdentityResult describeIdentity(DescribeIdentityRequest request)

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:

Result of the DescribeIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

describeIdentityPool

public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest request)

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:

Result of the DescribeIdentityPool operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

getCredentialsForIdentity

public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest request)

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:

Result of the GetCredentialsForIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InvalidIdentityPoolConfigurationException - Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

InternalErrorException - Thrown when the service encounters an error during processing the request.

ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding

See Also:

AWS API Documentation

getId

public GetIdResult getId(GetIdRequest request)

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:

Result of the GetId operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

LimitExceededException - Thrown when the total number of user pools has exceeded a preset limit.

ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding

See Also:

AWS API Documentation

getIdentityPoolRoles

public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest request)

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:

Result of the GetIdentityPoolRoles operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

getOpenIdToken

public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest request)

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:

Result of the GetOpenIdToken operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding

See Also:

AWS API Documentation

getOpenIdTokenForDeveloperIdentity

public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request)

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:

Result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

DeveloperUserAlreadyRegisteredException - The provided developer user identifier is already registered with Cognito under a different identity ID.

See Also:

AWS API Documentation

getPrincipalTagAttributeMap

public GetPrincipalTagAttributeMapResult getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest request)

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

Specified by:

getPrincipalTagAttributeMap in interface AmazonCognitoIdentity

Parameters:

getPrincipalTagAttributeMapRequest -

Returns:

Result of the GetPrincipalTagAttributeMap operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

listIdentities

public ListIdentitiesResult listIdentities(ListIdentitiesRequest request)

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:

Result of the ListIdentities operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

listIdentityPools

public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest request)

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:

Result of the ListIdentityPools operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

lookupDeveloperIdentity

public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest request)

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:

Result of the LookupDeveloperIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

mergeDeveloperIdentities

public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request)

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:

Result of the MergeDeveloperIdentities operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

setIdentityPoolRoles

public SetIdentityPoolRolesResult setIdentityPoolRoles(SetIdentityPoolRolesRequest request)

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.

Returns:

Result of the SetIdentityPoolRoles operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

ConcurrentModificationException - Thrown if there are parallel requests to modify a resource.

See Also:

AWS API Documentation

setPrincipalTagAttributeMap

public SetPrincipalTagAttributeMapResult setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest request)

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:

Result of the SetPrincipalTagAttributeMap operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

unlinkDeveloperIdentity

public UnlinkDeveloperIdentityResult unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest request)

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.

Returns:

Result of the UnlinkDeveloperIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

unlinkIdentity

public UnlinkIdentityResult unlinkIdentity(UnlinkIdentityRequest request)

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.

Returns:

Result of the UnlinkIdentity operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

See Also:

AWS API Documentation

updateIdentityPool

public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest request)

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:

Result of the UpdateIdentityPool operation returned by the service.

Throws:

InvalidParameterException - Thrown for missing or bad input parameter(s).

ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.

TooManyRequestsException - Thrown when a request is throttled.

InternalErrorException - Thrown when the service encounters an error during processing the request.

ConcurrentModificationException - Thrown if there are parallel requests to modify a resource.

LimitExceededException - Thrown when the total number of user pools has exceeded a preset limit.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonCognitoIdentity

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCognitoIdentity

Overrides:

shutdown in class AmazonWebServiceClient