All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityAsync Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Cognito Identity module holds the client classes that are used for communicating with Amazon Cognito Identity Service

The newest version!
/*
 * Copyright 2019-2024 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;

import javax.annotation.Generated;

import com.amazonaws.services.cognitoidentity.model.*;

/**
 * Interface for accessing Amazon Cognito Identity asynchronously. Each asynchronous method will return a Java Future
 * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
 * notification when an asynchronous operation completes.
 * 

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.cognitoidentity.AbstractAmazonCognitoIdentityAsync} instead. *

*

* Amazon Cognito Federated Identities *

* Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and * other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over * the lifetime of an application. *

*

* Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity * providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support * unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token * provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials. *

*

* For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow. *

*

* For more information see Amazon Cognito Federated * Identities. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCognitoIdentityAsync extends AmazonCognitoIdentity { /** *

* Creates a new identity pool. The identity pool is a store of user identity information that is specific to your * AWS account. The keys for SupportedLoginProviders are as follows: *

*
    *
  • *

    * Facebook: graph.facebook.com *

    *
  • *
  • *

    * Google: accounts.google.com *

    *
  • *
  • *

    * Amazon: www.amazon.com *

    *
  • *
  • *

    * Twitter: api.twitter.com *

    *
  • *
  • *

    * Digits: www.digits.com *

    *
  • *
*

* You must use AWS Developer credentials to call this API. *

* * @param createIdentityPoolRequest * Input to the CreateIdentityPool action. * @return A Java Future containing the result of the CreateIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsync.CreateIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest); /** *

* Creates a new identity pool. The identity pool is a store of user identity information that is specific to your * AWS account. The keys for SupportedLoginProviders are as follows: *

*
    *
  • *

    * Facebook: graph.facebook.com *

    *
  • *
  • *

    * Google: accounts.google.com *

    *
  • *
  • *

    * Amazon: www.amazon.com *

    *
  • *
  • *

    * Twitter: api.twitter.com *

    *
  • *
  • *

    * Digits: www.digits.com *

    *
  • *
*

* You must use AWS Developer credentials to call this API. *

* * @param createIdentityPoolRequest * Input to the CreateIdentityPool action. * @param 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. * @return A Java Future containing the result of the CreateIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.CreateIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param deleteIdentitiesRequest * Input to the DeleteIdentities action. * @return A Java Future containing the result of the DeleteIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsync.DeleteIdentities * @see AWS API Documentation */ java.util.concurrent.Future deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest); /** *

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

* * @param deleteIdentitiesRequest * Input to the DeleteIdentities action. * @param 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. * @return A Java Future containing the result of the DeleteIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.DeleteIdentities * @see AWS API Documentation */ java.util.concurrent.Future deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param deleteIdentityPoolRequest * Input to the DeleteIdentityPool action. * @return A Java Future containing the result of the DeleteIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsync.DeleteIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest); /** *

* Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param deleteIdentityPoolRequest * Input to the DeleteIdentityPool action. * @param 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. * @return A Java Future containing the result of the DeleteIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.DeleteIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param describeIdentityRequest * Input to the DescribeIdentity action. * @return A Java Future containing the result of the DescribeIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsync.DescribeIdentity * @see AWS API Documentation */ java.util.concurrent.Future describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest); /** *

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

* * @param describeIdentityRequest * Input to the DescribeIdentity action. * @param 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. * @return A Java Future containing the result of the DescribeIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.DescribeIdentity * @see AWS API Documentation */ java.util.concurrent.Future describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param describeIdentityPoolRequest * Input to the DescribeIdentityPool action. * @return A Java Future containing the result of the DescribeIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsync.DescribeIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest); /** *

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

* * @param describeIdentityPoolRequest * Input to the DescribeIdentityPool action. * @param 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. * @return A Java Future containing the result of the DescribeIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.DescribeIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param getCredentialsForIdentityRequest * Input to the GetCredentialsForIdentity action. * @return A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsync.GetCredentialsForIdentity * @see AWS API Documentation */ java.util.concurrent.Future getCredentialsForIdentityAsync( GetCredentialsForIdentityRequest getCredentialsForIdentityRequest); /** *

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

* * @param getCredentialsForIdentityRequest * Input to the GetCredentialsForIdentity action. * @param 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. * @return A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.GetCredentialsForIdentity * @see AWS API Documentation */ java.util.concurrent.Future getCredentialsForIdentityAsync( GetCredentialsForIdentityRequest getCredentialsForIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param getIdRequest * Input to the GetId action. * @return A Java Future containing the result of the GetId operation returned by the service. * @sample AmazonCognitoIdentityAsync.GetId * @see AWS API * Documentation */ java.util.concurrent.Future getIdAsync(GetIdRequest getIdRequest); /** *

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

* * @param getIdRequest * Input to the GetId action. * @param 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. * @return A Java Future containing the result of the GetId operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.GetId * @see AWS API * Documentation */ java.util.concurrent.Future getIdAsync(GetIdRequest getIdRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets the roles for an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param getIdentityPoolRolesRequest * Input to the GetIdentityPoolRoles action. * @return A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service. * @sample AmazonCognitoIdentityAsync.GetIdentityPoolRoles * @see AWS API Documentation */ java.util.concurrent.Future getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest); /** *

* Gets the roles for an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param getIdentityPoolRolesRequest * Input to the GetIdentityPoolRoles action. * @param 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. * @return A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.GetIdentityPoolRoles * @see AWS API Documentation */ java.util.concurrent.Future getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 10 minutes. *

*

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

* * @param getOpenIdTokenRequest * Input to the GetOpenIdToken action. * @return A Java Future containing the result of the GetOpenIdToken operation returned by the service. * @sample AmazonCognitoIdentityAsync.GetOpenIdToken * @see AWS API Documentation */ java.util.concurrent.Future getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest); /** *

* 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 10 minutes. *

*

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

* * @param getOpenIdTokenRequest * Input to the GetOpenIdToken action. * @param 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. * @return A Java Future containing the result of the GetOpenIdToken operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.GetOpenIdToken * @see AWS API Documentation */ java.util.concurrent.Future getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param getOpenIdTokenForDeveloperIdentityRequest * Input to the GetOpenIdTokenForDeveloperIdentity action. * @return A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the * service. * @sample AmazonCognitoIdentityAsync.GetOpenIdTokenForDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future getOpenIdTokenForDeveloperIdentityAsync( GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest); /** *

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

* * @param getOpenIdTokenForDeveloperIdentityRequest * Input to the GetOpenIdTokenForDeveloperIdentity action. * @param 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. * @return A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the * service. * @sample AmazonCognitoIdentityAsyncHandler.GetOpenIdTokenForDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future getOpenIdTokenForDeveloperIdentityAsync( GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user * attributes. *

* * @param getPrincipalTagAttributeMapRequest * @return A Java Future containing the result of the GetPrincipalTagAttributeMap operation returned by the service. * @sample AmazonCognitoIdentityAsync.GetPrincipalTagAttributeMap * @see AWS API Documentation */ java.util.concurrent.Future getPrincipalTagAttributeMapAsync( GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest); /** *

* Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user * attributes. *

* * @param getPrincipalTagAttributeMapRequest * @param 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. * @return A Java Future containing the result of the GetPrincipalTagAttributeMap operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.GetPrincipalTagAttributeMap * @see AWS API Documentation */ java.util.concurrent.Future getPrincipalTagAttributeMapAsync( GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the identities in an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param listIdentitiesRequest * Input to the ListIdentities action. * @return A Java Future containing the result of the ListIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsync.ListIdentities * @see AWS API Documentation */ java.util.concurrent.Future listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest); /** *

* Lists the identities in an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param listIdentitiesRequest * Input to the ListIdentities action. * @param 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. * @return A Java Future containing the result of the ListIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.ListIdentities * @see AWS API Documentation */ java.util.concurrent.Future listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

