@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCognitoIdentityAsyncClient extends AmazonCognitoIdentityClient implements AmazonCognitoIdentityAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonCognitoIdentityAsyncClient()
Deprecated.
|
AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonCognitoIdentityAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, getPrincipalTagAttributeMap, listIdentities, listIdentityPools, listTagsForResource, lookupDeveloperIdentity, mergeDeveloperIdentities, setIdentityPoolRoles, setPrincipalTagAttributeMap, tagResource, unlinkDeveloperIdentity, unlinkIdentity, untagResource, updateIdentityPooladdRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, getPrincipalTagAttributeMap, listIdentities, listIdentityPools, listTagsForResource, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setPrincipalTagAttributeMap, setRegion, tagResource, unlinkDeveloperIdentity, unlinkIdentity, untagResource, updateIdentityPool@Deprecated public AmazonCognitoIdentityAsyncClient()
AmazonCognitoIdentityAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonCognitoIdentityAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity (ex:
proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonCognitoIdentityAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest request)
AmazonCognitoIdentityAsync
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.
createIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the CreateIdentityPool action.public Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest request, AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler)
AmazonCognitoIdentityAsync
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.
createIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest request)
AmazonCognitoIdentityAsyncDeletes 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.
deleteIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the DeleteIdentities action.public Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest request, AsyncHandler<DeleteIdentitiesRequest,DeleteIdentitiesResult> asyncHandler)
AmazonCognitoIdentityAsyncDeletes 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.
deleteIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<DeleteIdentityPoolResult> deleteIdentityPoolAsync(DeleteIdentityPoolRequest request)
AmazonCognitoIdentityAsyncDeletes 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.
deleteIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the DeleteIdentityPool action.public Future<DeleteIdentityPoolResult> deleteIdentityPoolAsync(DeleteIdentityPoolRequest request, AsyncHandler<DeleteIdentityPoolRequest,DeleteIdentityPoolResult> asyncHandler)
AmazonCognitoIdentityAsyncDeletes 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.
deleteIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest request)
AmazonCognitoIdentityAsyncReturns 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.
describeIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the DescribeIdentity action.public Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest request, AsyncHandler<DescribeIdentityRequest,DescribeIdentityResult> asyncHandler)
AmazonCognitoIdentityAsyncReturns 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.
describeIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest request)
AmazonCognitoIdentityAsyncGets 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.
describeIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the DescribeIdentityPool action.public Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest request, AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler)
AmazonCognitoIdentityAsyncGets 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.
describeIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request)
AmazonCognitoIdentityAsyncReturns 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.
getCredentialsForIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the GetCredentialsForIdentity action.public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request, AsyncHandler<GetCredentialsForIdentityRequest,GetCredentialsForIdentityResult> asyncHandler)
AmazonCognitoIdentityAsyncReturns 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.
getCredentialsForIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetIdResult> getIdAsync(GetIdRequest request)
AmazonCognitoIdentityAsyncGenerates (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.
getIdAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the GetId action.public Future<GetIdResult> getIdAsync(GetIdRequest request, AsyncHandler<GetIdRequest,GetIdResult> asyncHandler)
AmazonCognitoIdentityAsyncGenerates (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.
getIdAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request)
AmazonCognitoIdentityAsyncGets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the GetIdentityPoolRoles action.public Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request, AsyncHandler<GetIdentityPoolRolesRequest,GetIdentityPoolRolesResult> asyncHandler)
AmazonCognitoIdentityAsyncGets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest request)
AmazonCognitoIdentityAsyncGets 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.
getOpenIdTokenAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the GetOpenIdToken action.public Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest request, AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler)
AmazonCognitoIdentityAsyncGets 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.
getOpenIdTokenAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request)
AmazonCognitoIdentityAsync
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.
getOpenIdTokenForDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the GetOpenIdTokenForDeveloperIdentity action.public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request, AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,GetOpenIdTokenForDeveloperIdentityResult> asyncHandler)
AmazonCognitoIdentityAsync
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.
getOpenIdTokenForDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<GetPrincipalTagAttributeMapResult> getPrincipalTagAttributeMapAsync(GetPrincipalTagAttributeMapRequest request)
AmazonCognitoIdentityAsync
Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes.
getPrincipalTagAttributeMapAsync in interface AmazonCognitoIdentityAsyncpublic Future<GetPrincipalTagAttributeMapResult> getPrincipalTagAttributeMapAsync(GetPrincipalTagAttributeMapRequest request, AsyncHandler<GetPrincipalTagAttributeMapRequest,GetPrincipalTagAttributeMapResult> asyncHandler)
AmazonCognitoIdentityAsync
Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes.
getPrincipalTagAttributeMapAsync in interface AmazonCognitoIdentityAsyncasyncHandler - 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.public Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest request)
AmazonCognitoIdentityAsyncLists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
listIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the ListIdentities action.public Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest request, AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler)
AmazonCognitoIdentityAsyncLists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
listIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest request)
AmazonCognitoIdentityAsyncLists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
listIdentityPoolsAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the ListIdentityPools action.public Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest request, AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler)
AmazonCognitoIdentityAsyncLists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
listIdentityPoolsAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonCognitoIdentityAsyncLists 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.
listTagsForResourceAsync in interface AmazonCognitoIdentityAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonCognitoIdentityAsyncLists 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.
listTagsForResourceAsync in interface AmazonCognitoIdentityAsyncasyncHandler - 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.public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request)
AmazonCognitoIdentityAsync
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.
lookupDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the LookupDeveloperIdentityInput action.public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request, AsyncHandler<LookupDeveloperIdentityRequest,LookupDeveloperIdentityResult> asyncHandler)
AmazonCognitoIdentityAsync
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.
lookupDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request)
AmazonCognitoIdentityAsync
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.
mergeDeveloperIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the MergeDeveloperIdentities action.public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request, AsyncHandler<MergeDeveloperIdentitiesRequest,MergeDeveloperIdentitiesResult> asyncHandler)
AmazonCognitoIdentityAsync
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.
mergeDeveloperIdentitiesAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request)
AmazonCognitoIdentityAsyncSets 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.
setIdentityPoolRolesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the SetIdentityPoolRoles action.public Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request, AsyncHandler<SetIdentityPoolRolesRequest,SetIdentityPoolRolesResult> asyncHandler)
AmazonCognitoIdentityAsyncSets 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.
setIdentityPoolRolesAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<SetPrincipalTagAttributeMapResult> setPrincipalTagAttributeMapAsync(SetPrincipalTagAttributeMapRequest request)
AmazonCognitoIdentityAsyncYou can use this operation to use default (username and clientID) attribute or custom attribute mappings.
setPrincipalTagAttributeMapAsync in interface AmazonCognitoIdentityAsyncpublic Future<SetPrincipalTagAttributeMapResult> setPrincipalTagAttributeMapAsync(SetPrincipalTagAttributeMapRequest request, AsyncHandler<SetPrincipalTagAttributeMapRequest,SetPrincipalTagAttributeMapResult> asyncHandler)
AmazonCognitoIdentityAsyncYou can use this operation to use default (username and clientID) attribute or custom attribute mappings.
setPrincipalTagAttributeMapAsync in interface AmazonCognitoIdentityAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonCognitoIdentityAsyncAssigns 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.
tagResourceAsync in interface AmazonCognitoIdentityAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonCognitoIdentityAsyncAssigns 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.
tagResourceAsync in interface AmazonCognitoIdentityAsyncasyncHandler - 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.public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request)
AmazonCognitoIdentityAsync
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.
unlinkDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the UnlinkDeveloperIdentity action.public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request, AsyncHandler<UnlinkDeveloperIdentityRequest,UnlinkDeveloperIdentityResult> asyncHandler)
AmazonCognitoIdentityAsync
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.
unlinkDeveloperIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<UnlinkIdentityResult> unlinkIdentityAsync(UnlinkIdentityRequest request)
AmazonCognitoIdentityAsyncUnlinks 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.
unlinkIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the UnlinkIdentity action.public Future<UnlinkIdentityResult> unlinkIdentityAsync(UnlinkIdentityRequest request, AsyncHandler<UnlinkIdentityRequest,UnlinkIdentityResult> asyncHandler)
AmazonCognitoIdentityAsyncUnlinks 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.
unlinkIdentityAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonCognitoIdentityAsyncRemoves the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
untagResourceAsync in interface AmazonCognitoIdentityAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonCognitoIdentityAsyncRemoves the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
untagResourceAsync in interface AmazonCognitoIdentityAsyncasyncHandler - 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.public Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest request)
AmazonCognitoIdentityAsyncUpdates an identity pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - An object representing an Amazon Cognito identity pool.public Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest request, AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler)
AmazonCognitoIdentityAsyncUpdates an identity pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonCognitoIdentityshutdown in class AmazonCognitoIdentityClient