Class AmazonCognitoIdentityAsyncClient
- All Implemented Interfaces:
AmazonCognitoIdentity
,AmazonCognitoIdentityAsync
AsyncHandler
can be
used to receive notification when an asynchronous operation completes.
Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId.
If the end user is authenticated with one of the supported identity
providers, set the Logins
map with the identity provider token.
GetId
returns a unique identifier for the user.
Next, make an unsigned call to GetCredentialsForIdentity. This call
expects the same Logins
map as the GetId
call, as
well as the IdentityID
originally returned by GetId
. Assuming your identity pool has been configured via the
SetIdentityPoolRoles operation, GetCredentialsForIdentity
will return AWS credentials for your use. If your pool has not been
configured with SetIdentityPoolRoles
, or if you want to follow
legacy flow, make an unsigned call to GetOpenIdToken, which returns
the OpenID token necessary to call STS and retrieve AWS credentials. This
call expects the same Logins
map as the GetId
call,
as well as the IdentityID
originally returned by
GetId
. The token returned by GetOpenIdToken
can be
passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.
-
Field Summary
Fields inherited from class com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityClient
configFactory
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new asynchronous client to invoke service methods on Amazon Cognito Identity.AmazonCognitoIdentityAsyncClient
(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials.AmazonCognitoIdentityAsyncClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider.AmazonCognitoIdentityAsyncClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the provided AWS account credentials provider and client configuration options.AmazonCognitoIdentityAsyncClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider, executor service, and client configuration options.AmazonCognitoIdentityAsyncClient
(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider and executor service.AmazonCognitoIdentityAsyncClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials, executor service, and client configuration options.AmazonCognitoIdentityAsyncClient
(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials and executor service.AmazonCognitoIdentityAsyncClient
(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity. -
Method Summary
Modifier and TypeMethodDescriptionCreates a new identity pool.createIdentityPoolAsync
(CreateIdentityPoolRequest request, AsyncHandler<CreateIdentityPoolRequest, CreateIdentityPoolResult> asyncHandler) Creates a new identity pool.Deletes identities from an identity pool.deleteIdentitiesAsync
(DeleteIdentitiesRequest request, AsyncHandler<DeleteIdentitiesRequest, DeleteIdentitiesResult> asyncHandler) Deletes identities from an identity pool.Deletes a user pool.deleteIdentityPoolAsync
(DeleteIdentityPoolRequest request, AsyncHandler<DeleteIdentityPoolRequest, DeleteIdentityPoolResult> asyncHandler) Deletes a user pool.Returns metadata related to the given identity, including when the identity was created and any associated linked logins.describeIdentityAsync
(DescribeIdentityRequest request, AsyncHandler<DescribeIdentityRequest, DescribeIdentityResult> asyncHandler) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.describeIdentityPoolAsync
(DescribeIdentityPoolRequest request, AsyncHandler<DescribeIdentityPoolRequest, DescribeIdentityPoolResult> asyncHandler) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.Returns credentials for the provided identity ID.getCredentialsForIdentityAsync
(GetCredentialsForIdentityRequest request, AsyncHandler<GetCredentialsForIdentityRequest, GetCredentialsForIdentityResult> asyncHandler) Returns credentials for the provided identity ID.Returns the executor service used by this client to execute async requests.getIdAsync
(GetIdRequest request) Generates (or retrieves) a Cognito ID.getIdAsync
(GetIdRequest request, AsyncHandler<GetIdRequest, GetIdResult> asyncHandler) Generates (or retrieves) a Cognito ID.Gets the roles for an identity pool.getIdentityPoolRolesAsync
(GetIdentityPoolRolesRequest request, AsyncHandler<GetIdentityPoolRolesRequest, GetIdentityPoolRolesResult> asyncHandler) Gets the roles for an identity pool.getOpenIdTokenAsync
(GetOpenIdTokenRequest request) Gets an OpenID token, using a known Cognito ID.getOpenIdTokenAsync
(GetOpenIdTokenRequest request, AsyncHandler<GetOpenIdTokenRequest, GetOpenIdTokenResult> asyncHandler) Gets an OpenID token, using a known Cognito ID.Registers (or retrieves) a CognitoIdentityId
and an OpenID Connect token for a user authenticated by your backend authentication process.getOpenIdTokenForDeveloperIdentityAsync
(GetOpenIdTokenForDeveloperIdentityRequest request, AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest, GetOpenIdTokenForDeveloperIdentityResult> asyncHandler) Registers (or retrieves) a CognitoIdentityId
and an OpenID Connect token for a user authenticated by your backend authentication process.listIdentitiesAsync
(ListIdentitiesRequest request) Lists the identities in a pool.listIdentitiesAsync
(ListIdentitiesRequest request, AsyncHandler<ListIdentitiesRequest, ListIdentitiesResult> asyncHandler) Lists the identities in a pool.Lists all of the Cognito identity pools registered for your account.listIdentityPoolsAsync
(ListIdentityPoolsRequest request, AsyncHandler<ListIdentityPoolsRequest, ListIdentityPoolsResult> asyncHandler) Lists all of the Cognito identity pools registered for your account.Retrieves theIdentityID
associated with aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
s associated with anIdentityId
for an existing identity.lookupDeveloperIdentityAsync
(LookupDeveloperIdentityRequest request, AsyncHandler<LookupDeveloperIdentityRequest, LookupDeveloperIdentityResult> asyncHandler) Retrieves theIdentityID
associated with aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
s associated with anIdentityId
for an existing identity.Merges two users having differentIdentityId
s, existing in the same identity pool, and identified by the same developer provider.mergeDeveloperIdentitiesAsync
(MergeDeveloperIdentitiesRequest request, AsyncHandler<MergeDeveloperIdentitiesRequest, MergeDeveloperIdentitiesResult> asyncHandler) Merges two users having differentIdentityId
s, existing in the same identity pool, and identified by the same developer provider.Sets the roles for an identity pool.setIdentityPoolRolesAsync
(SetIdentityPoolRolesRequest request, AsyncHandler<SetIdentityPoolRolesRequest, SetIdentityPoolRolesResult> asyncHandler) Sets the roles for an identity pool.void
shutdown()
Shuts down the client, releasing all managed resources.Unlinks aDeveloperUserIdentifier
from an existing identity.unlinkDeveloperIdentityAsync
(UnlinkDeveloperIdentityRequest request, AsyncHandler<UnlinkDeveloperIdentityRequest, UnlinkDeveloperIdentityResult> asyncHandler) Unlinks aDeveloperUserIdentifier
from an existing identity.unlinkIdentityAsync
(UnlinkIdentityRequest request) Unlinks a federated identity from an existing account.unlinkIdentityAsync
(UnlinkIdentityRequest request, AsyncHandler<UnlinkIdentityRequest, UnlinkIdentityResult> asyncHandler) Unlinks a federated identity from an existing account.Updates a user pool.updateIdentityPoolAsync
(UpdateIdentityPoolRequest request, AsyncHandler<UpdateIdentityPoolRequest, UpdateIdentityPoolResult> asyncHandler) Updates a user pool.Methods inherited from class com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityClient
createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, lookupDeveloperIdentity, mergeDeveloperIdentities, setIdentityPoolRoles, unlinkDeveloperIdentity, unlinkIdentity, updateIdentityPool
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity
createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setRegion, unlinkDeveloperIdentity, unlinkIdentity, updateIdentityPool
-
Constructor Details
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient()Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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).
-
AmazonCognitoIdentityAsyncClient
Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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()
.- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity (ex: proxy settings, retry counts, etc).- See Also:
-
AmazonCognitoIdentityAsyncClient
Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials.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).
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.- See Also:
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials and executor service. Default client settings will be used.- Parameters:
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.
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials, executor service, and client configuration options.- Parameters:
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.
-
AmazonCognitoIdentityAsyncClient
Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider. Default client settings will be used.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).
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.- See Also:
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the provided AWS account credentials provider and client configuration options.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()
.- Parameters:
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).- See Also:
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider and executor service. Default client settings will be used.- Parameters:
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.
-
AmazonCognitoIdentityAsyncClient
public AmazonCognitoIdentityAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider, executor service, and client configuration options.- Parameters:
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.
-
-
Method Details
-
getExecutorService
Returns the executor service used by this client to execute async requests.- Returns:
- The executor service used by this client to execute async requests.
-
createIdentityPoolAsync
Description copied from interface:AmazonCognitoIdentityAsync
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per 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
- Specified by:
createIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the CreateIdentityPool action.- Returns:
- A Java Future containing the result of the CreateIdentityPool operation returned by the service.
- Facebook:
-
createIdentityPoolAsync
public Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest request, AsyncHandler<CreateIdentityPoolRequest, CreateIdentityPoolResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per 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
- Specified by:
createIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
- Facebook:
-
deleteIdentitiesAsync
Description copied from interface:AmazonCognitoIdentityAsync
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
- Specified by:
deleteIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theDeleteIdentities
action.- Returns:
- A Java Future containing the result of the DeleteIdentities operation returned by the service.
-
deleteIdentitiesAsync
public Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest request, AsyncHandler<DeleteIdentitiesRequest, DeleteIdentitiesResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
- Specified by:
deleteIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theDeleteIdentities
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.
-
deleteIdentityPoolAsync
Description copied from interface:AmazonCognitoIdentityAsync
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
- Specified by:
deleteIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the DeleteIdentityPool action.- Returns:
- A Java Future containing the result of the DeleteIdentityPool operation returned by the service.
-
deleteIdentityPoolAsync
public Future<DeleteIdentityPoolResult> deleteIdentityPoolAsync(DeleteIdentityPoolRequest request, AsyncHandler<DeleteIdentityPoolRequest, DeleteIdentityPoolResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
- Specified by:
deleteIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
describeIdentityAsync
Description copied from interface:AmazonCognitoIdentityAsync
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
- Specified by:
describeIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theDescribeIdentity
action.- Returns:
- A Java Future containing the result of the DescribeIdentity operation returned by the service.
-
describeIdentityAsync
public Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest request, AsyncHandler<DescribeIdentityRequest, DescribeIdentityResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
- Specified by:
describeIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theDescribeIdentity
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.
-
describeIdentityPoolAsync
public Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
- Specified by:
describeIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the DescribeIdentityPool action.- Returns:
- A Java Future containing the result of the DescribeIdentityPool operation returned by the service.
-
describeIdentityPoolAsync
public Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest request, AsyncHandler<DescribeIdentityPoolRequest, DescribeIdentityPoolResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
- Specified by:
describeIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
getCredentialsForIdentityAsync
public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getCredentialsForIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetCredentialsForIdentity
action.- Returns:
- A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
-
getCredentialsForIdentityAsync
public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request, AsyncHandler<GetCredentialsForIdentityRequest, GetCredentialsForIdentityResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getCredentialsForIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetCredentialsForIdentity
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.
-
getIdAsync
Description copied from interface:AmazonCognitoIdentityAsync
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getIdAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the GetId action.- Returns:
- A Java Future containing the result of the GetId operation returned by the service.
-
getIdAsync
public Future<GetIdResult> getIdAsync(GetIdRequest request, AsyncHandler<GetIdRequest, GetIdResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getIdAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
getIdentityPoolRolesAsync
public Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
- Specified by:
getIdentityPoolRolesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetIdentityPoolRoles
action.- Returns:
- A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.
-
getIdentityPoolRolesAsync
public Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request, AsyncHandler<GetIdentityPoolRolesRequest, GetIdentityPoolRolesResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
- Specified by:
getIdentityPoolRolesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetIdentityPoolRoles
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.
-
getOpenIdTokenAsync
Description copied from interface:AmazonCognitoIdentityAsync
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getOpenIdTokenAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the GetOpenIdToken action.- Returns:
- A Java Future containing the result of the GetOpenIdToken operation returned by the service.
-
getOpenIdTokenAsync
public Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest request, AsyncHandler<GetOpenIdTokenRequest, GetOpenIdTokenResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
This is a public API. You do not need any credentials to call this API.
- Specified by:
getOpenIdTokenAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
getOpenIdTokenForDeveloperIdentityAsync
public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request) Description copied from interface: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 theLogins
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, theIdentityId
should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existingIdentityId
. This API will create the identity in the specifiedIdentityPoolId
.You must use AWS Developer credentials to call this API.
- Specified by:
getOpenIdTokenForDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetOpenIdTokenForDeveloperIdentity
action.- Returns:
- A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
-
getOpenIdTokenForDeveloperIdentityAsync
public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request, AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest, GetOpenIdTokenForDeveloperIdentityResult> asyncHandler) Description copied from interface: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 theLogins
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, theIdentityId
should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existingIdentityId
. This API will create the identity in the specifiedIdentityPoolId
.You must use AWS Developer credentials to call this API.
- Specified by:
getOpenIdTokenForDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theGetOpenIdTokenForDeveloperIdentity
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.
-
listIdentitiesAsync
Description copied from interface:AmazonCognitoIdentityAsync
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
- Specified by:
listIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the ListIdentities action.- Returns:
- A Java Future containing the result of the ListIdentities operation returned by the service.
-
listIdentitiesAsync
public Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest request, AsyncHandler<ListIdentitiesRequest, ListIdentitiesResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
- Specified by:
listIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
listIdentityPoolsAsync
Description copied from interface:AmazonCognitoIdentityAsync
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
- Specified by:
listIdentityPoolsAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the ListIdentityPools action.- Returns:
- A Java Future containing the result of the ListIdentityPools operation returned by the service.
-
listIdentityPoolsAsync
public Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest request, AsyncHandler<ListIdentityPoolsRequest, ListIdentityPoolsResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
- Specified by:
listIdentityPoolsAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
lookupDeveloperIdentityAsync
public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Retrieves the
IdentityID
associated with aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
s associated with anIdentityId
for an existing identity. EitherIdentityID
orDeveloperUserIdentifier
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 againstIdentityID
. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise aResourceConflictException
is thrown.You must use AWS Developer credentials to call this API.
- Specified by:
lookupDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theLookupDeveloperIdentityInput
action.- Returns:
- A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
-
lookupDeveloperIdentityAsync
public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request, AsyncHandler<LookupDeveloperIdentityRequest, LookupDeveloperIdentityResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Retrieves the
IdentityID
associated with aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
s associated with anIdentityId
for an existing identity. EitherIdentityID
orDeveloperUserIdentifier
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 againstIdentityID
. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise aResourceConflictException
is thrown.You must use AWS Developer credentials to call this API.
- Specified by:
lookupDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theLookupDeveloperIdentityInput
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.
-
mergeDeveloperIdentitiesAsync
public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Merges two users having different
IdentityId
s, 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 theIdentityId
of theDestinationUserIdentifier
. 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.You must use AWS Developer credentials to call this API.
- Specified by:
mergeDeveloperIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theMergeDeveloperIdentities
action.- Returns:
- A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
-
mergeDeveloperIdentitiesAsync
public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request, AsyncHandler<MergeDeveloperIdentitiesRequest, MergeDeveloperIdentitiesResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Merges two users having different
IdentityId
s, 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 theIdentityId
of theDestinationUserIdentifier
. 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.You must use AWS Developer credentials to call this API.
- Specified by:
mergeDeveloperIdentitiesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theMergeDeveloperIdentities
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.
-
setIdentityPoolRolesAsync
public Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request) Description copied from interface:AmazonCognitoIdentityAsync
Sets the roles for an identity pool. These roles are used when making calls to
GetCredentialsForIdentity
action.You must use AWS Developer credentials to call this API.
- Specified by:
setIdentityPoolRolesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theSetIdentityPoolRoles
action.- Returns:
- A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.
-
setIdentityPoolRolesAsync
public Future<SetIdentityPoolRolesResult> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request, AsyncHandler<SetIdentityPoolRolesRequest, SetIdentityPoolRolesResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Sets the roles for an identity pool. These roles are used when making calls to
GetCredentialsForIdentity
action.You must use AWS Developer credentials to call this API.
- Specified by:
setIdentityPoolRolesAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theSetIdentityPoolRoles
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.
-
unlinkDeveloperIdentityAsync
public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request) Description copied from interface: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.
- Specified by:
unlinkDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theUnlinkDeveloperIdentity
action.- Returns:
- A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
-
unlinkDeveloperIdentityAsync
public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request, AsyncHandler<UnlinkDeveloperIdentityRequest, UnlinkDeveloperIdentityResult> asyncHandler) Description copied from interface: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.
- Specified by:
unlinkDeveloperIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to theUnlinkDeveloperIdentity
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.
-
unlinkIdentityAsync
Description copied from interface:AmazonCognitoIdentityAsync
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
- Specified by:
unlinkIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- Input to the UnlinkIdentity action.- Returns:
- A Java Future containing the result of the UnlinkIdentity operation returned by the service.
-
unlinkIdentityAsync
public Future<UnlinkIdentityResult> unlinkIdentityAsync(UnlinkIdentityRequest request, AsyncHandler<UnlinkIdentityRequest, UnlinkIdentityResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
- Specified by:
unlinkIdentityAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- 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.
-
updateIdentityPoolAsync
Description copied from interface:AmazonCognitoIdentityAsync
Updates a user pool.
You must use AWS Developer credentials to call this API.
- Specified by:
updateIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- An object representing a Cognito identity pool.- Returns:
- A Java Future containing the result of the UpdateIdentityPool operation returned by the service.
-
updateIdentityPoolAsync
public Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest request, AsyncHandler<UpdateIdentityPoolRequest, UpdateIdentityPoolResult> asyncHandler) Description copied from interface:AmazonCognitoIdentityAsync
Updates a user pool.
You must use AWS Developer credentials to call this API.
- Specified by:
updateIdentityPoolAsync
in interfaceAmazonCognitoIdentityAsync
- Parameters:
request
- An object representing a 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.
-
shutdown
public void shutdown()Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should callgetExecutorService().shutdown()
followed bygetExecutorService().awaitTermination()
prior to calling this method.- Specified by:
shutdown
in interfaceAmazonCognitoIdentity
- Overrides:
shutdown
in classAmazonWebServiceClient
-