* You must use AWS Developer credentials to call this API. *

* * @param listIdentityPoolsRequest * Input to the ListIdentityPools action. * @return A Java Future containing the result of the ListIdentityPools operation returned by the service. * @sample AmazonCognitoIdentityAsync.ListIdentityPools * @see AWS API Documentation */ java.util.concurrent.Future listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest); /** *

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

*

* You must use AWS Developer credentials to call this API. *

* * @param listIdentityPoolsRequest * Input to the ListIdentityPools action. * @param 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. * @return A Java Future containing the result of the ListIdentityPools operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.ListIdentityPools * @see AWS API Documentation */ java.util.concurrent.Future listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the tags that are assigned to an Amazon Cognito identity pool. *

*

* A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by * purpose, owner, environment, or other criteria. *

*

* You can use this action up to 10 times per second, per account. *

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCognitoIdentityAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Lists the tags that are assigned to an Amazon Cognito identity pool. *

*

* A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by * purpose, owner, environment, or other criteria. *

*

* You can use this action up to 10 times per second, per account. *

* * @param listTagsForResourceRequest * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of * DeveloperUserIdentifier values associated with an IdentityId for an existing identity. * Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one * of these values, the other value will be searched in the database and returned as a part of the response. If you * supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values * are verified against the database, the response returns both values and is the same as the request. Otherwise a * ResourceConflictException is thrown. *

