@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CognitoIdentityClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static CognitoIdentityClientBuilder |
builder()
Create a builder that can be used to configure and create a
CognitoIdentityClient. |
static CognitoIdentityClient |
create()
Create a
CognitoIdentityClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateIdentityPoolResponse |
createIdentityPool(Consumer<CreateIdentityPoolRequest.Builder> createIdentityPoolRequest)
Creates a new identity pool.
|
default CreateIdentityPoolResponse |
createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
Creates a new identity pool.
|
default DeleteIdentitiesResponse |
deleteIdentities(Consumer<DeleteIdentitiesRequest.Builder> deleteIdentitiesRequest)
Deletes identities from an identity pool.
|
default DeleteIdentitiesResponse |
deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest)
Deletes identities from an identity pool.
|
default DeleteIdentityPoolResponse |
deleteIdentityPool(Consumer<DeleteIdentityPoolRequest.Builder> deleteIdentityPoolRequest)
Deletes an identity pool.
|
default DeleteIdentityPoolResponse |
deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
Deletes an identity pool.
|
default DescribeIdentityResponse |
describeIdentity(Consumer<DescribeIdentityRequest.Builder> describeIdentityRequest)
Returns metadata related to the given identity, including when the identity was created and any associated linked
logins.
|
default DescribeIdentityResponse |
describeIdentity(DescribeIdentityRequest describeIdentityRequest)
Returns metadata related to the given identity, including when the identity was created and any associated linked
logins.
|
default DescribeIdentityPoolResponse |
describeIdentityPool(Consumer<DescribeIdentityPoolRequest.Builder> describeIdentityPoolRequest)
Gets details about a particular identity pool, including the pool name, ID description, creation date, and
current number of users.
|
default DescribeIdentityPoolResponse |
describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
Gets details about a particular identity pool, including the pool name, ID description, creation date, and
current number of users.
|
default GetCredentialsForIdentityResponse |
getCredentialsForIdentity(Consumer<GetCredentialsForIdentityRequest.Builder> getCredentialsForIdentityRequest)
Returns credentials for the provided identity ID.
|
default GetCredentialsForIdentityResponse |
getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
Returns credentials for the provided identity ID.
|
default GetIdResponse |
getId(Consumer<GetIdRequest.Builder> getIdRequest)
Generates (or retrieves) a Cognito ID.
|
default GetIdResponse |
getId(GetIdRequest getIdRequest)
Generates (or retrieves) a Cognito ID.
|
default GetIdentityPoolRolesResponse |
getIdentityPoolRoles(Consumer<GetIdentityPoolRolesRequest.Builder> getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
|
default GetIdentityPoolRolesResponse |
getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
|
default GetOpenIdTokenResponse |
getOpenIdToken(Consumer<GetOpenIdTokenRequest.Builder> getOpenIdTokenRequest)
Gets an OpenID token, using a known Cognito ID.
|
default GetOpenIdTokenResponse |
getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
Gets an OpenID token, using a known Cognito ID.
|
default GetOpenIdTokenForDeveloperIdentityResponse |
getOpenIdTokenForDeveloperIdentity(Consumer<GetOpenIdTokenForDeveloperIdentityRequest.Builder> getOpenIdTokenForDeveloperIdentityRequest)
Registers (or retrieves) a Cognito
IdentityId and an OpenID Connect token for a user authenticated
by your backend authentication process. |
default GetOpenIdTokenForDeveloperIdentityResponse |
getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
Registers (or retrieves) a Cognito
IdentityId and an OpenID Connect token for a user authenticated
by your backend authentication process. |
default GetPrincipalTagAttributeMapResponse |
getPrincipalTagAttributeMap(Consumer<GetPrincipalTagAttributeMapRequest.Builder> getPrincipalTagAttributeMapRequest)
Use
GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes. |
default GetPrincipalTagAttributeMapResponse |
getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest)
Use
GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes. |
default ListIdentitiesResponse |
listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)
Lists the identities in an identity pool.
|
default ListIdentitiesResponse |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in an identity pool.
|
default ListIdentityPoolsResponse |
listIdentityPools(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default ListIdentityPoolsResponse |
listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default ListIdentityPoolsIterable |
listIdentityPoolsPaginator(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default ListIdentityPoolsIterable |
listIdentityPoolsPaginator(ListIdentityPoolsRequest listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito identity pool.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito identity pool.
|
default LookupDeveloperIdentityResponse |
lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier values associated with an IdentityId for an existing identity. |
default LookupDeveloperIdentityResponse |
lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier values associated with an IdentityId for an existing identity. |
default MergeDeveloperIdentitiesResponse |
mergeDeveloperIdentities(Consumer<MergeDeveloperIdentitiesRequest.Builder> mergeDeveloperIdentitiesRequest)
Merges two users having different
IdentityIds, existing in the same identity pool, and identified by
the same developer provider. |
default MergeDeveloperIdentitiesResponse |
mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
Merges two users having different
IdentityIds, existing in the same identity pool, and identified by
the same developer provider. |
default CognitoIdentityServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default SetIdentityPoolRolesResponse |
setIdentityPoolRoles(Consumer<SetIdentityPoolRolesRequest.Builder> setIdentityPoolRolesRequest)
Sets the roles for an identity pool.
|
default SetIdentityPoolRolesResponse |
setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
Sets the roles for an identity pool.
|
default SetPrincipalTagAttributeMapResponse |
setPrincipalTagAttributeMap(Consumer<SetPrincipalTagAttributeMapRequest.Builder> setPrincipalTagAttributeMapRequest)
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
|
default SetPrincipalTagAttributeMapResponse |
setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest)
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns a set of tags to the specified Amazon Cognito identity pool.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to the specified Amazon Cognito identity pool.
|
default UnlinkDeveloperIdentityResponse |
unlinkDeveloperIdentity(Consumer<UnlinkDeveloperIdentityRequest.Builder> unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
default UnlinkDeveloperIdentityResponse |
unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
default UnlinkIdentityResponse |
unlinkIdentity(Consumer<UnlinkIdentityRequest.Builder> unlinkIdentityRequest)
Unlinks a federated identity from an existing account.
|
default UnlinkIdentityResponse |
unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
Unlinks a federated identity from an existing account.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified Amazon Cognito identity pool.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Cognito identity pool.
|
default UpdateIdentityPoolResponse |
updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest)
Updates an identity pool.
|
default UpdateIdentityPoolResponse |
updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates an identity pool.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateIdentityPoolResponse createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest) throws InvalidParameterException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, LimitExceededException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
createIdentityPoolRequest - Input to the CreateIdentityPool action.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.AwsServiceExceptiondefault CreateIdentityPoolResponse createIdentityPool(Consumer<CreateIdentityPoolRequest.Builder> createIdentityPoolRequest) throws InvalidParameterException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, LimitExceededException, AwsServiceException, SdkClientException, CognitoIdentityException
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your
AWS account. The keys for SupportedLoginProviders are as follows:
Facebook: graph.facebook.com
Google: accounts.google.com
Amazon: www.amazon.com
Twitter: api.twitter.com
Digits: www.digits.com
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the CreateIdentityPoolRequest.Builder avoiding the
need to create one manually via CreateIdentityPoolRequest.builder()
createIdentityPoolRequest - A Consumer that will call methods on
CreateIdentityPoolRequest.Builder to create
a request. Input to the CreateIdentityPool action.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.AwsServiceExceptiondefault DeleteIdentitiesResponse deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest) throws InvalidParameterException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
deleteIdentitiesRequest - Input to the DeleteIdentities action.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.AwsServiceExceptiondefault DeleteIdentitiesResponse deleteIdentities(Consumer<DeleteIdentitiesRequest.Builder> deleteIdentitiesRequest) throws InvalidParameterException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the DeleteIdentitiesRequest.Builder avoiding the need
to create one manually via DeleteIdentitiesRequest.builder()
deleteIdentitiesRequest - A Consumer that will call methods on
DeleteIdentitiesRequest.Builder to create a
request. Input to the DeleteIdentities action.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.AwsServiceExceptiondefault DeleteIdentityPoolResponse deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
deleteIdentityPoolRequest - Input to the DeleteIdentityPool action.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.AwsServiceExceptiondefault DeleteIdentityPoolResponse deleteIdentityPool(Consumer<DeleteIdentityPoolRequest.Builder> deleteIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the DeleteIdentityPoolRequest.Builder avoiding the
need to create one manually via DeleteIdentityPoolRequest.builder()
deleteIdentityPoolRequest - A Consumer that will call methods on
DeleteIdentityPoolRequest.Builder to create
a request. Input to the DeleteIdentityPool action.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.AwsServiceExceptiondefault DescribeIdentityResponse describeIdentity(DescribeIdentityRequest describeIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
describeIdentityRequest - Input to the DescribeIdentity action.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.AwsServiceExceptiondefault DescribeIdentityResponse describeIdentity(Consumer<DescribeIdentityRequest.Builder> describeIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the DescribeIdentityRequest.Builder avoiding the need
to create one manually via DescribeIdentityRequest.builder()
describeIdentityRequest - A Consumer that will call methods on
DescribeIdentityRequest.Builder to create a
request. Input to the DescribeIdentity action.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.AwsServiceExceptiondefault DescribeIdentityPoolResponse describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
describeIdentityPoolRequest - Input to the DescribeIdentityPool action.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.AwsServiceExceptiondefault DescribeIdentityPoolResponse describeIdentityPool(Consumer<DescribeIdentityPoolRequest.Builder> describeIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the DescribeIdentityPoolRequest.Builder avoiding the
need to create one manually via DescribeIdentityPoolRequest.builder()
describeIdentityPoolRequest - A Consumer that will call methods on
DescribeIdentityPoolRequest.Builder to
create a request. Input to the DescribeIdentityPool action.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.AwsServiceExceptiondefault GetCredentialsForIdentityResponse getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InvalidIdentityPoolConfigurationException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
getCredentialsForIdentityRequest - Input to the GetCredentialsForIdentity action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetCredentialsForIdentityResponse getCredentialsForIdentity(Consumer<GetCredentialsForIdentityRequest.Builder> getCredentialsForIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InvalidIdentityPoolConfigurationException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
This is a convenience which creates an instance of the GetCredentialsForIdentityRequest.Builder avoiding
the need to create one manually via GetCredentialsForIdentityRequest.builder()
getCredentialsForIdentityRequest - A Consumer that will call methods on
GetCredentialsForIdentityRequest.Builder to
create a request. Input to the GetCredentialsForIdentity action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetIdResponse getId(GetIdRequest getIdRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, LimitExceededException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
getIdRequest - Input to the GetId action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetIdResponse getId(Consumer<GetIdRequest.Builder> getIdRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, LimitExceededException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
This is a convenience which creates an instance of the GetIdRequest.Builder avoiding the need to create
one manually via GetIdRequest.builder()
getIdRequest - A Consumer that will call methods on
GetIdRequest.Builder to create a request.
Input to the GetId action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetIdentityPoolRolesResponse getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesRequest - Input to the GetIdentityPoolRoles action.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.AwsServiceExceptiondefault GetIdentityPoolRolesResponse getIdentityPoolRoles(Consumer<GetIdentityPoolRolesRequest.Builder> getIdentityPoolRolesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the GetIdentityPoolRolesRequest.Builder avoiding the
need to create one manually via GetIdentityPoolRolesRequest.builder()
getIdentityPoolRolesRequest - A Consumer that will call methods on
GetIdentityPoolRolesRequest.Builder to
create a request. Input to the GetIdentityPoolRoles action.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.AwsServiceExceptiondefault GetOpenIdTokenResponse getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
getOpenIdTokenRequest - Input to the GetOpenIdToken action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetOpenIdTokenResponse getOpenIdToken(Consumer<GetOpenIdTokenRequest.Builder> getOpenIdTokenRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenID token is valid for 10 minutes.
This is a public API. You do not need any credentials to call this API.
This is a convenience which creates an instance of the GetOpenIdTokenRequest.Builder avoiding the need to
create one manually via GetOpenIdTokenRequest.builder()
getOpenIdTokenRequest - A Consumer that will call methods on
GetOpenIdTokenRequest.Builder to create a
request. Input to the GetOpenIdToken action.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 respondingSdkException - 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.AwsServiceExceptiondefault GetOpenIdTokenForDeveloperIdentityResponse getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, DeveloperUserAlreadyRegisteredException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
getOpenIdTokenForDeveloperIdentityRequest - Input to the GetOpenIdTokenForDeveloperIdentity action.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.AwsServiceExceptiondefault GetOpenIdTokenForDeveloperIdentityResponse getOpenIdTokenForDeveloperIdentity(Consumer<GetOpenIdTokenForDeveloperIdentityRequest.Builder> getOpenIdTokenForDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, DeveloperUserAlreadyRegisteredException, AwsServiceException, SdkClientException, CognitoIdentityException
Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated
by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can
only specify one developer provider as part of the Logins map, which is linked to the identity pool.
The developer provider is the "domain" by which Cognito will refer to your users.
You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that
is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to
create a new identity, the IdentityId should be null. When you want to associate a new login with an
existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId.
This API will create the identity in the specified IdentityPoolId.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the GetOpenIdTokenForDeveloperIdentityRequest.Builder
avoiding the need to create one manually via GetOpenIdTokenForDeveloperIdentityRequest.builder()
getOpenIdTokenForDeveloperIdentityRequest - A Consumer that will call methods on
GetOpenIdTokenForDeveloperIdentityRequest.Builder
to create a request. Input to the GetOpenIdTokenForDeveloperIdentity action.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.AwsServiceExceptiondefault GetPrincipalTagAttributeMapResponse getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes.
getPrincipalTagAttributeMapRequest - 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.AwsServiceExceptiondefault GetPrincipalTagAttributeMapResponse getPrincipalTagAttributeMap(Consumer<GetPrincipalTagAttributeMapRequest.Builder> getPrincipalTagAttributeMapRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes.
This is a convenience which creates an instance of the GetPrincipalTagAttributeMapRequest.Builder
avoiding the need to create one manually via GetPrincipalTagAttributeMapRequest.builder()
getPrincipalTagAttributeMapRequest - A Consumer that will call methods on
GetPrincipalTagAttributeMapRequest.Builder
to create a request.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.AwsServiceExceptiondefault ListIdentitiesResponse listIdentities(ListIdentitiesRequest listIdentitiesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
listIdentitiesRequest - Input to the ListIdentities action.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.AwsServiceExceptiondefault ListIdentitiesResponse listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the ListIdentitiesRequest.Builder avoiding the need to
create one manually via ListIdentitiesRequest.builder()
listIdentitiesRequest - A Consumer that will call methods on
ListIdentitiesRequest.Builder to create a
request. Input to the ListIdentities action.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.AwsServiceExceptiondefault ListIdentityPoolsResponse listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
listIdentityPoolsRequest - Input to the ListIdentityPools action.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.AwsServiceExceptiondefault ListIdentityPoolsResponse listIdentityPools(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the ListIdentityPoolsRequest.Builder avoiding the need
to create one manually via ListIdentityPoolsRequest.builder()
listIdentityPoolsRequest - A Consumer that will call methods on
ListIdentityPoolsRequest.Builder to create a
request. Input to the ListIdentityPools action.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.AwsServiceExceptiondefault ListIdentityPoolsIterable listIdentityPoolsPaginator(ListIdentityPoolsRequest listIdentityPoolsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
This is a variant of
listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client.listIdentityPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client
.listIdentityPoolsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client.listIdentityPoolsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)
operation.
listIdentityPoolsRequest - Input to the ListIdentityPools action.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.AwsServiceExceptiondefault ListIdentityPoolsIterable listIdentityPoolsPaginator(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
This is a variant of
listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client.listIdentityPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client
.listIdentityPoolsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentity.paginators.ListIdentityPoolsIterable responses = client.listIdentityPoolsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityPools(software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest)
operation.
This is a convenience which creates an instance of the ListIdentityPoolsRequest.Builder avoiding the need
to create one manually via ListIdentityPoolsRequest.builder()
listIdentityPoolsRequest - A Consumer that will call methods on
ListIdentityPoolsRequest.Builder to create a
request. Input to the ListIdentityPools action.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists the tags that are assigned to an Amazon Cognito identity pool.
A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create
a request.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.AwsServiceExceptiondefault LookupDeveloperIdentityResponse lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
lookupDeveloperIdentityRequest - Input to the LookupDeveloperIdentityInput action.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.AwsServiceExceptiondefault LookupDeveloperIdentityResponse lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> lookupDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one
of these values, the other value will be searched in the database and returned as a part of the response. If you
supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values
are verified against the database, the response returns both values and is the same as the request. Otherwise a
ResourceConflictException is thrown.
LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to
enable customer service to locate an identity ID by username. If you are using it for higher-volume operations
such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity
is a better option for higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the LookupDeveloperIdentityRequest.Builder avoiding
the need to create one manually via LookupDeveloperIdentityRequest.builder()
lookupDeveloperIdentityRequest - A Consumer that will call methods on
LookupDeveloperIdentityRequest.Builder to
create a request. Input to the LookupDeveloperIdentityInput action.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.AwsServiceExceptiondefault MergeDeveloperIdentitiesResponse mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
mergeDeveloperIdentitiesRequest - Input to the MergeDeveloperIdentities action.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.AwsServiceExceptiondefault MergeDeveloperIdentitiesResponse mergeDeveloperIdentities(Consumer<MergeDeveloperIdentitiesRequest.Builder> mergeDeveloperIdentitiesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Merges two users having different IdentityIds, existing in the same identity pool, and identified by
the same developer provider. You can use this action to request that discrete users be merged and identified as a
single user in the Cognito environment. Cognito associates the given source user (
SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier
. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public
provider, but as two different users, an exception will be thrown.
The number of linked logins is limited to 20. So, the number of linked logins for the source user,
SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together
should not be larger than 20. Otherwise, an exception will be thrown.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the MergeDeveloperIdentitiesRequest.Builder avoiding
the need to create one manually via MergeDeveloperIdentitiesRequest.builder()
mergeDeveloperIdentitiesRequest - A Consumer that will call methods on
MergeDeveloperIdentitiesRequest.Builder to
create a request. Input to the MergeDeveloperIdentities action.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.AwsServiceExceptiondefault SetIdentityPoolRolesResponse setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ConcurrentModificationException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
setIdentityPoolRolesRequest - Input to the SetIdentityPoolRoles action.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.AwsServiceExceptiondefault SetIdentityPoolRolesResponse setIdentityPoolRoles(Consumer<SetIdentityPoolRolesRequest.Builder> setIdentityPoolRolesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ConcurrentModificationException, AwsServiceException, SdkClientException, CognitoIdentityException
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the SetIdentityPoolRolesRequest.Builder avoiding the
need to create one manually via SetIdentityPoolRolesRequest.builder()
setIdentityPoolRolesRequest - A Consumer that will call methods on
SetIdentityPoolRolesRequest.Builder to
create a request. Input to the SetIdentityPoolRoles action.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.AwsServiceExceptiondefault SetPrincipalTagAttributeMapResponse setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
setPrincipalTagAttributeMapRequest - 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.AwsServiceExceptiondefault SetPrincipalTagAttributeMapResponse setPrincipalTagAttributeMap(Consumer<SetPrincipalTagAttributeMapRequest.Builder> setPrincipalTagAttributeMapRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
This is a convenience which creates an instance of the SetPrincipalTagAttributeMapRequest.Builder
avoiding the need to create one manually via SetPrincipalTagAttributeMapRequest.builder()
setPrincipalTagAttributeMapRequest - A Consumer that will call methods on
SetPrincipalTagAttributeMapRequest.Builder
to create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of an identity pool, one for testing and another for production,
you might assign an Environment tag key to both identity pools. The value of this key might be
Test for one identity pool and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UnlinkDeveloperIdentityResponse unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
unlinkDeveloperIdentityRequest - Input to the UnlinkDeveloperIdentity action.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.AwsServiceExceptiondefault UnlinkDeveloperIdentityResponse unlinkDeveloperIdentity(Consumer<UnlinkDeveloperIdentityRequest.Builder> unlinkDeveloperIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be
considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated
identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the UnlinkDeveloperIdentityRequest.Builder avoiding
the need to create one manually via UnlinkDeveloperIdentityRequest.builder()
unlinkDeveloperIdentityRequest - A Consumer that will call methods on
UnlinkDeveloperIdentityRequest.Builder to
create a request. Input to the UnlinkDeveloperIdentity action.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.AwsServiceExceptiondefault UnlinkIdentityResponse unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
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.
unlinkIdentityRequest - Input to the UnlinkIdentity action.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 respondingSdkException - 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.AwsServiceExceptiondefault UnlinkIdentityResponse unlinkIdentity(Consumer<UnlinkIdentityRequest.Builder> unlinkIdentityRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ExternalServiceException, AwsServiceException, SdkClientException, CognitoIdentityException
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
This is a convenience which creates an instance of the UnlinkIdentityRequest.Builder avoiding the need to
create one manually via UnlinkIdentityRequest.builder()
unlinkIdentityRequest - A Consumer that will call methods on
UnlinkIdentityRequest.Builder to create a
request. Input to the UnlinkIdentity action.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 respondingSdkException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UpdateIdentityPoolResponse updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ConcurrentModificationException, LimitExceededException, AwsServiceException, SdkClientException, CognitoIdentityException
Updates an identity pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolRequest - An object representing an Amazon Cognito identity pool.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.AwsServiceExceptiondefault UpdateIdentityPoolResponse updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ConcurrentModificationException, LimitExceededException, AwsServiceException, SdkClientException, CognitoIdentityException
Updates an identity pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the UpdateIdentityPoolRequest.Builder avoiding the
need to create one manually via UpdateIdentityPoolRequest.builder()
updateIdentityPoolRequest - A Consumer that will call methods on
UpdateIdentityPoolRequest.Builder to create
a request. An object representing an Amazon Cognito identity pool.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.AwsServiceExceptionstatic CognitoIdentityClient create()
CognitoIdentityClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CognitoIdentityClientBuilder builder()
CognitoIdentityClient.static ServiceMetadata serviceMetadata()
default CognitoIdentityServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.