public class AbstractAmazonCognitoIdentity extends Object implements AmazonCognitoIdentity
AmazonCognitoIdentity. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
CreateIdentityPoolResult |
createIdentityPool(CreateIdentityPoolRequest request)
Creates a new identity pool.
|
DeleteIdentitiesResult |
deleteIdentities(DeleteIdentitiesRequest request)
Deletes identities from an identity pool.
|
void |
deleteIdentityPool(DeleteIdentityPoolRequest request)
Deletes a user pool.
|
DescribeIdentityResult |
describeIdentity(DescribeIdentityRequest request)
Returns metadata related to the given identity, including when the
identity was created and any associated linked logins.
|
DescribeIdentityPoolResult |
describeIdentityPool(DescribeIdentityPoolRequest request)
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 request)
Returns credentials for the provided identity ID.
|
GetIdResult |
getId(GetIdRequest request)
Generates (or retrieves) a Cognito ID.
|
GetIdentityPoolRolesResult |
getIdentityPoolRoles(GetIdentityPoolRolesRequest request)
Gets the roles for an identity pool.
|
GetOpenIdTokenResult |
getOpenIdToken(GetOpenIdTokenRequest request)
Gets an OpenID token, using a known Cognito ID.
|
GetOpenIdTokenForDeveloperIdentityResult |
getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request)
Registers (or retrieves) a Cognito
IdentityId and an OpenID
Connect token for a user authenticated by your backend authentication
process. |
ListIdentitiesResult |
listIdentities(ListIdentitiesRequest request)
Lists the identities in a pool.
|
ListIdentityPoolsResult |
listIdentityPools(ListIdentityPoolsRequest request)
Lists all of the Cognito identity pools registered for your account.
|
LookupDeveloperIdentityResult |
lookupDeveloperIdentity(LookupDeveloperIdentityRequest request)
Retrieves the
IdentityID associated with a
DeveloperUserIdentifier or the list of
DeveloperUserIdentifiers associated with an
IdentityId for an existing identity. |
MergeDeveloperIdentitiesResult |
mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request)
Merges two users having different
IdentityIds, 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 |
setIdentityPoolRoles(SetIdentityPoolRolesRequest request)
Sets the roles for an identity pool.
|
void |
setRegion(Region region)
An alternative to
AmazonCognitoIdentity.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 request)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
void |
unlinkIdentity(UnlinkIdentityRequest request)
Unlinks a federated identity from an existing account.
|
UpdateIdentityPoolResult |
updateIdentityPool(UpdateIdentityPoolRequest request)
Updates a user pool.
|
public void setEndpoint(String endpoint)
AmazonCognitoIdentity
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.
setEndpoint in interface AmazonCognitoIdentityendpoint - 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.public void setRegion(Region region)
AmazonCognitoIdentityAmazonCognitoIdentity.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.
setRegion in interface AmazonCognitoIdentityregion - 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)public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest request)
AmazonCognitoIdentity
Creates a new identity pool. The identity pool is a store of user
identity information that is specific to your AWS account. The limit on
identity pools is 60 per account. The keys for
SupportedLoginProviders are as follows:
graph.facebook.comaccounts.google.comwww.amazon.comapi.twitter.comwww.digits.comcreateIdentityPool in interface AmazonCognitoIdentityrequest - Input to the CreateIdentityPool action.public DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest request)
AmazonCognitoIdentityDeletes 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.
deleteIdentities in interface AmazonCognitoIdentityrequest - Input to the DeleteIdentities action.public void deleteIdentityPool(DeleteIdentityPoolRequest request)
AmazonCognitoIdentityDeletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
deleteIdentityPool in interface AmazonCognitoIdentityrequest - Input to the DeleteIdentityPool action.public DescribeIdentityResult describeIdentity(DescribeIdentityRequest request)
AmazonCognitoIdentityReturns 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.
describeIdentity in interface AmazonCognitoIdentityrequest - Input to the DescribeIdentity action.public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest request)
AmazonCognitoIdentityGets 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.
describeIdentityPool in interface AmazonCognitoIdentityrequest - Input to the DescribeIdentityPool action.public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest request)
AmazonCognitoIdentityReturns 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.
getCredentialsForIdentity in interface AmazonCognitoIdentityrequest - Input to the GetCredentialsForIdentity action.public GetIdResult getId(GetIdRequest request)
AmazonCognitoIdentityGenerates (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.
getId in interface AmazonCognitoIdentityrequest - Input to the GetId action.public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest request)
AmazonCognitoIdentityGets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRoles in interface AmazonCognitoIdentityrequest - Input to the GetIdentityPoolRoles action.public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest request)
AmazonCognitoIdentityGets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
This is a public API. You do not need any credentials to call this API.
getOpenIdToken in interface AmazonCognitoIdentityrequest - Input to the GetOpenIdToken action.public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request)
AmazonCognitoIdentity
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.
getOpenIdTokenForDeveloperIdentity in interface AmazonCognitoIdentityrequest - Input to the GetOpenIdTokenForDeveloperIdentity
action.public ListIdentitiesResult listIdentities(ListIdentitiesRequest request)
AmazonCognitoIdentityLists the identities in a pool.
You must use AWS Developer credentials to call this API.
listIdentities in interface AmazonCognitoIdentityrequest - Input to the ListIdentities action.public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest request)
AmazonCognitoIdentityLists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
listIdentityPools in interface AmazonCognitoIdentityrequest - Input to the ListIdentityPools action.public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest request)
AmazonCognitoIdentity
Retrieves the IdentityID associated with a
DeveloperUserIdentifier or the list of
DeveloperUserIdentifiers associated with an
IdentityId for an existing identity. Either
IdentityID or DeveloperUserIdentifier must not
be null. If you supply only one of these values, the other value will be
searched in the database and returned as a part of the response. If you
supply both, DeveloperUserIdentifier will be matched against
IdentityID. If the values are verified against the database,
the response returns both values and is the same as the request.
Otherwise a ResourceConflictException is thrown.
You must use AWS Developer credentials to call this API.
lookupDeveloperIdentity in interface AmazonCognitoIdentityrequest - Input to the LookupDeveloperIdentityInput action.public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request)
AmazonCognitoIdentity
Merges two users having different IdentityIds, existing in
the same identity pool, and identified by the same developer provider.
You can use this action to request that discrete users be merged and
identified as a single user in the Cognito environment. Cognito
associates the given source user (SourceUserIdentifier) with
the IdentityId of the DestinationUserIdentifier
. Only developer-authenticated users can be merged. If the users to be
merged are associated with the same public provider, but as two different
users, an exception will be thrown.
You must use AWS Developer credentials to call this API.
mergeDeveloperIdentities in interface AmazonCognitoIdentityrequest - Input to the MergeDeveloperIdentities action.public void setIdentityPoolRoles(SetIdentityPoolRolesRequest request)
AmazonCognitoIdentity
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.
setIdentityPoolRoles in interface AmazonCognitoIdentityrequest - Input to the SetIdentityPoolRoles action.public void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest request)
AmazonCognitoIdentity
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.
unlinkDeveloperIdentity in interface AmazonCognitoIdentityrequest - Input to the UnlinkDeveloperIdentity action.public void unlinkIdentity(UnlinkIdentityRequest request)
AmazonCognitoIdentityUnlinks 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.
unlinkIdentity in interface AmazonCognitoIdentityrequest - Input to the UnlinkIdentity action.public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest request)
AmazonCognitoIdentityUpdates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPool in interface AmazonCognitoIdentityrequest - An object representing a Cognito identity pool.public void shutdown()
AmazonCognitoIdentityshutdown in interface AmazonCognitoIdentitypublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCognitoIdentityResponse 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.
getCachedResponseMetadata in interface AmazonCognitoIdentityrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.