public class AbstractAmazonCognitoIdentityAsync extends AbstractAmazonCognitoIdentity implements AmazonCognitoIdentityAsync
AmazonCognitoIdentityAsync. Convenient
method forms pass through to the corresponding overload that takes a request
object and an AsyncHandler, which throws an
UnsupportedOperationException.| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonCognitoIdentityAsync() |
createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setRegion, shutdown, unlinkDeveloperIdentity, unlinkIdentity, updateIdentityPoolclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setRegion, shutdown, unlinkDeveloperIdentity, unlinkIdentity, updateIdentityPoolprotected AbstractAmazonCognitoIdentityAsync()
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 limit on
identity pools is 60 per account. The keys for
SupportedLoginProviders are as follows:
graph.facebook.comaccounts.google.comwww.amazon.comapi.twitter.comwww.digits.comcreateIdentityPoolAsync 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 limit on
identity pools is 60 per account. The keys for
SupportedLoginProviders are as follows:
graph.facebook.comaccounts.google.comwww.amazon.comapi.twitter.comwww.digits.comcreateIdentityPoolAsync 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<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest request)
AmazonCognitoIdentityAsyncDeletes 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.
deleteIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the DeleteIdentityPool action.public Future<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest request, AsyncHandler<DeleteIdentityPoolRequest,Void> asyncHandler)
AmazonCognitoIdentityAsyncDeletes 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.
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 15 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 15 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<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest request)
AmazonCognitoIdentityAsyncLists the identities in a 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 a 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<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request)
AmazonCognitoIdentityAsync
Retrieves the IdentityID associated with a
DeveloperUserIdentifier or the list of
DeveloperUserIdentifiers 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.
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
DeveloperUserIdentifiers 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.
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.
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.
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<Void> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request)
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.
setIdentityPoolRolesAsync in interface AmazonCognitoIdentityAsyncrequest - Input to the SetIdentityPoolRoles action.public Future<Void> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request, AsyncHandler<SetIdentityPoolRolesRequest,Void> asyncHandler)
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.
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<Void> 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<Void> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request, AsyncHandler<UnlinkDeveloperIdentityRequest,Void> 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<Void> 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<Void> unlinkIdentityAsync(UnlinkIdentityRequest request, AsyncHandler<UnlinkIdentityRequest,Void> 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<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest request)
AmazonCognitoIdentityAsyncUpdates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - An object representing a Cognito identity pool.public Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest request, AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler)
AmazonCognitoIdentityAsyncUpdates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolAsync in interface AmazonCognitoIdentityAsyncrequest - 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.Copyright © 2015. All rights reserved.