@Generated(value="software.amazon.awssdk:codegen") public interface CognitoIdentityClient extends SdkClient
builder() method.
Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with
one of the supported identity providers, set the Logins map with the identity provider token.
GetId returns a unique identifier for the user.
Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map
as the GetId call, as well as the IdentityID originally returned by GetId.
Assuming your identity pool has been configured via the SetIdentityPoolRoles operation,
GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured
with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to
GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call
expects the same Logins map as the GetId call, as well as the IdentityID
originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS
operation
AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
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 a user pool.
|
default DeleteIdentityPoolResponse |
deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
Deletes a user 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 ListIdentitiesResponse |
listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)
Lists the identities in a pool.
|
default ListIdentitiesResponse |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in a 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 LookupDeveloperIdentityResponse |
lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifiers associated with an IdentityId for an existing identity. |
default LookupDeveloperIdentityResponse |
lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifiers 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. |
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 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 UpdateIdentityPoolResponse |
updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest)
Updates a user pool.
|
default UpdateIdentityPoolResponse |
updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates a user pool.
|
serviceNameclosestatic final String SERVICE_NAME
static CognitoIdentityClient create()
CognitoIdentityClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CognitoIdentityClientBuilder builder()
CognitoIdentityClient.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 limit on identity pools is 60 per 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 limit on identity pools is 60 per 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 CreateIdentityPoolInput.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 DeleteIdentitiesInput.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 a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
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 a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
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 DeleteIdentityPoolInput.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 DescribeIdentityInput.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 DescribeIdentityPoolInput.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 GetCredentialsForIdentityInput.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 GetIdInput.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 GetIdentityPoolRolesInput.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 15 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 15 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 GetOpenIdTokenInput.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 GetOpenIdTokenForDeveloperIdentityInput.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 ListIdentitiesResponse listIdentities(ListIdentitiesRequest listIdentitiesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityException
Lists the identities in a 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 a 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 ListIdentitiesInput.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, 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.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, 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 ListIdentityPoolsInput.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.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
DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either
IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these
values, the other value will be searched in the database and returned as a part of the response. If you supply
both, DeveloperUserIdentifier will be matched against IdentityID. If the values are
verified against the database, the response returns both values and is the same as the request. Otherwise a
ResourceConflictException is thrown.
You must use AWS Developer credentials to call this API.
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
DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either
IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these
values, the other value will be searched in the database and returned as a part of the response. If you supply
both, DeveloperUserIdentifier will be matched against IdentityID. If the values are
verified against the database, the response returns both values and is the same as the request. Otherwise a
ResourceConflictException is thrown.
You must use AWS Developer credentials to call this API.
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 LookupDeveloperIdentityInput.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.
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.
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 MergeDeveloperIdentitiesInput.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 SetIdentityPoolRolesInput.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 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 UnlinkDeveloperIdentityInput.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 UnlinkIdentityInput.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 UpdateIdentityPoolResponse updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, ResourceConflictException, TooManyRequestsException, InternalErrorException, ConcurrentModificationException, LimitExceededException, AwsServiceException, SdkClientException, CognitoIdentityException
Updates a user 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 a user 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 IdentityPool.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 ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.