Package software.amazon.awssdk.services.cognitoidentity

Interface CognitoIdentityAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CognitoIdentityAsyncClient extends AwsClient
Service client for accessing Amazon Cognito Identity asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. 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.

  • Field Details

  • Method Details

    • createIdentityPool

      default CompletableFuture<CreateIdentityPoolResponse> createIdentityPool(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.

      Parameters:
      createIdentityPoolRequest - Input to the CreateIdentityPool action.
      Returns:
      A Java Future containing the result of the CreateIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIdentityPool

      default CompletableFuture<CreateIdentityPoolResponse> createIdentityPool(Consumer<CreateIdentityPoolRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateIdentityPoolRequest.Builder avoiding the need to create one manually via CreateIdentityPoolRequest.builder()

      Parameters:
      createIdentityPoolRequest - A Consumer that will call methods on CreateIdentityPoolRequest.Builder to create a request. Input to the CreateIdentityPool action.
      Returns:
      A Java Future containing the result of the CreateIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIdentities

      default CompletableFuture<DeleteIdentitiesResponse> deleteIdentities(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.

      Parameters:
      deleteIdentitiesRequest - Input to the DeleteIdentities action.
      Returns:
      A Java Future containing the result of the DeleteIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIdentities

      default CompletableFuture<DeleteIdentitiesResponse> deleteIdentities(Consumer<DeleteIdentitiesRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteIdentitiesRequest.Builder avoiding the need to create one manually via DeleteIdentitiesRequest.builder()

      Parameters:
      deleteIdentitiesRequest - A Consumer that will call methods on DeleteIdentitiesRequest.Builder to create a request. Input to the DeleteIdentities action.
      Returns:
      A Java Future containing the result of the DeleteIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIdentityPool

      default CompletableFuture<DeleteIdentityPoolResponse> deleteIdentityPool(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.

      Parameters:
      deleteIdentityPoolRequest - Input to the DeleteIdentityPool action.
      Returns:
      A Java Future containing the result of the DeleteIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIdentityPool

      default CompletableFuture<DeleteIdentityPoolResponse> deleteIdentityPool(Consumer<DeleteIdentityPoolRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteIdentityPoolRequest.Builder avoiding the need to create one manually via DeleteIdentityPoolRequest.builder()

      Parameters:
      deleteIdentityPoolRequest - A Consumer that will call methods on DeleteIdentityPoolRequest.Builder to create a request. Input to the DeleteIdentityPool action.
      Returns:
      A Java Future containing the result of the DeleteIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIdentity

      default CompletableFuture<DescribeIdentityResponse> describeIdentity(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.

      Parameters:
      describeIdentityRequest - Input to the DescribeIdentity action.
      Returns:
      A Java Future containing the result of the DescribeIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIdentity

      default CompletableFuture<DescribeIdentityResponse> describeIdentity(Consumer<DescribeIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeIdentityRequest.Builder avoiding the need to create one manually via DescribeIdentityRequest.builder()

      Parameters:
      describeIdentityRequest - A Consumer that will call methods on DescribeIdentityRequest.Builder to create a request. Input to the DescribeIdentity action.
      Returns:
      A Java Future containing the result of the DescribeIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIdentityPool

      default CompletableFuture<DescribeIdentityPoolResponse> describeIdentityPool(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.

      Parameters:
      describeIdentityPoolRequest - Input to the DescribeIdentityPool action.
      Returns:
      A Java Future containing the result of the DescribeIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIdentityPool

      default CompletableFuture<DescribeIdentityPoolResponse> describeIdentityPool(Consumer<DescribeIdentityPoolRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeIdentityPoolRequest.Builder avoiding the need to create one manually via DescribeIdentityPoolRequest.builder()

      Parameters:
      describeIdentityPoolRequest - A Consumer that will call methods on DescribeIdentityPoolRequest.Builder to create a request. Input to the DescribeIdentityPool action.
      Returns:
      A Java Future containing the result of the DescribeIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCredentialsForIdentity

      default CompletableFuture<GetCredentialsForIdentityResponse> getCredentialsForIdentity(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.

      Parameters:
      getCredentialsForIdentityRequest - Input to the GetCredentialsForIdentity action.
      Returns:
      A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InvalidIdentityPoolConfigurationException Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCredentialsForIdentity

      default CompletableFuture<GetCredentialsForIdentityResponse> getCredentialsForIdentity(Consumer<GetCredentialsForIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the GetCredentialsForIdentityRequest.Builder avoiding the need to create one manually via GetCredentialsForIdentityRequest.builder()

      Parameters:
      getCredentialsForIdentityRequest - A Consumer that will call methods on GetCredentialsForIdentityRequest.Builder to create a request. Input to the GetCredentialsForIdentity action.
      Returns:
      A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InvalidIdentityPoolConfigurationException Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getId

      default CompletableFuture<GetIdResponse> getId(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.

      Parameters:
      getIdRequest - Input to the GetId action.
      Returns:
      A Java Future containing the result of the GetId operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getId

      default CompletableFuture<GetIdResponse> getId(Consumer<GetIdRequest.Builder> 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.


      This is a convenience which creates an instance of the GetIdRequest.Builder avoiding the need to create one manually via GetIdRequest.builder()

      Parameters:
      getIdRequest - A Consumer that will call methods on GetIdRequest.Builder to create a request. Input to the GetId action.
      Returns:
      A Java Future containing the result of the GetId operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIdentityPoolRoles

      default CompletableFuture<GetIdentityPoolRolesResponse> getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)

      Gets the roles for an identity pool.

      You must use AWS Developer credentials to call this API.

      Parameters:
      getIdentityPoolRolesRequest - Input to the GetIdentityPoolRoles action.
      Returns:
      A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIdentityPoolRoles

      default CompletableFuture<GetIdentityPoolRolesResponse> getIdentityPoolRoles(Consumer<GetIdentityPoolRolesRequest.Builder> getIdentityPoolRolesRequest)

      Gets the roles for an identity pool.

      You must use AWS Developer credentials to call this API.


      This is a convenience which creates an instance of the GetIdentityPoolRolesRequest.Builder avoiding the need to create one manually via GetIdentityPoolRolesRequest.builder()

      Parameters:
      getIdentityPoolRolesRequest - A Consumer that will call methods on GetIdentityPoolRolesRequest.Builder to create a request. Input to the GetIdentityPoolRoles action.
      Returns:
      A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpenIdToken

      default CompletableFuture<GetOpenIdTokenResponse> getOpenIdToken(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.

      Parameters:
      getOpenIdTokenRequest - Input to the GetOpenIdToken action.
      Returns:
      A Java Future containing the result of the GetOpenIdToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpenIdToken

      default CompletableFuture<GetOpenIdTokenResponse> getOpenIdToken(Consumer<GetOpenIdTokenRequest.Builder> 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.


      This is a convenience which creates an instance of the GetOpenIdTokenRequest.Builder avoiding the need to create one manually via GetOpenIdTokenRequest.builder()

      Parameters:
      getOpenIdTokenRequest - A Consumer that will call methods on GetOpenIdTokenRequest.Builder to create a request. Input to the GetOpenIdToken action.
      Returns:
      A Java Future containing the result of the GetOpenIdToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpenIdTokenForDeveloperIdentity

      default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> getOpenIdTokenForDeveloperIdentity(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.

      Parameters:
      getOpenIdTokenForDeveloperIdentityRequest - Input to the GetOpenIdTokenForDeveloperIdentity action.
      Returns:
      A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • DeveloperUserAlreadyRegisteredException The provided developer user identifier is already registered with Cognito under a different identity ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOpenIdTokenForDeveloperIdentity

      default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> getOpenIdTokenForDeveloperIdentity(Consumer<GetOpenIdTokenForDeveloperIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the GetOpenIdTokenForDeveloperIdentityRequest.Builder avoiding the need to create one manually via GetOpenIdTokenForDeveloperIdentityRequest.builder()

      Parameters:
      getOpenIdTokenForDeveloperIdentityRequest - A Consumer that will call methods on GetOpenIdTokenForDeveloperIdentityRequest.Builder to create a request. Input to the GetOpenIdTokenForDeveloperIdentity action.
      Returns:
      A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • DeveloperUserAlreadyRegisteredException The provided developer user identifier is already registered with Cognito under a different identity ID.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPrincipalTagAttributeMap

      default CompletableFuture<GetPrincipalTagAttributeMapResponse> getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest)

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

      Parameters:
      getPrincipalTagAttributeMapRequest -
      Returns:
      A Java Future containing the result of the GetPrincipalTagAttributeMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPrincipalTagAttributeMap

      default CompletableFuture<GetPrincipalTagAttributeMapResponse> getPrincipalTagAttributeMap(Consumer<GetPrincipalTagAttributeMapRequest.Builder> getPrincipalTagAttributeMapRequest)

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


      This is a convenience which creates an instance of the GetPrincipalTagAttributeMapRequest.Builder avoiding the need to create one manually via GetPrincipalTagAttributeMapRequest.builder()

      Parameters:
      getPrincipalTagAttributeMapRequest - A Consumer that will call methods on GetPrincipalTagAttributeMapRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPrincipalTagAttributeMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentities

      default CompletableFuture<ListIdentitiesResponse> listIdentities(ListIdentitiesRequest listIdentitiesRequest)

      Lists the identities in an identity pool.

      You must use AWS Developer credentials to call this API.

      Parameters:
      listIdentitiesRequest - Input to the ListIdentities action.
      Returns:
      A Java Future containing the result of the ListIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentities

      default CompletableFuture<ListIdentitiesResponse> listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)

      Lists the identities in an identity pool.

      You must use AWS Developer credentials to call this API.


      This is a convenience which creates an instance of the ListIdentitiesRequest.Builder avoiding the need to create one manually via ListIdentitiesRequest.builder()

      Parameters:
      listIdentitiesRequest - A Consumer that will call methods on ListIdentitiesRequest.Builder to create a request. Input to the ListIdentities action.
      Returns:
      A Java Future containing the result of the ListIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentityPools

      default CompletableFuture<ListIdentityPoolsResponse> listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)

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

      You must use AWS Developer credentials to call this API.

      Parameters:
      listIdentityPoolsRequest - Input to the ListIdentityPools action.
      Returns:
      A Java Future containing the result of the ListIdentityPools operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentityPools

      default CompletableFuture<ListIdentityPoolsResponse> listIdentityPools(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)

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

      You must use AWS Developer credentials to call this API.


      This is a convenience which creates an instance of the ListIdentityPoolsRequest.Builder avoiding the need to create one manually via ListIdentityPoolsRequest.builder()

      Parameters:
      listIdentityPoolsRequest - A Consumer that will call methods on ListIdentityPoolsRequest.Builder to create a request. Input to the ListIdentityPools action.
      Returns:
      A Java Future containing the result of the ListIdentityPools operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentityPoolsPaginator

      default ListIdentityPoolsPublisher listIdentityPoolsPaginator(ListIdentityPoolsRequest listIdentityPoolsRequest)

      This is a variant of listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest) operation.

      Parameters:
      listIdentityPoolsRequest - Input to the ListIdentityPools action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIdentityPoolsPaginator

      default ListIdentityPoolsPublisher listIdentityPoolsPaginator(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)

      This is a variant of listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest) operation.


      This is a convenience which creates an instance of the ListIdentityPoolsRequest.Builder avoiding the need to create one manually via ListIdentityPoolsRequest.builder()

      Parameters:
      listIdentityPoolsRequest - A Consumer that will call methods on ListIdentityPoolsRequest.Builder to create a request. Input to the ListIdentityPools action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupDeveloperIdentity

      default CompletableFuture<LookupDeveloperIdentityResponse> lookupDeveloperIdentity(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.

      Parameters:
      lookupDeveloperIdentityRequest - Input to the LookupDeveloperIdentityInput action.
      Returns:
      A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupDeveloperIdentity

      default CompletableFuture<LookupDeveloperIdentityResponse> lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the LookupDeveloperIdentityRequest.Builder avoiding the need to create one manually via LookupDeveloperIdentityRequest.builder()

      Parameters:
      lookupDeveloperIdentityRequest - A Consumer that will call methods on LookupDeveloperIdentityRequest.Builder to create a request. Input to the LookupDeveloperIdentityInput action.
      Returns:
      A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • mergeDeveloperIdentities

      default CompletableFuture<MergeDeveloperIdentitiesResponse> mergeDeveloperIdentities(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.

      Parameters:
      mergeDeveloperIdentitiesRequest - Input to the MergeDeveloperIdentities action.
      Returns:
      A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • mergeDeveloperIdentities

      default CompletableFuture<MergeDeveloperIdentitiesResponse> mergeDeveloperIdentities(Consumer<MergeDeveloperIdentitiesRequest.Builder> 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.


      This is a convenience which creates an instance of the MergeDeveloperIdentitiesRequest.Builder avoiding the need to create one manually via MergeDeveloperIdentitiesRequest.builder()

      Parameters:
      mergeDeveloperIdentitiesRequest - A Consumer that will call methods on MergeDeveloperIdentitiesRequest.Builder to create a request. Input to the MergeDeveloperIdentities action.
      Returns:
      A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setIdentityPoolRoles

      default CompletableFuture<SetIdentityPoolRolesResponse> setIdentityPoolRoles(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.

      Parameters:
      setIdentityPoolRolesRequest - Input to the SetIdentityPoolRoles action.
      Returns:
      A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setIdentityPoolRoles

      default CompletableFuture<SetIdentityPoolRolesResponse> setIdentityPoolRoles(Consumer<SetIdentityPoolRolesRequest.Builder> 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.


      This is a convenience which creates an instance of the SetIdentityPoolRolesRequest.Builder avoiding the need to create one manually via SetIdentityPoolRolesRequest.builder()

      Parameters:
      setIdentityPoolRolesRequest - A Consumer that will call methods on SetIdentityPoolRolesRequest.Builder to create a request. Input to the SetIdentityPoolRoles action.
      Returns:
      A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setPrincipalTagAttributeMap

      default CompletableFuture<SetPrincipalTagAttributeMapResponse> setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest)

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

      Parameters:
      setPrincipalTagAttributeMapRequest -
      Returns:
      A Java Future containing the result of the SetPrincipalTagAttributeMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setPrincipalTagAttributeMap

      default CompletableFuture<SetPrincipalTagAttributeMapResponse> setPrincipalTagAttributeMap(Consumer<SetPrincipalTagAttributeMapRequest.Builder> setPrincipalTagAttributeMapRequest)

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


      This is a convenience which creates an instance of the SetPrincipalTagAttributeMapRequest.Builder avoiding the need to create one manually via SetPrincipalTagAttributeMapRequest.builder()

      Parameters:
      setPrincipalTagAttributeMapRequest - A Consumer that will call methods on SetPrincipalTagAttributeMapRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SetPrincipalTagAttributeMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(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.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlinkDeveloperIdentity

      default CompletableFuture<UnlinkDeveloperIdentityResponse> unlinkDeveloperIdentity(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.

      Parameters:
      unlinkDeveloperIdentityRequest - Input to the UnlinkDeveloperIdentity action.
      Returns:
      A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlinkDeveloperIdentity

      default CompletableFuture<UnlinkDeveloperIdentityResponse> unlinkDeveloperIdentity(Consumer<UnlinkDeveloperIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the UnlinkDeveloperIdentityRequest.Builder avoiding the need to create one manually via UnlinkDeveloperIdentityRequest.builder()

      Parameters:
      unlinkDeveloperIdentityRequest - A Consumer that will call methods on UnlinkDeveloperIdentityRequest.Builder to create a request. Input to the UnlinkDeveloperIdentity action.
      Returns:
      A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlinkIdentity

      default CompletableFuture<UnlinkIdentityResponse> unlinkIdentity(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.

      Parameters:
      unlinkIdentityRequest - Input to the UnlinkIdentity action.
      Returns:
      A Java Future containing the result of the UnlinkIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unlinkIdentity

      default CompletableFuture<UnlinkIdentityResponse> unlinkIdentity(Consumer<UnlinkIdentityRequest.Builder> 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.


      This is a convenience which creates an instance of the UnlinkIdentityRequest.Builder avoiding the need to create one manually via UnlinkIdentityRequest.builder()

      Parameters:
      unlinkIdentityRequest - A Consumer that will call methods on UnlinkIdentityRequest.Builder to create a request. Input to the UnlinkIdentity action.
      Returns:
      A Java Future containing the result of the UnlinkIdentity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(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

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIdentityPool

      default CompletableFuture<UpdateIdentityPoolResponse> updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)

      Updates an identity pool.

      You must use AWS Developer credentials to call this API.

      Parameters:
      updateIdentityPoolRequest - An object representing an Amazon Cognito identity pool.
      Returns:
      A Java Future containing the result of the UpdateIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIdentityPool

      default CompletableFuture<UpdateIdentityPoolResponse> updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest)

      Updates an identity pool.

      You must use AWS Developer credentials to call this API.


      This is a convenience which creates an instance of the UpdateIdentityPoolRequest.Builder avoiding the need to create one manually via UpdateIdentityPoolRequest.builder()

      Parameters:
      updateIdentityPoolRequest - A Consumer that will call methods on UpdateIdentityPoolRequest.Builder to create a request. An object representing an Amazon Cognito identity pool.
      Returns:
      A Java Future containing the result of the UpdateIdentityPool operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Thrown for missing or bad input parameter(s).
      • ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
      • NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
      • ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
      • TooManyRequestsException Thrown when a request is throttled.
      • InternalErrorException Thrown when the service encounters an error during processing the request.
      • ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
      • LimitExceededException Thrown when the total number of user pools has exceeded a preset limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CognitoIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default CognitoIdentityServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static CognitoIdentityAsyncClient create()
      Create a CognitoIdentityAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CognitoIdentityAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CognitoIdentityAsyncClient.