com.amazonaws.services.cognitoidentity

Interface AmazonCognitoIdentity

All Known Subinterfaces:

AmazonCognitoIdentityAsync

All Known Implementing Classes:

AmazonCognitoIdentityAsyncClient, AmazonCognitoIdentityClient

public interface AmazonCognitoIdentity

Interface for accessing AmazonCognitoIdentity. 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 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.

Method Summary

Methods

Modifier and Type	Method and Description
CreateIdentityPoolResult	createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest) Creates a new identity pool.
void	deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest) Deletes a user pool.
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.
GetIdResult	getId(GetIdRequest getIdRequest) Generates (or retrieves) a Cognito ID.
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	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
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.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

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.

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.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region 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.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

listIdentityPools

ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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

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.

mergeDeveloperIdentities

MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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.

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.

getOpenIdToken

GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

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

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.

unlinkDeveloperIdentity

void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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.

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.

lookupDeveloperIdentity

LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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.

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.

unlinkIdentity

void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
                    throws AmazonServiceException,
                           AmazonClientException

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.

Parameters:

unlinkIdentityRequest - Container for the necessary parameters to execute the UnlinkIdentity 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.

describeIdentityPool

DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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

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.

listIdentities

ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Lists the identities in a pool.

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.

deleteIdentityPool

void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

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.

getId

GetIdResult getId(GetIdRequest getIdRequest)
                  throws AmazonServiceException,
                         AmazonClientException

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

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

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

GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

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 .

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.

updateIdentityPool

UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Updates a user pool.

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

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.

createIdentityPool

CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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