Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.cognitoidentity;
  
  
Interface for accessing AmazonCognitoIdentity asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. Amazon Cognito

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 .

  
  public interface AmazonCognitoIdentityAsync extends AmazonCognitoIdentity {
    

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.

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

Parameters:
unlinkDeveloperIdentityRequest Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the UnlinkDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoidunlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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

Parameters:
unlinkDeveloperIdentityRequest Container for the necessary parameters to execute the UnlinkDeveloperIdentity 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.
Returns:
A Java Future object containing the response from the UnlinkDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoidunlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest,
             AsyncHandler<UnlinkDeveloperIdentityRequestVoidasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Parameters:
deleteIdentitiesRequest Container for the necessary parameters to execute the DeleteIdentities operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the DeleteIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DeleteIdentitiesResultdeleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Parameters:
deleteIdentitiesRequest Container for the necessary parameters to execute the DeleteIdentities 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.
Returns:
A Java Future object containing the response from the DeleteIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<DeleteIdentitiesRequestDeleteIdentitiesResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Parameters:
describeIdentityPoolRequest Container for the necessary parameters to execute the DescribeIdentityPool operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the DescribeIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Parameters:
describeIdentityPoolRequest 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.
Returns:
A Java Future object containing the response from the DescribeIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<DescribeIdentityPoolRequestDescribeIdentityPoolResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

token+";"+tokenSecret.

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

Parameters:
getIdRequest Container for the necessary parameters to execute the GetId operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the GetId service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<GetIdResultgetIdAsync(GetIdRequest getIdRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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

token+";"+tokenSecret.

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

Parameters:
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.
Returns:
A Java Future object containing the response from the GetId service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<GetIdResultgetIdAsync(GetIdRequest getIdRequest,
             AsyncHandler<GetIdRequestGetIdResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
deleteIdentityPoolRequest Container for the necessary parameters to execute the DeleteIdentityPool operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the DeleteIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoiddeleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
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.
Returns:
A Java Future object containing the response from the DeleteIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoiddeleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest,
             AsyncHandler<DeleteIdentityPoolRequestVoidasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Updates a user pool.

You must use AWS Developer credentials to call this API.

Parameters:
updateIdentityPoolRequest Container for the necessary parameters to execute the UpdateIdentityPool operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the UpdateIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Updates a user pool.

You must use AWS Developer credentials to call this API.

Parameters:
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.
Returns:
A Java Future object containing the response from the UpdateIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<UpdateIdentityPoolRequestUpdateIdentityPoolResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
getCredentialsForIdentityRequest Container for the necessary parameters to execute the GetCredentialsForIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the GetCredentialsForIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
getCredentialsForIdentityRequest Container for the necessary parameters to execute the GetCredentialsForIdentity 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.
Returns:
A Java Future object containing the response from the GetCredentialsForIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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 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.

Parameters:
mergeDeveloperIdentitiesRequest Container for the necessary parameters to execute the MergeDeveloperIdentities operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the MergeDeveloperIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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 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.

Parameters:
mergeDeveloperIdentitiesRequest Container for the necessary parameters to execute the MergeDeveloperIdentities 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.
Returns:
A Java Future object containing the response from the MergeDeveloperIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
listIdentityPoolsRequest Container for the necessary parameters to execute the ListIdentityPools operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the ListIdentityPools service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<ListIdentityPoolsResultlistIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
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.
Returns:
A Java Future object containing the response from the ListIdentityPools service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<ListIdentityPoolsRequestListIdentityPoolsResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
getOpenIdTokenRequest Container for the necessary parameters to execute the GetOpenIdToken operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the GetOpenIdToken service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<GetOpenIdTokenResultgetOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
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.
Returns:
A Java Future object containing the response from the GetOpenIdToken service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<GetOpenIdTokenResultgetOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest,
             AsyncHandler<GetOpenIdTokenRequestGetOpenIdTokenResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s 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.

Parameters:
lookupDeveloperIdentityRequest Container for the necessary parameters to execute the LookupDeveloperIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the LookupDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s 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.

Parameters:
lookupDeveloperIdentityRequest Container for the necessary parameters to execute the LookupDeveloperIdentity 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.
Returns:
A Java Future object containing the response from the LookupDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Parameters:
describeIdentityRequest Container for the necessary parameters to execute the DescribeIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the DescribeIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DescribeIdentityResultdescribeIdentityAsync(DescribeIdentityRequest describeIdentityRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Parameters:
describeIdentityRequest Container for the necessary parameters to execute the DescribeIdentity 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.
Returns:
A Java Future object containing the response from the DescribeIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<DescribeIdentityRequestDescribeIdentityResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Parameters:
setIdentityPoolRolesRequest Container for the necessary parameters to execute the SetIdentityPoolRoles operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the SetIdentityPoolRoles service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoidsetIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Parameters:
setIdentityPoolRolesRequest Container for the necessary parameters to execute the SetIdentityPoolRoles 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.
Returns:
A Java Future object containing the response from the SetIdentityPoolRoles service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoidsetIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest,
             AsyncHandler<SetIdentityPoolRolesRequestVoidasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

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

Parameters:
unlinkIdentityRequest Container for the necessary parameters to execute the UnlinkIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the UnlinkIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
 
     public Future<VoidunlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

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

Parameters:
unlinkIdentityRequest 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.
Returns:
A Java Future object containing the response from the UnlinkIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
    public Future<VoidunlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest,
            AsyncHandler<UnlinkIdentityRequestVoidasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Parameters:
listIdentitiesRequest Container for the necessary parameters to execute the ListIdentities operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the ListIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
    public Future<ListIdentitiesResultlistIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Parameters:
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.
Returns:
A Java Future object containing the response from the ListIdentities service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<ListIdentitiesRequestListIdentitiesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:
getIdentityPoolRolesRequest Container for the necessary parameters to execute the GetIdentityPoolRoles operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the GetIdentityPoolRoles service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:
getIdentityPoolRolesRequest Container for the necessary parameters to execute the GetIdentityPoolRoles 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.
Returns:
A Java Future object containing the response from the GetIdentityPoolRoles service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId . This API will create the identity in the specified IdentityPoolId .

You must use AWS Developer credentials to call this API.

Parameters:
getOpenIdTokenForDeveloperIdentityRequest Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId . This API will create the identity in the specified IdentityPoolId .

You must use AWS Developer credentials to call this API.

Parameters:
getOpenIdTokenForDeveloperIdentityRequest Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity 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.
Returns:
A Java Future object containing the response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

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. You must use AWS Developer credentials to call this API.

Parameters:
createIdentityPoolRequest Container for the necessary parameters to execute the CreateIdentityPool operation on AmazonCognitoIdentity.
Returns:
A Java Future object containing the response from the CreateIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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. You must use AWS Developer credentials to call this API.

Parameters:
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.
Returns:
A Java Future object containing the response from the CreateIdentityPool service method, as returned by AmazonCognitoIdentity.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<CreateIdentityPoolRequestCreateIdentityPoolResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;
}
        
New to GrepCode? Check out our FAQ X