*

* LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to * enable customer service to locate an identity ID by username. If you are using it for higher-volume operations * such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity * is a better option for higher-volume operations for user authentication. *

*

* You must use AWS Developer credentials to call this API. *

* * @param lookupDeveloperIdentityRequest * Input to the LookupDeveloperIdentityInput action. * @return A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsync.LookupDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest); /** *

* Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of * DeveloperUserIdentifier values associated with an IdentityId for an existing identity. * Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one * of these values, the other value will be searched in the database and returned as a part of the response. If you * supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values * are verified against the database, the response returns both values and is the same as the request. Otherwise a * ResourceConflictException is thrown. *

*

* LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to * enable customer service to locate an identity ID by username. If you are using it for higher-volume operations * such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity * is a better option for higher-volume operations for user authentication. *

*

* You must use AWS Developer credentials to call this API. *

* * @param lookupDeveloperIdentityRequest * Input to the LookupDeveloperIdentityInput action. * @param 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. * @return A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.LookupDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Merges two users having different IdentityIds, existing in the same identity pool, and identified by * the same developer provider. You can use this action to request that discrete users be merged and identified as a * single user in the Cognito environment. Cognito associates the given source user ( * SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier * . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public * provider, but as two different users, an exception will be thrown. *

*

* The number of linked logins is limited to 20. So, the number of linked logins for the source user, * SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together * should not be larger than 20. Otherwise, an exception will be thrown. *

*

* You must use AWS Developer credentials to call this API. *

* * @param mergeDeveloperIdentitiesRequest * Input to the MergeDeveloperIdentities action. * @return A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsync.MergeDeveloperIdentities * @see AWS API Documentation */ java.util.concurrent.Future mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest); /** *

* Merges two users having different IdentityIds, existing in the same identity pool, and identified by * the same developer provider. You can use this action to request that discrete users be merged and identified as a * single user in the Cognito environment. Cognito associates the given source user ( * SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier * . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public * provider, but as two different users, an exception will be thrown. *

*

* The number of linked logins is limited to 20. So, the number of linked logins for the source user, * SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together * should not be larger than 20. Otherwise, an exception will be thrown. *

*

* You must use AWS Developer credentials to call this API. *

* * @param mergeDeveloperIdentitiesRequest * Input to the MergeDeveloperIdentities action. * @param 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. * @return A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.MergeDeveloperIdentities * @see AWS API Documentation */ java.util.concurrent.Future mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param setIdentityPoolRolesRequest * Input to the SetIdentityPoolRoles action. * @return A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service. * @sample AmazonCognitoIdentityAsync.SetIdentityPoolRoles * @see AWS API Documentation */ java.util.concurrent.Future setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest); /** *

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

* * @param setIdentityPoolRolesRequest * Input to the SetIdentityPoolRoles action. * @param 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. * @return A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.SetIdentityPoolRoles * @see AWS API Documentation */ java.util.concurrent.Future setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* You can use this operation to use default (username and clientID) attribute or custom attribute mappings. *

