com.amazonaws.services.cognitoidentity

Class AmazonCognitoIdentityClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitoidentity.AmazonCognitoIdentityClient

All Implemented Interfaces:

AmazonCognitoIdentity

Direct Known Subclasses:

AmazonCognitoIdentityAsyncClient

public class AmazonCognitoIdentityClient
extends AmazonWebServiceClient
implements AmazonCognitoIdentity

Client for accessing AmazonCognitoIdentity. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Cognito

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 .

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonCognitoIdentity exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCognitoIdentityClient() Constructs a new client to invoke service methods on AmazonCognitoIdentity.
AmazonCognitoIdentityClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials.
AmazonCognitoIdentityClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials and client configuration options.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider and client configuration options.
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCognitoIdentity.

Method Summary

Methods

Modifier and Type	Method and Description
CreateIdentityPoolResult	createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest) Creates a new identity pool.
DeleteIdentitiesResult	deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest) Deletes identities from an identity pool.
void	deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest) Deletes a user pool.
DescribeIdentityResult	describeIdentity(DescribeIdentityRequest describeIdentityRequest) Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
DescribeIdentityPoolResult	describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest) Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCredentialsForIdentityResult	getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) Returns credentials for the the provided identity ID.
GetIdResult	getId(GetIdRequest getIdRequest) Generates (or retrieves) a Cognito ID.
GetIdentityPoolRolesResult	getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) Gets the roles for an identity pool.
GetOpenIdTokenResult	getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest) Gets an OpenID token, using a known Cognito ID.
GetOpenIdTokenForDeveloperIdentityResult	getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest) Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.
ListIdentitiesResult	listIdentities(ListIdentitiesRequest listIdentitiesRequest) Lists the identities in a pool.
ListIdentityPoolsResult	listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest) Lists all of the Cognito identity pools registered for your account.
LookupDeveloperIdentityResult	lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s associated with an IdentityId for an existing identity.
MergeDeveloperIdentitiesResult	mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) Merges two users having different IdentityId s, existing in the same identity pool, and identified by the same developer provider.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cognito-identity.us-east-1.amazonaws.com/").
void	setEndpoint(String endpoint, String serviceName, String regionId)
void	setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) Sets the roles for an identity pool.
void	unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest) Unlinks a DeveloperUserIdentifier from an existing identity.
void	unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest) Unlinks a federated identity from an existing account.
UpdateIdentityPoolResult	updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) Updates a user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonCognitoIdentity exceptions.

Constructor Detail

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient()

Constructs a new client to invoke service methods on AmazonCognitoIdentity. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoIdentity. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentials awsCredentials,
                           ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

AmazonCognitoIdentityClient

public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration,
                           RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonCognitoIdentity using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoIdentity (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

unlinkDeveloperIdentity

public void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

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

Specified by:

unlinkDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

unlinkDeveloperIdentityRequest - Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method on AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

deleteIdentities

public DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest)

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Specified by:

deleteIdentities in interface AmazonCognitoIdentity

Parameters:

deleteIdentitiesRequest - Container for the necessary parameters to execute the DeleteIdentities service method on AmazonCognitoIdentity.

Returns:

The response from the DeleteIdentities service method, as returned by AmazonCognitoIdentity.

Throws:

InternalErrorException

InvalidParameterException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

describeIdentityPool

public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Specified by:

describeIdentityPool in interface AmazonCognitoIdentity

Parameters:

describeIdentityPoolRequest - Container for the necessary parameters to execute the DescribeIdentityPool service method on AmazonCognitoIdentity.

Returns:

The response from the DescribeIdentityPool service method, as returned by AmazonCognitoIdentity.

Throws:

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getId

public GetIdResult getId(GetIdRequest getIdRequest)

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

token+";"+tokenSecret.

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

Specified by:

getId in interface AmazonCognitoIdentity

Parameters:

getIdRequest - Container for the necessary parameters to execute the GetId service method on AmazonCognitoIdentity.

Returns:

The response from the GetId service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

LimitExceededException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

deleteIdentityPool

public void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)

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.

Specified by:

deleteIdentityPool in interface AmazonCognitoIdentity

Parameters:

deleteIdentityPoolRequest - Container for the necessary parameters to execute the DeleteIdentityPool service method on AmazonCognitoIdentity.

Throws:

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

updateIdentityPool

public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)

Updates a user pool.

You must use AWS Developer credentials to call this API.

Specified by:

