software.amazon.awssdk.services.cognitoidentity.CognitoIdentityAsyncClient Maven / Gradle / Ivy
Show all versions of cognitoidentity Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cognitoidentity;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolRequest;
import software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolResponse;
import software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentitiesRequest;
import software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentitiesResponse;
import software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentityPoolRequest;
import software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentityPoolResponse;
import software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityPoolRequest;
import software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityPoolResponse;
import software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetIdRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetIdResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetIdentityPoolRolesRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetIdentityPoolRolesResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenResponse;
import software.amazon.awssdk.services.cognitoidentity.model.GetPrincipalTagAttributeMapRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetPrincipalTagAttributeMapResponse;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentitiesRequest;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentitiesResponse;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse;
import software.amazon.awssdk.services.cognitoidentity.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.cognitoidentity.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.cognitoidentity.model.LookupDeveloperIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.LookupDeveloperIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest;
import software.amazon.awssdk.services.cognitoidentity.model.MergeDeveloperIdentitiesResponse;
import software.amazon.awssdk.services.cognitoidentity.model.SetIdentityPoolRolesRequest;
import software.amazon.awssdk.services.cognitoidentity.model.SetIdentityPoolRolesResponse;
import software.amazon.awssdk.services.cognitoidentity.model.SetPrincipalTagAttributeMapRequest;
import software.amazon.awssdk.services.cognitoidentity.model.SetPrincipalTagAttributeMapResponse;
import software.amazon.awssdk.services.cognitoidentity.model.TagResourceRequest;
import software.amazon.awssdk.services.cognitoidentity.model.TagResourceResponse;
import software.amazon.awssdk.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.UnlinkDeveloperIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.UnlinkIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.UnlinkIdentityResponse;
import software.amazon.awssdk.services.cognitoidentity.model.UntagResourceRequest;
import software.amazon.awssdk.services.cognitoidentity.model.UntagResourceResponse;
import software.amazon.awssdk.services.cognitoidentity.model.UpdateIdentityPoolRequest;
import software.amazon.awssdk.services.cognitoidentity.model.UpdateIdentityPoolResponse;
import software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher;
/**
* Service client for accessing Amazon Cognito Identity asynchronously. This can be created using the static
* {@link #builder()} method.The asynchronous client performs non-blocking I/O when configured with any
* {@code 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface CognitoIdentityAsyncClient extends AwsClient {
String SERVICE_NAME = "cognito-identity";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "cognito-identity";
/**
*
* Creates a new identity pool. The identity pool is a store of user identity information that is specific to your
* AWS account. The keys for SupportedLoginProviders are as follows:
*
*
* -
*
* Facebook: graph.facebook.com
*
*
* -
*
* Google: accounts.google.com
*
*
* -
*
* Amazon: www.amazon.com
*
*
* -
*
* Twitter: api.twitter.com
*
*
* -
*
* Digits: www.digits.com
*
*
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param createIdentityPoolRequest
* Input to the CreateIdentityPool action.
* @return A Java Future containing the result of the CreateIdentityPool operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.CreateIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateIdentityPoolRequest.Builder} avoiding the
* need to create one manually via {@link CreateIdentityPoolRequest#builder()}
*
*
* @param createIdentityPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolRequest.Builder} to create
* a request. Input to the CreateIdentityPool action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.CreateIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture createIdentityPool(
Consumer createIdentityPoolRequest) {
return createIdentityPool(CreateIdentityPoolRequest.builder().applyMutation(createIdentityPoolRequest).build());
}
/**
*
* Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param deleteIdentitiesRequest
* Input to the DeleteIdentities action.
* @return A Java Future containing the result of the DeleteIdentities operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DeleteIdentities
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteIdentitiesRequest.Builder} avoiding the need
* to create one manually via {@link DeleteIdentitiesRequest#builder()}
*
*
* @param deleteIdentitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentitiesRequest.Builder} to create a
* request. Input to the DeleteIdentities action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DeleteIdentities
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentities(
Consumer deleteIdentitiesRequest) {
return deleteIdentities(DeleteIdentitiesRequest.builder().applyMutation(deleteIdentitiesRequest).build());
}
/**
*
* Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param deleteIdentityPoolRequest
* Input to the DeleteIdentityPool action.
* @return A Java Future containing the result of the DeleteIdentityPool operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DeleteIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteIdentityPoolRequest.Builder} avoiding the
* need to create one manually via {@link DeleteIdentityPoolRequest#builder()}
*
*
* @param deleteIdentityPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentityPoolRequest.Builder} to create
* a request. Input to the DeleteIdentityPool action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DeleteIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityPool(
Consumer deleteIdentityPoolRequest) {
return deleteIdentityPool(DeleteIdentityPoolRequest.builder().applyMutation(deleteIdentityPoolRequest).build());
}
/**
*
* Returns metadata related to the given identity, including when the identity was created and any associated linked
* logins.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param describeIdentityRequest
* Input to the DescribeIdentity action.
* @return A Java Future containing the result of the DescribeIdentity operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DescribeIdentity
* @see AWS API Documentation
*/
default CompletableFuture describeIdentity(DescribeIdentityRequest describeIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeIdentityRequest.Builder} avoiding the need
* to create one manually via {@link DescribeIdentityRequest#builder()}
*
*
* @param describeIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityRequest.Builder} to create a
* request. Input to the DescribeIdentity action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DescribeIdentity
* @see AWS API Documentation
*/
default CompletableFuture describeIdentity(
Consumer describeIdentityRequest) {
return describeIdentity(DescribeIdentityRequest.builder().applyMutation(describeIdentityRequest).build());
}
/**
*
* Gets details about a particular identity pool, including the pool name, ID description, creation date, and
* current number of users.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param describeIdentityPoolRequest
* Input to the DescribeIdentityPool action.
* @return A Java Future containing the result of the DescribeIdentityPool operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DescribeIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture describeIdentityPool(
DescribeIdentityPoolRequest describeIdentityPoolRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeIdentityPoolRequest.Builder} avoiding the
* need to create one manually via {@link DescribeIdentityPoolRequest#builder()}
*
*
* @param describeIdentityPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.DescribeIdentityPoolRequest.Builder} to
* create a request. Input to the DescribeIdentityPool action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.DescribeIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture describeIdentityPool(
Consumer describeIdentityPoolRequest) {
return describeIdentityPool(DescribeIdentityPoolRequest.builder().applyMutation(describeIdentityPoolRequest).build());
}
/**
*
* Returns credentials for the provided identity ID. Any provided logins will be validated against supported login
* providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token
* Service with the appropriate role for the token.
*
*
* This is a public API. You do not need any credentials to call this API.
*
*
* @param getCredentialsForIdentityRequest
* Input to the GetCredentialsForIdentity action.
* @return A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetCredentialsForIdentity
* @see AWS API Documentation
*/
default CompletableFuture getCredentialsForIdentity(
GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetCredentialsForIdentityRequest.Builder} avoiding
* the need to create one manually via {@link GetCredentialsForIdentityRequest#builder()}
*
*
* @param getCredentialsForIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityRequest.Builder} to
* create a request. Input to the GetCredentialsForIdentity action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetCredentialsForIdentity
* @see AWS API Documentation
*/
default CompletableFuture getCredentialsForIdentity(
Consumer getCredentialsForIdentityRequest) {
return getCredentialsForIdentity(GetCredentialsForIdentityRequest.builder()
.applyMutation(getCredentialsForIdentityRequest).build());
}
/**
*
* Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
*
*
* This is a public API. You do not need any credentials to call this API.
*
*
* @param getIdRequest
* Input to the GetId action.
* @return A Java Future containing the result of the GetId operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetId
* @see AWS API
* Documentation
*/
default CompletableFuture getId(GetIdRequest getIdRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetIdRequest.Builder} avoiding the need to create
* one manually via {@link GetIdRequest#builder()}
*
*
* @param getIdRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetIdRequest.Builder} to create a request.
* Input to the GetId action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetId
* @see AWS API
* Documentation
*/
default CompletableFuture getId(Consumer getIdRequest) {
return getId(GetIdRequest.builder().applyMutation(getIdRequest).build());
}
/**
*
* Gets the roles for an identity pool.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param getIdentityPoolRolesRequest
* Input to the GetIdentityPoolRoles action.
* @return A Java Future containing the result of the GetIdentityPoolRoles operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetIdentityPoolRoles
* @see AWS API Documentation
*/
default CompletableFuture getIdentityPoolRoles(
GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetIdentityPoolRolesRequest.Builder} avoiding the
* need to create one manually via {@link GetIdentityPoolRolesRequest#builder()}
*
*
* @param getIdentityPoolRolesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetIdentityPoolRolesRequest.Builder} to
* create a request. Input to the GetIdentityPoolRoles action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetIdentityPoolRoles
* @see AWS API Documentation
*/
default CompletableFuture getIdentityPoolRoles(
Consumer getIdentityPoolRolesRequest) {
return getIdentityPoolRoles(GetIdentityPoolRolesRequest.builder().applyMutation(getIdentityPoolRolesRequest).build());
}
/**
*
* Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can
* optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
*
*
* The OpenID token is valid for 10 minutes.
*
*
* This is a public API. You do not need any credentials to call this API.
*
*
* @param getOpenIdTokenRequest
* Input to the GetOpenIdToken action.
* @return A Java Future containing the result of the GetOpenIdToken operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetOpenIdToken
* @see AWS API Documentation
*/
default CompletableFuture getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetOpenIdTokenRequest.Builder} avoiding the need to
* create one manually via {@link GetOpenIdTokenRequest#builder()}
*
*
* @param getOpenIdTokenRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenRequest.Builder} to create a
* request. Input to the GetOpenIdToken action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetOpenIdToken
* @see AWS API Documentation
*/
default CompletableFuture getOpenIdToken(Consumer getOpenIdTokenRequest) {
return getOpenIdToken(GetOpenIdTokenRequest.builder().applyMutation(getOpenIdTokenRequest).build());
}
/**
*
* Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated
* by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can
* only specify one developer provider as part of the Logins map, which is linked to the identity pool.
* The developer provider is the "domain" by which Cognito will refer to your users.
*
*
* You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that
* is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to
* create a new identity, the IdentityId should be null. When you want to associate a new login with an
* existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId.
* This API will create the identity in the specified IdentityPoolId.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param getOpenIdTokenForDeveloperIdentityRequest
* Input to the GetOpenIdTokenForDeveloperIdentity action.
* @return A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the
* service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetOpenIdTokenForDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture getOpenIdTokenForDeveloperIdentity(
GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetOpenIdTokenForDeveloperIdentityRequest.Builder}
* avoiding the need to create one manually via {@link GetOpenIdTokenForDeveloperIdentityRequest#builder()}
*
*
* @param getOpenIdTokenForDeveloperIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest.Builder}
* to create a request. Input to the GetOpenIdTokenForDeveloperIdentity action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetOpenIdTokenForDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture getOpenIdTokenForDeveloperIdentity(
Consumer getOpenIdTokenForDeveloperIdentityRequest) {
return getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest.builder()
.applyMutation(getOpenIdTokenForDeveloperIdentityRequest).build());
}
/**
*
* Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
* attributes.
*
*
* @param getPrincipalTagAttributeMapRequest
* @return A Java Future containing the result of the GetPrincipalTagAttributeMap operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetPrincipalTagAttributeMap
* @see AWS API Documentation
*/
default CompletableFuture getPrincipalTagAttributeMap(
GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
* attributes.
*
*
*
* This is a convenience which creates an instance of the {@link GetPrincipalTagAttributeMapRequest.Builder}
* avoiding the need to create one manually via {@link GetPrincipalTagAttributeMapRequest#builder()}
*
*
* @param getPrincipalTagAttributeMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.GetPrincipalTagAttributeMapRequest.Builder}
* to create a request.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.GetPrincipalTagAttributeMap
* @see AWS API Documentation
*/
default CompletableFuture getPrincipalTagAttributeMap(
Consumer getPrincipalTagAttributeMapRequest) {
return getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest.builder()
.applyMutation(getPrincipalTagAttributeMapRequest).build());
}
/**
*
* Lists the identities in an identity pool.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param listIdentitiesRequest
* Input to the ListIdentities action.
* @return A Java Future containing the result of the ListIdentities operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentities
* @see AWS API Documentation
*/
default CompletableFuture listIdentities(ListIdentitiesRequest listIdentitiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListIdentitiesRequest.Builder} avoiding the need to
* create one manually via {@link ListIdentitiesRequest#builder()}
*
*
* @param listIdentitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.ListIdentitiesRequest.Builder} to create a
* request. Input to the ListIdentities action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentities
* @see AWS API Documentation
*/
default CompletableFuture listIdentities(Consumer listIdentitiesRequest) {
return listIdentities(ListIdentitiesRequest.builder().applyMutation(listIdentitiesRequest).build());
}
/**
*
* Lists all of the Cognito identity pools registered for your account.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param listIdentityPoolsRequest
* Input to the ListIdentityPools action.
* @return A Java Future containing the result of the ListIdentityPools operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentityPools
* @see AWS API Documentation
*/
default CompletableFuture listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListIdentityPoolsRequest.Builder} avoiding the need
* to create one manually via {@link ListIdentityPoolsRequest#builder()}
*
*
* @param listIdentityPoolsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest.Builder} to create a
* request. Input to the ListIdentityPools action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentityPools
* @see AWS API Documentation
*/
default CompletableFuture listIdentityPools(
Consumer listIdentityPoolsRequest) {
return listIdentityPools(ListIdentityPoolsRequest.builder().applyMutation(listIdentityPoolsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)}
* operation.
*
*
* @param listIdentityPoolsRequest
* Input to the ListIdentityPools action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentityPools
* @see AWS API Documentation
*/
default ListIdentityPoolsPublisher listIdentityPoolsPaginator(ListIdentityPoolsRequest listIdentityPoolsRequest) {
return new ListIdentityPoolsPublisher(this, listIdentityPoolsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsPublisher publisher = client.listIdentityPoolsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListIdentityPoolsRequest.Builder} avoiding the need
* to create one manually via {@link ListIdentityPoolsRequest#builder()}
*
*
* @param listIdentityPoolsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest.Builder} to create a
* request. Input to the ListIdentityPools action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListIdentityPools
* @see AWS API Documentation
*/
default ListIdentityPoolsPublisher listIdentityPoolsPaginator(
Consumer listIdentityPoolsRequest) {
return listIdentityPoolsPaginator(ListIdentityPoolsRequest.builder().applyMutation(listIdentityPoolsRequest).build());
}
/**
*
* Lists the tags that are assigned to an Amazon Cognito identity pool.
*
*
* A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by
* purpose, owner, environment, or other criteria.
*
*
* You can use this action up to 10 times per second, per account.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.ListTagsForResourceRequest.Builder} to create
* a request.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of
* DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
* Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one
* of these values, the other value will be searched in the database and returned as a part of the response. If you
* supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values
* are verified against the database, the response returns both values and is the same as the request. Otherwise a
* ResourceConflictException is thrown.
*
*
* LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to
* enable customer service to locate an identity ID by username. If you are using it for higher-volume operations
* such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity
* is a better option for higher-volume operations for user authentication.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param lookupDeveloperIdentityRequest
* Input to the LookupDeveloperIdentityInput action.
* @return A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.LookupDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture lookupDeveloperIdentity(
LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link LookupDeveloperIdentityRequest.Builder} avoiding
* the need to create one manually via {@link LookupDeveloperIdentityRequest#builder()}
*
*
* @param lookupDeveloperIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.LookupDeveloperIdentityRequest.Builder} to
* create a request. Input to the LookupDeveloperIdentityInput action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.LookupDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture lookupDeveloperIdentity(
Consumer lookupDeveloperIdentityRequest) {
return lookupDeveloperIdentity(LookupDeveloperIdentityRequest.builder().applyMutation(lookupDeveloperIdentityRequest)
.build());
}
/**
*
* Merges two users having different IdentityIds, existing in the same identity pool, and identified by
* the same developer provider. You can use this action to request that discrete users be merged and identified as a
* single user in the Cognito environment. Cognito associates the given source user (
* SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier
* . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public
* provider, but as two different users, an exception will be thrown.
*
*
* The number of linked logins is limited to 20. So, the number of linked logins for the source user,
* SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together
* should not be larger than 20. Otherwise, an exception will be thrown.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param mergeDeveloperIdentitiesRequest
* Input to the MergeDeveloperIdentities action.
* @return A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.MergeDeveloperIdentities
* @see AWS API Documentation
*/
default CompletableFuture mergeDeveloperIdentities(
MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link MergeDeveloperIdentitiesRequest.Builder} avoiding
* the need to create one manually via {@link MergeDeveloperIdentitiesRequest#builder()}
*
*
* @param mergeDeveloperIdentitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest.Builder} to
* create a request. Input to the MergeDeveloperIdentities action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.MergeDeveloperIdentities
* @see AWS API Documentation
*/
default CompletableFuture mergeDeveloperIdentities(
Consumer mergeDeveloperIdentitiesRequest) {
return mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest.builder().applyMutation(mergeDeveloperIdentitiesRequest)
.build());
}
/**
*
* Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity
* action.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param setIdentityPoolRolesRequest
* Input to the SetIdentityPoolRoles action.
* @return A Java Future containing the result of the SetIdentityPoolRoles operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.SetIdentityPoolRoles
* @see AWS API Documentation
*/
default CompletableFuture setIdentityPoolRoles(
SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SetIdentityPoolRolesRequest.Builder} avoiding the
* need to create one manually via {@link SetIdentityPoolRolesRequest#builder()}
*
*
* @param setIdentityPoolRolesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.SetIdentityPoolRolesRequest.Builder} to
* create a request. Input to the SetIdentityPoolRoles action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.SetIdentityPoolRoles
* @see AWS API Documentation
*/
default CompletableFuture setIdentityPoolRoles(
Consumer setIdentityPoolRolesRequest) {
return setIdentityPoolRoles(SetIdentityPoolRolesRequest.builder().applyMutation(setIdentityPoolRolesRequest).build());
}
/**
*
* You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
*
*
* @param setPrincipalTagAttributeMapRequest
* @return A Java Future containing the result of the SetPrincipalTagAttributeMap operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.SetPrincipalTagAttributeMap
* @see AWS API Documentation
*/
default CompletableFuture setPrincipalTagAttributeMap(
SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SetPrincipalTagAttributeMapRequest.Builder}
* avoiding the need to create one manually via {@link SetPrincipalTagAttributeMapRequest#builder()}
*
*
* @param setPrincipalTagAttributeMapRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.SetPrincipalTagAttributeMapRequest.Builder}
* to create a request.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.SetPrincipalTagAttributeMap
* @see AWS API Documentation
*/
default CompletableFuture setPrincipalTagAttributeMap(
Consumer setPrincipalTagAttributeMapRequest) {
return setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest.builder()
.applyMutation(setPrincipalTagAttributeMapRequest).build());
}
/**
*
* Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to
* categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other
* criteria.
*
*
* Each tag consists of a key and value, both of which you define. A key is a general category for more specific
* values. For example, if you have two versions of an identity pool, one for testing and another for production,
* you might assign an Environment tag key to both identity pools. The value of this key might be
* Test for one identity pool and Production for the other.
*
*
* Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the
* Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM
* policy, you can constrain permissions for identity pools based on specific tags or tag values.
*
*
* You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.TagResource
* @see AWS
* API Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.TagResourceRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.TagResource
* @see AWS
* API Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be
* considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated
* identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param unlinkDeveloperIdentityRequest
* Input to the UnlinkDeveloperIdentity action.
* @return A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UnlinkDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture unlinkDeveloperIdentity(
UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UnlinkDeveloperIdentityRequest.Builder} avoiding
* the need to create one manually via {@link UnlinkDeveloperIdentityRequest#builder()}
*
*
* @param unlinkDeveloperIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest.Builder} to
* create a request. Input to the UnlinkDeveloperIdentity action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UnlinkDeveloperIdentity
* @see AWS API Documentation
*/
default CompletableFuture unlinkDeveloperIdentity(
Consumer unlinkDeveloperIdentityRequest) {
return unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest.builder().applyMutation(unlinkDeveloperIdentityRequest)
.build());
}
/**
*
* Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next
* time they are seen. Removing the last linked login will make this identity inaccessible.
*
*
* This is a public API. You do not need any credentials to call this API.
*
*
* @param unlinkIdentityRequest
* Input to the UnlinkIdentity action.
* @return A Java Future containing the result of the UnlinkIdentity operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UnlinkIdentity
* @see AWS API Documentation
*/
default CompletableFuture unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UnlinkIdentityRequest.Builder} avoiding the need to
* create one manually via {@link UnlinkIdentityRequest#builder()}
*
*
* @param unlinkIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.UnlinkIdentityRequest.Builder} to create a
* request. Input to the UnlinkIdentity action.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UnlinkIdentity
* @see AWS API Documentation
*/
default CompletableFuture unlinkIdentity(Consumer unlinkIdentityRequest) {
return unlinkIdentity(UnlinkIdentityRequest.builder().applyMutation(unlinkIdentityRequest).build());
}
/**
*
* Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times
* per second, per account
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UntagResource
* @see AWS API Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.UntagResourceRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UntagResource
* @see AWS API Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an identity pool.
*
*
* You must use AWS Developer credentials to call this API.
*
*
* @param updateIdentityPoolRequest
* An object representing an Amazon Cognito identity pool.
* @return A Java Future containing the result of the UpdateIdentityPool operation returned by the service.
* 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UpdateIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates an identity pool.
*
*
* You must use AWS Developer credentials to call this API.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateIdentityPoolRequest.Builder} avoiding the
* need to create one manually via {@link UpdateIdentityPoolRequest#builder()}
*
*
* @param updateIdentityPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentity.model.UpdateIdentityPoolRequest.Builder} to create
* a request. An object representing an Amazon Cognito identity pool.
* @return 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
* {@link 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.
*
* @sample CognitoIdentityAsyncClient.UpdateIdentityPool
* @see AWS API Documentation
*/
default CompletableFuture updateIdentityPool(
Consumer updateIdentityPoolRequest) {
return updateIdentityPool(UpdateIdentityPoolRequest.builder().applyMutation(updateIdentityPoolRequest).build());
}
@Override
default CognitoIdentityServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link CognitoIdentityAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static CognitoIdentityAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link CognitoIdentityAsyncClient}.
*/
static CognitoIdentityAsyncClientBuilder builder() {
return new DefaultCognitoIdentityAsyncClientBuilder();
}
}