com.amazonaws.services.cognitoidentity

Interface AmazonCognitoIdentity

All Known Implementing Classes:

AmazonCognitoIdentityClient

public interface AmazonCognitoIdentity

Interface for accessing Amazon Cognito Identity Amazon Cognito Federated Identities

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

Method Summary

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 an identity 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 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.
GetPrincipalTagAttributeMapResult	getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest) Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.
ListIdentitiesResult	listIdentities(ListIdentitiesRequest listIdentitiesRequest) Lists the identities in an identity pool.
ListIdentityPoolsResult	listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest) Lists all of the Cognito identity pools registered for your account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are assigned to an Amazon Cognito identity pool.
LookupDeveloperIdentityResult	lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest) Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
MergeDeveloperIdentitiesResult	mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest) Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://cognito-identity.us-east-1.amazonaws.com").
void	setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) Sets the roles for an identity pool.
SetPrincipalTagAttributeMapResult	setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest) You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
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.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns a set of tags to the specified Amazon Cognito 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.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Cognito identity pool.
UpdateIdentityPoolResult	updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest) Updates an identity pool.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.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:

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

setRegion

void setRegion(Region region)
        throws java.lang.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:

java.lang.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)

createIdentityPool

CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

• Facebook: graph.facebook.com

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Parameters:

createIdentityPoolRequest -

Input to the CreateIdentityPool action.

Returns:

createIdentityPoolResult The response from the CreateIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

LimitExceededException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

deleteIdentities

DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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.

Parameters:

deleteIdentitiesRequest -

Input to the DeleteIdentities action.

Returns:

deleteIdentitiesResult The response from the DeleteIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

deleteIdentityPool

void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
                 throws AmazonClientException,
                        AmazonServiceException

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

You must use AWS Developer credentials to call this API.

Parameters:

deleteIdentityPoolRequest -

Input to the DeleteIdentityPool action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

describeIdentity

DescribeIdentityResult describeIdentity(DescribeIdentityRequest describeIdentityRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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.

Parameters:

describeIdentityRequest -

Input to the DescribeIdentity action.

Returns:

describeIdentityResult The response from the DescribeIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

describeIdentityPool

DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

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.

Parameters:

describeIdentityPoolRequest -

Input to the DescribeIdentityPool action.

Returns:

describeIdentityPoolResult The response from the DescribeIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getCredentialsForIdentity

GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

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.

Parameters:

getCredentialsForIdentityRequest -

Input to the GetCredentialsForIdentity action.

Returns:

getCredentialsForIdentityResult The response from the GetCredentialsForIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InvalidIdentityPoolConfigurationException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getId

GetIdResult getId(GetIdRequest getIdRequest)
           throws AmazonClientException,
                  AmazonServiceException

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.

Parameters:

getIdRequest -

Input to the GetId action.

Returns:

getIdResult The response from the GetId service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

LimitExceededException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getIdentityPoolRoles

GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

getIdentityPoolRolesRequest -

Input to the GetIdentityPoolRoles action.

Returns:

getIdentityPoolRolesResult The response from the GetIdentityPoolRoles service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getOpenIdToken

GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

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

The OpenID token is valid for 10 minutes.

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

Parameters:

getOpenIdTokenRequest -

Input to the GetOpenIdToken action.

Returns:

getOpenIdTokenResult The response from the GetOpenIdToken service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getOpenIdTokenForDeveloperIdentity

GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
                                                                     throws AmazonClientException,
                                                                            AmazonServiceException

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.

Parameters:

getOpenIdTokenForDeveloperIdentityRequest -

Input to the GetOpenIdTokenForDeveloperIdentity action.

Returns:

getOpenIdTokenForDeveloperIdentityResult The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

DeveloperUserAlreadyRegisteredException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

getPrincipalTagAttributeMap

GetPrincipalTagAttributeMapResult getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

Parameters:

getPrincipalTagAttributeMapRequest -

Returns:

getPrincipalTagAttributeMapResult The response from the GetPrincipalTagAttributeMap service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

listIdentities

ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

listIdentitiesRequest -

Input to the ListIdentities action.

Returns:

listIdentitiesResult The response from the ListIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

listIdentityPools

ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

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

You must use AWS Developer credentials to call this API.

Parameters:

listIdentityPoolsRequest -

Input to the ListIdentityPools action.

Returns:

listIdentityPoolsResult The response from the ListIdentityPools service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

ResourceNotFoundException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Lists the tags that are assigned to an Amazon Cognito identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

Parameters:

listTagsForResourceRequest -

Returns:

listTagsForResourceResult The response from the ListTagsForResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

lookupDeveloperIdentity

LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.

You must use AWS Developer credentials to call this API.

Parameters:

lookupDeveloperIdentityRequest -

Input to the LookupDeveloperIdentityInput action.

Returns:

lookupDeveloperIdentityResult The response from the LookupDeveloperIdentity service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

mergeDeveloperIdentities

MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use AWS Developer credentials to call this API.

Parameters:

mergeDeveloperIdentitiesRequest -

Input to the MergeDeveloperIdentities action.

Returns:

mergeDeveloperIdentitiesResult The response from the MergeDeveloperIdentities service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

setIdentityPoolRoles

void setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
                   throws AmazonClientException,
                          AmazonServiceException

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.

Parameters:

setIdentityPoolRolesRequest -

Input to the SetIdentityPoolRoles action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

ConcurrentModificationException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

setPrincipalTagAttributeMap

SetPrincipalTagAttributeMapResult setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

Parameters:

setPrincipalTagAttributeMapRequest -

Returns:

setPrincipalTagAttributeMapResult The response from the SetPrincipalTagAttributeMap service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

Parameters:

tagResourceRequest -

Returns:

tagResourceResult The response from the TagResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

unlinkDeveloperIdentity

void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
                      throws AmazonClientException,
                             AmazonServiceException

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.

Parameters:

unlinkDeveloperIdentityRequest -

Input to the UnlinkDeveloperIdentity action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

unlinkIdentity

void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
             throws AmazonClientException,
                    AmazonServiceException

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.

Parameters:

unlinkIdentityRequest -

Input to the UnlinkIdentity action.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

Parameters:

untagResourceRequest -

Returns:

untagResourceResult The response from the UntagResource service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

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 Amazon Cognito Identity indicating either a problem with the data in the request, or a server side issue.

updateIdentityPool

UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Parameters:

updateIdentityPoolRequest -

An object representing an Amazon Cognito identity pool.

Returns:

updateIdentityPoolResult The response from the UpdateIdentityPool service method, as returned by Amazon Cognito Identity.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

ResourceConflictException

TooManyRequestsException

InternalErrorException

ConcurrentModificationException

LimitExceededException

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 Amazon Cognito Identity 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.