com.amazonaws.services.cognitoidentity

Interface AmazonCognitoIdentityAsync

All Superinterfaces:

AmazonCognitoIdentity

All Known Implementing Classes:

AbstractAmazonCognitoIdentityAsync, AmazonCognitoIdentityAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCognitoIdentityAsync
extends AmazonCognitoIdentity

Interface for accessing Amazon Cognito Identity asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCognitoIdentityAsync instead.

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 interface com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreateIdentityPoolResult>	createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest) Creates a new identity pool.
Future<CreateIdentityPoolResult>	createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest, AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler) Creates a new identity pool.
Future<DeleteIdentitiesResult>	deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest) Deletes identities from an identity pool.
Future<DeleteIdentitiesResult>	deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest, AsyncHandler<DeleteIdentitiesRequest,DeleteIdentitiesResult> asyncHandler) Deletes identities from an identity pool.
Future<DeleteIdentityPoolResult>	deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest) Deletes an identity pool.
Future<DeleteIdentityPoolResult>	deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest, AsyncHandler<DeleteIdentityPoolRequest,DeleteIdentityPoolResult> asyncHandler) Deletes an identity pool.
Future<DescribeIdentityResult>	describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
Future<DescribeIdentityResult>	describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest, AsyncHandler<DescribeIdentityRequest,DescribeIdentityResult> asyncHandler) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
Future<DescribeIdentityPoolResult>	describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
Future<DescribeIdentityPoolResult>	describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest, AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
Future<GetCredentialsForIdentityResult>	getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) Returns credentials for the provided identity ID.
Future<GetCredentialsForIdentityResult>	getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest, AsyncHandler<GetCredentialsForIdentityRequest,GetCredentialsForIdentityResult> asyncHandler) Returns credentials for the provided identity ID.
Future<GetIdResult>	getIdAsync(GetIdRequest getIdRequest) Generates (or retrieves) a Cognito ID.
Future<GetIdResult>	getIdAsync(GetIdRequest getIdRequest, AsyncHandler<GetIdRequest,GetIdResult> asyncHandler) Generates (or retrieves) a Cognito ID.
Future<GetIdentityPoolRolesResult>	getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) Gets the roles for an identity pool.
Future<GetIdentityPoolRolesResult>	getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest, AsyncHandler<GetIdentityPoolRolesRequest,GetIdentityPoolRolesResult> asyncHandler) Gets the roles for an identity pool.
Future<GetOpenIdTokenResult>	getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest) Gets an OpenID token, using a known Cognito ID.
Future<GetOpenIdTokenResult>	getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest, AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler) Gets an OpenID token, using a known Cognito ID.
Future<GetOpenIdTokenForDeveloperIdentityResult>	getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest) Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.
Future<GetOpenIdTokenForDeveloperIdentityResult>	getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest, AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,GetOpenIdTokenForDeveloperIdentityResult> asyncHandler) Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.
Future<ListIdentitiesResult>	listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest) Lists the identities in an identity pool.
Future<ListIdentitiesResult>	listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest, AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler) Lists the identities in an identity pool.
Future<ListIdentityPoolsResult>	listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest) Lists all of the Cognito identity pools registered for your account.
Future<ListIdentityPoolsResult>	listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest, AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler) Lists all of the Cognito identity pools registered for your account.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are assigned to an Amazon Cognito identity pool.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the tags that are assigned to an Amazon Cognito identity pool.
Future<LookupDeveloperIdentityResult>	lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
Future<LookupDeveloperIdentityResult>	lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest, AsyncHandler<LookupDeveloperIdentityRequest,LookupDeveloperIdentityResult> asyncHandler) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
Future<MergeDeveloperIdentitiesResult>	mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider.
Future<MergeDeveloperIdentitiesResult>	mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest, AsyncHandler<MergeDeveloperIdentitiesRequest,MergeDeveloperIdentitiesResult> asyncHandler) Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider.
Future<SetIdentityPoolRolesResult>	setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) Sets the roles for an identity pool.
Future<SetIdentityPoolRolesResult>	setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest, AsyncHandler<SetIdentityPoolRolesRequest,SetIdentityPoolRolesResult> asyncHandler) Sets the roles for an identity pool.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Assigns a set of tags to an Amazon Cognito identity pool.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Assigns a set of tags to an Amazon Cognito identity pool.
Future<UnlinkDeveloperIdentityResult>	unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest) Unlinks a DeveloperUserIdentifier from an existing identity.
Future<UnlinkDeveloperIdentityResult>	unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest, AsyncHandler<UnlinkDeveloperIdentityRequest,UnlinkDeveloperIdentityResult> asyncHandler) Unlinks a DeveloperUserIdentifier from an existing identity.
Future<UnlinkIdentityResult>	unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest) Unlinks a federated identity from an existing account.
Future<UnlinkIdentityResult>	unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest, AsyncHandler<UnlinkIdentityRequest,UnlinkIdentityResult> asyncHandler) Unlinks a federated identity from an existing account.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Removes the specified tags from an Amazon Cognito identity pool.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes the specified tags from an Amazon Cognito identity pool.
Future<UpdateIdentityPoolResult>	updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest) Updates an identity pool.
Future<UpdateIdentityPoolResult>	updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest, AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler) Updates an identity pool.

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

createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, listTagsForResource, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setRegion, shutdown, tagResource, unlinkDeveloperIdentity, unlinkIdentity, untagResource, updateIdentityPool

Method Detail

createIdentityPoolAsync

Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest)

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.

Parameters:

createIdentityPoolRequest - Input to the CreateIdentityPool action.

Returns:

A Java Future containing the result of the CreateIdentityPool operation returned by the service.

See Also:

AWS API Documentation

createIdentityPoolAsync

Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest,
                                                         AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler)

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.

Parameters:

createIdentityPoolRequest - Input to the CreateIdentityPool action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateIdentityPool operation returned by the service.

See Also:

AWS API Documentation

deleteIdentitiesAsync

Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest)

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.

Parameters:

deleteIdentitiesRequest - Input to the DeleteIdentities action.

Returns:

A Java Future containing the result of the DeleteIdentities operation returned by the service.

See Also:

AWS API Documentation

deleteIdentitiesAsync

Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest,
                                                     AsyncHandler<DeleteIdentitiesRequest,DeleteIdentitiesResult> asyncHandler)

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.

Parameters:

deleteIdentitiesRequest - Input to the DeleteIdentities action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteIdentities operation returned by the service.

See Also:

AWS API Documentation

deleteIdentityPoolAsync

Future<DeleteIdentityPoolResult> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest)

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.

Parameters:

deleteIdentityPoolRequest - Input to the DeleteIdentityPool action.

Returns:

A Java Future containing the result of the DeleteIdentityPool operation returned by the service.

See Also:

AWS API Documentation

deleteIdentityPoolAsync

Future<DeleteIdentityPoolResult> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest,
                                                         AsyncHandler<DeleteIdentityPoolRequest,DeleteIdentityPoolResult> asyncHandler)

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.

Parameters:

deleteIdentityPoolRequest - Input to the DeleteIdentityPool action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteIdentityPool operation returned by the service.

See Also:

AWS API Documentation

describeIdentityAsync

Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest)

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.

Parameters:

describeIdentityRequest - Input to the DescribeIdentity action.

Returns:

A Java Future containing the result of the DescribeIdentity operation returned by the service.

See Also:

AWS API Documentation

describeIdentityAsync

Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest,
                                                     AsyncHandler<DescribeIdentityRequest,DescribeIdentityResult> asyncHandler)

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.

Parameters:

describeIdentityRequest - Input to the DescribeIdentity action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeIdentity operation returned by the service.

See Also:

AWS API Documentation

describeIdentityPoolAsync

Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest)

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.

Parameters:

describeIdentityPoolRequest - Input to the DescribeIdentityPool action.

Returns:

A Java Future containing the result of the DescribeIdentityPool operation returned by the service.

See Also:

AWS API Documentation

describeIdentityPoolAsync

Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest,
                                                             AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler)

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.

Parameters:

describeIdentityPoolRequest - Input to the DescribeIdentityPool action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeIdentityPool operation returned by the service.

See Also:

AWS API Documentation

getCredentialsForIdentityAsync

Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)

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

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

Parameters:

getCredentialsForIdentityRequest - Input to the GetCredentialsForIdentity action.

Returns:

A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.

See Also:

AWS API Documentation

getCredentialsForIdentityAsync

Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest,
                                                                       AsyncHandler<GetCredentialsForIdentityRequest,GetCredentialsForIdentityResult> asyncHandler)

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.

Parameters:

getCredentialsForIdentityRequest - Input to the GetCredentialsForIdentity action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.

See Also:

AWS API Documentation

getIdAsync

Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest)

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

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

Parameters:

getIdRequest - Input to the GetId action.

Returns:

A Java Future containing the result of the GetId operation returned by the service.

See Also:

AWS API Documentation

getIdAsync

Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest,
                               AsyncHandler<GetIdRequest,GetIdResult> asyncHandler)

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.

Parameters:

getIdRequest - Input to the GetId action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetId operation returned by the service.

See Also:

AWS API Documentation

getIdentityPoolRolesAsync

Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

getIdentityPoolRolesRequest - Input to the GetIdentityPoolRoles action.

Returns:

A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.

See Also:

AWS API Documentation

getIdentityPoolRolesAsync

Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest,
                                                             AsyncHandler<GetIdentityPoolRolesRequest,GetIdentityPoolRolesResult> asyncHandler)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

getIdentityPoolRolesRequest - Input to the GetIdentityPoolRoles action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.

See Also:

AWS API Documentation

getOpenIdTokenAsync

Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest)

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

The OpenId token is valid for 10 minutes.

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

Parameters:

getOpenIdTokenRequest - Input to the GetOpenIdToken action.

Returns:

A Java Future containing the result of the GetOpenIdToken operation returned by the service.

See Also:

AWS API Documentation

getOpenIdTokenAsync

Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest,
                                                 AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler)

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.

Parameters:

getOpenIdTokenRequest - Input to the GetOpenIdToken action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetOpenIdToken operation returned by the service.

See Also:

AWS API Documentation

getOpenIdTokenForDeveloperIdentityAsync

Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)

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.

Parameters:

getOpenIdTokenForDeveloperIdentityRequest - Input to the GetOpenIdTokenForDeveloperIdentity action.

Returns:

A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

getOpenIdTokenForDeveloperIdentityAsync

Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest,
                                                                                         AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,GetOpenIdTokenForDeveloperIdentityResult> asyncHandler)

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.

Parameters:

getOpenIdTokenForDeveloperIdentityRequest - Input to the GetOpenIdTokenForDeveloperIdentity action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

listIdentitiesAsync

Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest)

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

listIdentitiesRequest - Input to the ListIdentities action.

Returns:

A Java Future containing the result of the ListIdentities operation returned by the service.

See Also:

AWS API Documentation

listIdentitiesAsync

Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest,
                                                 AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler)

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

listIdentitiesRequest - Input to the ListIdentities action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListIdentities operation returned by the service.

See Also:

AWS API Documentation

listIdentityPoolsAsync

Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest)

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

You must use AWS Developer credentials to call this API.

Parameters:

listIdentityPoolsRequest - Input to the ListIdentityPools action.

Returns:

A Java Future containing the result of the ListIdentityPools operation returned by the service.

See Also:

AWS API Documentation

listIdentityPoolsAsync

Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest,
                                                       AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler)

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

You must use AWS Developer credentials to call this API.

Parameters:

listIdentityPoolsRequest - Input to the ListIdentityPools action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListIdentityPools operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

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.

Parameters:

listTagsForResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

lookupDeveloperIdentityAsync

Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)

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.

Parameters:

lookupDeveloperIdentityRequest - Input to the LookupDeveloperIdentityInput action.

Returns:

A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

lookupDeveloperIdentityAsync

Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest,
                                                                   AsyncHandler<LookupDeveloperIdentityRequest,LookupDeveloperIdentityResult> asyncHandler)

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.

Parameters:

lookupDeveloperIdentityRequest - Input to the LookupDeveloperIdentityInput action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

mergeDeveloperIdentitiesAsync

Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)

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.

Parameters:

mergeDeveloperIdentitiesRequest - Input to the MergeDeveloperIdentities action.

Returns:

A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.

See Also:

AWS API Documentation

mergeDeveloperIdentitiesAsync

Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest,
                                                                     AsyncHandler<MergeDeveloperIdentitiesRequest,MergeDeveloperIdentitiesResult> asyncHandler)

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.

Parameters:

mergeDeveloperIdentitiesRequest - Input to the MergeDeveloperIdentities action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.

See Also:

AWS API Documentation

setIdentityPoolRolesAsync

Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)

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.

Parameters:

setIdentityPoolRolesRequest - Input to the SetIdentityPoolRoles action.

Returns:

A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.

See Also:

AWS API Documentation

setIdentityPoolRolesAsync

Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest,
                                                             AsyncHandler<SetIdentityPoolRolesRequest,SetIdentityPoolRolesResult> asyncHandler)

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.

Parameters:

setIdentityPoolRolesRequest - Input to the SetIdentityPoolRoles action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)

Assigns a set of tags to an 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.

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Assigns a set of tags to an 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.

Parameters:

tagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

unlinkDeveloperIdentityAsync

Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)

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.

Parameters:

unlinkDeveloperIdentityRequest - Input to the UnlinkDeveloperIdentity action.

Returns:

A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

unlinkDeveloperIdentityAsync

Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest,
                                                                   AsyncHandler<UnlinkDeveloperIdentityRequest,UnlinkDeveloperIdentityResult> asyncHandler)

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.

Parameters:

unlinkDeveloperIdentityRequest - Input to the UnlinkDeveloperIdentity action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.

See Also:

AWS API Documentation

unlinkIdentityAsync

Future<UnlinkIdentityResult> unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest)

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.

Parameters:

unlinkIdentityRequest - Input to the UnlinkIdentity action.

Returns:

A Java Future containing the result of the UnlinkIdentity operation returned by the service.

See Also:

AWS API Documentation

unlinkIdentityAsync

Future<UnlinkIdentityResult> unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest,
                                                 AsyncHandler<UnlinkIdentityRequest,UnlinkIdentityResult> asyncHandler)

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.

Parameters:

unlinkIdentityRequest - Input to the UnlinkIdentity action.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UnlinkIdentity operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

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

Parameters:

untagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateIdentityPoolAsync

Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest)

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

updateIdentityPoolRequest - An object representing an Amazon Cognito identity pool.

Returns:

A Java Future containing the result of the UpdateIdentityPool operation returned by the service.

See Also:

AWS API Documentation

updateIdentityPoolAsync

Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest,
                                                         AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler)

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

updateIdentityPoolRequest - An object representing an Amazon Cognito identity pool.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateIdentityPool operation returned by the service.

See Also:

AWS API Documentation