@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCognitoIdentity
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCognitoIdentity
instead.
Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.
For more information see Amazon Cognito Federated Identities.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
DeleteIdentityPoolResult |
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
IdentityId s, existing in the same identity pool, and identified by
the same developer provider. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetIdentityPoolRolesResult |
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)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
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.
|
UnlinkDeveloperIdentityResult |
unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
UnlinkIdentityResult |
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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
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 keys for SupportedLoginProviders
are as follows:
Facebook: graph.facebook.com
Google: accounts.google.com
Amazon: www.amazon.com
Twitter: api.twitter.com
Digits: www.digits.com
You must use AWS Developer credentials to call this API.
createIdentityPoolRequest
- Input to the CreateIdentityPool action.InvalidParameterException
- Thrown for missing or bad input parameter(s).NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.LimitExceededException
- Thrown when the total number of user pools has exceeded a preset limit.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.
deleteIdentitiesRequest
- Input to the DeleteIdentities
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.DeleteIdentityPoolResult deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
deleteIdentityPoolRequest
- Input to the DeleteIdentityPool action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.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.
describeIdentityRequest
- Input to the DescribeIdentity
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.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.
describeIdentityPoolRequest
- Input to the DescribeIdentityPool action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
getCredentialsForIdentityRequest
- Input to the GetCredentialsForIdentity
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InvalidIdentityPoolConfigurationException
- Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the
AssumeRole fails.InternalErrorException
- Thrown when the service encounters an error during processing the request.ExternalServiceException
- An exception thrown when a dependent service such as Facebook or Twitter is not respondingGetIdResult getId(GetIdRequest getIdRequest)
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
getIdRequest
- Input to the GetId action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.LimitExceededException
- Thrown when the total number of user pools has exceeded a preset limit.ExternalServiceException
- An exception thrown when a dependent service such as Facebook or Twitter is not respondingGetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesRequest
- Input to the GetIdentityPoolRoles
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.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 10 minutes.
This is a public API. You do not need any credentials to call this API.
getOpenIdTokenRequest
- Input to the GetOpenIdToken action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ExternalServiceException
- An exception thrown when a dependent service such as Facebook or Twitter is not respondingGetOpenIdTokenForDeveloperIdentityResult 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.
getOpenIdTokenForDeveloperIdentityRequest
- Input to the GetOpenIdTokenForDeveloperIdentity
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.DeveloperUserAlreadyRegisteredException
- The provided developer user identifier is already registered with Cognito under a different identity ID.GetPrincipalTagAttributeMapResult getPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest getPrincipalTagAttributeMapRequest)
Use GetPrincipalTagAttributeMap
to list all mappings between PrincipalTags
and user
attributes.
getPrincipalTagAttributeMapRequest
- InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
listIdentitiesRequest
- Input to the ListIdentities action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
listIdentityPoolsRequest
- Input to the ListIdentityPools action.InvalidParameterException
- Thrown for missing or bad input parameter(s).NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.InternalErrorException
- Thrown when the service encounters an error during processing the request.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito identity pool.
A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
listTagsForResourceRequest
- InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.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.
Either IdentityID
or DeveloperUserIdentifier
must not be null. If you supply only one
of these values, the other value will be searched in the database and returned as a part of the response. If you
supply both, DeveloperUserIdentifier
will be matched against IdentityID
. If the values
are verified against the database, the response returns both values and is the same as the request. Otherwise a
ResourceConflictException
is thrown.
LookupDeveloperIdentity
is intended for low-throughput control plane operations: for example, to
enable customer service to locate an identity ID by username. If you are using it for higher-volume operations
such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity
is a better option for higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.
lookupDeveloperIdentityRequest
- Input to the LookupDeveloperIdentityInput
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.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.
The number of linked logins is limited to 20. So, the number of linked logins for the source user,
SourceUserIdentifier
, and the destination user, DestinationUserIdentifier
, together
should not be larger than 20. Otherwise, an exception will be thrown.
You must use AWS Developer credentials to call this API.
mergeDeveloperIdentitiesRequest
- Input to the MergeDeveloperIdentities
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.SetIdentityPoolRolesResult 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.
setIdentityPoolRolesRequest
- Input to the SetIdentityPoolRoles
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ConcurrentModificationException
- Thrown if there are parallel requests to modify a resource.SetPrincipalTagAttributeMapResult setPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest setPrincipalTagAttributeMapRequest)
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
setPrincipalTagAttributeMapRequest
- InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of an identity pool, one for testing and another for production,
you might assign an Environment
tag key to both identity pools. The value of this key might be
Test
for one identity pool and Production
for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
tagResourceRequest
- InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.UnlinkDeveloperIdentityResult 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.
You must use AWS Developer credentials to call this API.
unlinkDeveloperIdentityRequest
- Input to the UnlinkDeveloperIdentity
action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.UnlinkIdentityResult 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.
unlinkIdentityRequest
- Input to the UnlinkIdentity action.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ExternalServiceException
- An exception thrown when a dependent service such as Facebook or Twitter is not respondingUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
untagResourceRequest
- InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates an identity pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolRequest
- An object representing an Amazon Cognito identity pool.InvalidParameterException
- Thrown for missing or bad input parameter(s).ResourceNotFoundException
- Thrown when the requested resource (for example, a dataset or record) does not exist.NotAuthorizedException
- Thrown when a user is not authorized to access the requested resource.ResourceConflictException
- Thrown when a user tries to use a login which is already linked to another account.TooManyRequestsException
- Thrown when a request is throttled.InternalErrorException
- Thrown when the service encounters an error during processing the request.ConcurrentModificationException
- Thrown if there are parallel requests to modify a resource.LimitExceededException
- Thrown when the total number of user pools has exceeded a preset limit.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.