updateIdentityPool in interface AmazonCognitoIdentity

Parameters:

updateIdentityPoolRequest - Container for the necessary parameters to execute the UpdateIdentityPool service method on AmazonCognitoIdentity.

Returns:

The response from the UpdateIdentityPool service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

ConcurrentModificationException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getCredentialsForIdentity

public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)

Returns credentials for the 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.

Specified by:

getCredentialsForIdentity in interface AmazonCognitoIdentity

Parameters:

getCredentialsForIdentityRequest - Container for the necessary parameters to execute the GetCredentialsForIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the GetCredentialsForIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

InvalidIdentityPoolConfigurationException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

mergeDeveloperIdentities

public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)

Merges two users having different IdentityId s, 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.

Specified by:

mergeDeveloperIdentities in interface AmazonCognitoIdentity

Parameters:

mergeDeveloperIdentitiesRequest - Container for the necessary parameters to execute the MergeDeveloperIdentities service method on AmazonCognitoIdentity.

Returns:

The response from the MergeDeveloperIdentities service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

listIdentityPools

public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)

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

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

Specified by:

listIdentityPools in interface AmazonCognitoIdentity

Parameters:

listIdentityPoolsRequest - Container for the necessary parameters to execute the ListIdentityPools service method on AmazonCognitoIdentity.

Returns:

The response from the ListIdentityPools service method, as returned by AmazonCognitoIdentity.

Throws:

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getOpenIdToken

public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

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

Specified by:

getOpenIdToken in interface AmazonCognitoIdentity

Parameters:

getOpenIdTokenRequest - Container for the necessary parameters to execute the GetOpenIdToken service method on AmazonCognitoIdentity.

Returns:

The response from the GetOpenIdToken service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

lookupDeveloperIdentity

public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier s 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.

Specified by:

lookupDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

lookupDeveloperIdentityRequest - Container for the necessary parameters to execute the LookupDeveloperIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the LookupDeveloperIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

describeIdentity

public DescribeIdentityResult describeIdentity(DescribeIdentityRequest describeIdentityRequest)

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Specified by:

describeIdentity in interface AmazonCognitoIdentity

Parameters:

describeIdentityRequest - Container for the necessary parameters to execute the DescribeIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the DescribeIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

setIdentityPoolRoles

public void setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Specified by:

setIdentityPoolRoles in interface AmazonCognitoIdentity

Parameters:

setIdentityPoolRolesRequest - Container for the necessary parameters to execute the SetIdentityPoolRoles service method on AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

ConcurrentModificationException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

unlinkIdentity

public void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

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

Specified by:

unlinkIdentity in interface AmazonCognitoIdentity

Parameters:

unlinkIdentityRequest - Container for the necessary parameters to execute the UnlinkIdentity service method on AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

ExternalServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

listIdentities

public ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Specified by:

listIdentities in interface AmazonCognitoIdentity

Parameters:

listIdentitiesRequest - Container for the necessary parameters to execute the ListIdentities service method on AmazonCognitoIdentity.

Returns:

The response from the ListIdentities service method, as returned by AmazonCognitoIdentity.

Throws:

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getIdentityPoolRoles

public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Specified by:

getIdentityPoolRoles in interface AmazonCognitoIdentity

Parameters:

getIdentityPoolRolesRequest - Container for the necessary parameters to execute the GetIdentityPoolRoles service method on AmazonCognitoIdentity.

Returns:

The response from the GetIdentityPoolRoles service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getOpenIdTokenForDeveloperIdentity

public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId . This API will create the identity in the specified IdentityPoolId .

You must use AWS Developer credentials to call this API.

Specified by:

getOpenIdTokenForDeveloperIdentity in interface AmazonCognitoIdentity

Parameters:

getOpenIdTokenForDeveloperIdentityRequest - Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

DeveloperUserAlreadyRegisteredException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

createIdentityPool

public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. You must use AWS Developer credentials to call this API.

Specified by:

createIdentityPool in interface AmazonCognitoIdentity

Parameters:

createIdentityPoolRequest - Container for the necessary parameters to execute the CreateIdentityPool service method on AmazonCognitoIdentity.

Returns:

The response from the CreateIdentityPool service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

LimitExceededException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonCognitoIdentity

Overrides the default endpoint for this client ("https://cognito-identity.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cognito-identity.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cognito-identity.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setEndpoint in interface AmazonCognitoIdentity

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "cognito-identity.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cognito-identity.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonCognitoIdentity

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.