* * @param setPrincipalTagAttributeMapRequest * @return A Java Future containing the result of the SetPrincipalTagAttributeMap operation returned by the service. * @sample AmazonCognitoIdentityAsync.SetPrincipalTagAttributeMap * @see AWS API Documentation */ java.util.concurrent.Future setPrincipalTagAttributeMapAsync( SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest); /** *

* You can use this operation to use default (username and clientID) attribute or custom attribute mappings. *

* * @param setPrincipalTagAttributeMapRequest * @param 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. * @return A Java Future containing the result of the SetPrincipalTagAttributeMap operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.SetPrincipalTagAttributeMap * @see AWS API Documentation */ java.util.concurrent.Future setPrincipalTagAttributeMapAsync( SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to * categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other * criteria. *

*

* Each tag consists of a key and value, both of which you define. A key is a general category for more specific * values. For example, if you have two versions of an identity pool, one for testing and another for production, * you might assign an Environment tag key to both identity pools. The value of this key might be * Test for one identity pool and Production for the other. *

*

* Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the * Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM * policy, you can constrain permissions for identity pools based on specific tags or tag values. *

*

* You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonCognitoIdentityAsync.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to * categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other * criteria. *

*

* Each tag consists of a key and value, both of which you define. A key is a general category for more specific * values. For example, if you have two versions of an identity pool, one for testing and another for production, * you might assign an Environment tag key to both identity pools. The value of this key might be * Test for one identity pool and Production for the other. *

*

* Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the * Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM * policy, you can constrain permissions for identity pools based on specific tags or tag values. *

*

* You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. *

* * @param tagResourceRequest * @param 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. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param unlinkDeveloperIdentityRequest * Input to the UnlinkDeveloperIdentity action. * @return A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsync.UnlinkDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest); /** *

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

* * @param unlinkDeveloperIdentityRequest * Input to the UnlinkDeveloperIdentity action. * @param 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. * @return A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.UnlinkDeveloperIdentity * @see AWS API Documentation */ java.util.concurrent.Future unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param unlinkIdentityRequest * Input to the UnlinkIdentity action. * @return A Java Future containing the result of the UnlinkIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsync.UnlinkIdentity * @see AWS API Documentation */ java.util.concurrent.Future unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest); /** *

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

* * @param unlinkIdentityRequest * Input to the UnlinkIdentity action. * @param 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. * @return A Java Future containing the result of the UnlinkIdentity operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.UnlinkIdentity * @see AWS API Documentation */ java.util.concurrent.Future unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times * per second, per account *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonCognitoIdentityAsync.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times * per second, per account *

* * @param untagResourceRequest * @param 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. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param updateIdentityPoolRequest * An object representing an Amazon Cognito identity pool. * @return A Java Future containing the result of the UpdateIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsync.UpdateIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest); /** *

* Updates an identity pool. *

*

* You must use AWS Developer credentials to call this API. *

* * @param updateIdentityPoolRequest * An object representing an Amazon Cognito identity pool. * @param 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. * @return A Java Future containing the result of the UpdateIdentityPool operation returned by the service. * @sample AmazonCognitoIdentityAsyncHandler.UpdateIdentityPool * @see AWS API Documentation */ java.util.concurrent.Future updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy