public interface AmazonCognitoIdentityAsync extends AmazonCognitoIdentity
Amazon Cognito is a web service that facilitates the delivery of scoped, temporary credentials to mobile devices or other untrusted environments. Amazon Cognito uniquely identifies a device or user and supplies the user with a consistent identity throughout the lifetime of an application.
Amazon Cognito lets users authenticate with third-party identity providers (Facebook, Google, or Login with Amazon). As a developer, you decide which identity providers to trust. You can also choose to support unauthenticated access from your application. Your users are provided with Cognito tokens that uniquely identify their device and any information provided about third-party logins.
createIdentityPool, deleteIdentityPool, describeIdentityPool, getCachedResponseMetadata, getId, getOpenIdToken, listIdentities, listIdentityPools, setEndpoint, setRegion, shutdown, unlinkIdentity, updateIdentityPool
Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest) throws AmazonServiceException, AmazonClientException
Lists all of the Cognito identity pools registered for your account.
listIdentityPoolsRequest
- Container for the necessary parameters
to execute the ListIdentityPools operation on AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest, AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists all of the Cognito identity pools registered for your account.
listIdentityPoolsRequest
- Container for the necessary parameters
to execute the ListIdentityPools operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest) throws AmazonServiceException, AmazonClientException
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned from GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
getOpenIdTokenRequest
- Container for the necessary parameters to
execute the GetOpenIdToken operation on AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest, AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned from GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
getOpenIdTokenRequest
- Container for the necessary parameters to
execute the GetOpenIdToken operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<Void> unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest) throws AmazonServiceException, AmazonClientException
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.
unlinkIdentityRequest
- Container for the necessary parameters to
execute the UnlinkIdentity operation on AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<Void> unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest, AsyncHandler<UnlinkIdentityRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
unlinkIdentityRequest
- Container for the necessary parameters to
execute the UnlinkIdentity operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
describeIdentityPoolRequest
- Container for the necessary
parameters to execute the DescribeIdentityPool operation on
AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest, AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
describeIdentityPoolRequest
- Container for the necessary
parameters to execute the DescribeIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest) throws AmazonServiceException, AmazonClientException
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
getIdRequest
- Container for the necessary parameters to execute
the GetId operation on AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest, AsyncHandler<GetIdRequest,GetIdResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
getIdRequest
- Container for the necessary parameters to execute
the GetId operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
deleteIdentityPoolRequest
- Container for the necessary
parameters to execute the DeleteIdentityPool operation on
AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest, AsyncHandler<DeleteIdentityPoolRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
deleteIdentityPoolRequest
- Container for the necessary
parameters to execute the DeleteIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest) throws AmazonServiceException, AmazonClientException
Lists the identities in a pool.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities operation on AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest, AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the identities in a pool.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Updates a user pool.
updateIdentityPoolRequest
- Container for the necessary
parameters to execute the UpdateIdentityPool operation on
AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest, AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Updates a user pool.
updateIdentityPoolRequest
- Container for the necessary
parameters to execute the UpdateIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account.
createIdentityPoolRequest
- Container for the necessary
parameters to execute the CreateIdentityPool operation on
AmazonCognitoIdentity.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest, AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account.
createIdentityPoolRequest
- Container for the necessary
parameters to execute the CreateIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCognitoIdentity indicating
either a problem with the data in the request, or a server side issue.Copyright © 2014. All rights reserved.