public interface AmazonCognitoIdentityAsync extends AmazonCognitoIdentity
Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId.
If the end user is authenticated with one of the supported identity
providers, set the Logins
map with the identity provider
token. GetId
returns a unique identifier for the user.
Next, make an unsigned call to GetCredentialsForIdentity. This call
expects the same Logins
map as the GetId
call, as well as the IdentityID
originally returned by
GetId
. Assuming your identity pool has been configured
via the SetIdentityPoolRoles operation,
GetCredentialsForIdentity
will return AWS credentials for
your use. If your pool has not been configured with
SetIdentityPoolRoles
, or if you want to follow legacy
flow, make an unsigned call to GetOpenIdToken, which returns the
OpenID token necessary to call STS and retrieve AWS credentials. This
call expects the same Logins
map as the
GetId
call, as well as the IdentityID
originally returned by GetId
. The token returned by
GetOpenIdToken
can be passed to the STS operation
AssumeRoleWithWebIdentity
to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide .
Modifier and Type | Method and Description |
---|---|
Future<CreateIdentityPoolResult> |
createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest)
Creates a new identity pool.
|
Future<CreateIdentityPoolResult> |
createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest,
AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler)
Creates a new identity pool.
|
Future<DeleteIdentitiesResult> |
deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest)
Deletes identities from an identity pool.
|
Future<DeleteIdentitiesResult> |
deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest,
AsyncHandler<DeleteIdentitiesRequest,DeleteIdentitiesResult> asyncHandler)
Deletes identities from an identity pool.
|
Future<Void> |
deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
Deletes a user pool.
|
Future<Void> |
deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest,
AsyncHandler<DeleteIdentityPoolRequest,Void> asyncHandler)
Deletes a user pool.
|
Future<DescribeIdentityResult> |
describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest)
Returns metadata related to the given identity, including when the
identity was created and any associated linked logins.
|
Future<DescribeIdentityResult> |
describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest,
AsyncHandler<DescribeIdentityRequest,DescribeIdentityResult> asyncHandler)
Returns metadata related to the given identity, including when the
identity was created and any associated linked logins.
|
Future<DescribeIdentityPoolResult> |
describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest)
Gets details about a particular identity pool, including the pool
name, ID description, creation date, and current number of users.
|
Future<DescribeIdentityPoolResult> |
describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest,
AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler)
Gets details about a particular identity pool, including the pool
name, ID description, creation date, and current number of users.
|
Future<GetCredentialsForIdentityResult> |
getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
Returns credentials for the the provided identity ID.
|
Future<GetCredentialsForIdentityResult> |
getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest,
AsyncHandler<GetCredentialsForIdentityRequest,GetCredentialsForIdentityResult> asyncHandler)
Returns credentials for the the provided identity ID.
|
Future<GetIdResult> |
getIdAsync(GetIdRequest getIdRequest)
Generates (or retrieves) a Cognito ID.
|
Future<GetIdResult> |
getIdAsync(GetIdRequest getIdRequest,
AsyncHandler<GetIdRequest,GetIdResult> asyncHandler)
Generates (or retrieves) a Cognito ID.
|
Future<GetIdentityPoolRolesResult> |
getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
|
Future<GetIdentityPoolRolesResult> |
getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest,
AsyncHandler<GetIdentityPoolRolesRequest,GetIdentityPoolRolesResult> asyncHandler)
Gets the roles for an identity pool.
|
Future<GetOpenIdTokenResult> |
getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest)
Gets an OpenID token, using a known Cognito ID.
|
Future<GetOpenIdTokenResult> |
getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest,
AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler)
Gets an OpenID token, using a known Cognito ID.
|
Future<GetOpenIdTokenForDeveloperIdentityResult> |
getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
Registers (or retrieves) a Cognito
IdentityId and an
OpenID Connect token for a user authenticated by your backend
authentication process. |
Future<GetOpenIdTokenForDeveloperIdentityResult> |
getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest,
AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,GetOpenIdTokenForDeveloperIdentityResult> asyncHandler)
Registers (or retrieves) a Cognito
IdentityId and an
OpenID Connect token for a user authenticated by your backend
authentication process. |
Future<ListIdentitiesResult> |
listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in a pool.
|
Future<ListIdentitiesResult> |
listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest,
AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler)
Lists the identities in a pool.
|
Future<ListIdentityPoolsResult> |
listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
Future<ListIdentityPoolsResult> |
listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest,
AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler)
Lists all of the Cognito identity pools registered for your account.
|
Future<LookupDeveloperIdentityResult> |
lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a
DeveloperUserIdentifier or the list of
DeveloperUserIdentifier s associated with an
IdentityId for an existing identity. |
Future<LookupDeveloperIdentityResult> |
lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest,
AsyncHandler<LookupDeveloperIdentityRequest,LookupDeveloperIdentityResult> asyncHandler)
Retrieves the
IdentityID associated with a
DeveloperUserIdentifier or the list of
DeveloperUserIdentifier s associated with an
IdentityId for an existing identity. |
Future<MergeDeveloperIdentitiesResult> |
mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
Merges two users having different
IdentityId s, existing
in the same identity pool, and identified by the same developer
provider. |
Future<MergeDeveloperIdentitiesResult> |
mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest,
AsyncHandler<MergeDeveloperIdentitiesRequest,MergeDeveloperIdentitiesResult> asyncHandler)
Merges two users having different
IdentityId s, existing
in the same identity pool, and identified by the same developer
provider. |
Future<Void> |
setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
Sets the roles for an identity pool.
|
Future<Void> |
setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest,
AsyncHandler<SetIdentityPoolRolesRequest,Void> asyncHandler)
Sets the roles for an identity pool.
|
Future<Void> |
unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing
identity. |
Future<Void> |
unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest,
AsyncHandler<UnlinkDeveloperIdentityRequest,Void> asyncHandler)
Unlinks a
DeveloperUserIdentifier from an existing
identity. |
Future<Void> |
unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest)
Unlinks a federated identity from an existing account.
|
Future<Void> |
unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest,
AsyncHandler<UnlinkIdentityRequest,Void> asyncHandler)
Unlinks a federated identity from an existing account.
|
Future<UpdateIdentityPoolResult> |
updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates a user pool.
|
Future<UpdateIdentityPoolResult> |
updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest,
AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler)
Updates a user pool.
|
createIdentityPool, deleteIdentities, deleteIdentityPool, describeIdentity, describeIdentityPool, getCachedResponseMetadata, getCredentialsForIdentity, getId, getIdentityPoolRoles, getOpenIdToken, getOpenIdTokenForDeveloperIdentity, listIdentities, listIdentityPools, lookupDeveloperIdentity, mergeDeveloperIdentities, setEndpoint, setIdentityPoolRoles, setRegion, shutdown, unlinkDeveloperIdentity, unlinkIdentity, updateIdentityPool
Future<Void> unlinkDeveloperIdentityAsync(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.
This is a public API. You do not need any credentials to call this API.
unlinkDeveloperIdentityRequest
- Container for the necessary
parameters to execute the UnlinkDeveloperIdentity operation on
AmazonCognitoIdentity.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.Future<Void> unlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest, AsyncHandler<UnlinkDeveloperIdentityRequest,Void> asyncHandler) 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.
This is a public API. You do not need any credentials to call this API.
unlinkDeveloperIdentityRequest
- Container for the necessary
parameters to execute the UnlinkDeveloperIdentity operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DeleteIdentities operation on AmazonCognitoIdentity.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.Future<DeleteIdentitiesResult> deleteIdentitiesAsync(DeleteIdentitiesRequest deleteIdentitiesRequest, AsyncHandler<DeleteIdentitiesRequest,DeleteIdentitiesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DeleteIdentities operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(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.
You must use AWS Developer credentials to call this API.
describeIdentityPoolRequest
- Container for the necessary
parameters to execute the DescribeIdentityPool operation on
AmazonCognitoIdentity.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.Future<DescribeIdentityPoolResult> describeIdentityPoolAsync(DescribeIdentityPoolRequest describeIdentityPoolRequest, AsyncHandler<DescribeIdentityPoolRequest,DescribeIdentityPoolResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the DescribeIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest) throws AmazonServiceException, AmazonClientException
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
token+";"+tokenSecret.
This is a public API. You do not need any credentials to call this API.
getIdRequest
- Container for the necessary parameters to execute
the GetId operation on AmazonCognitoIdentity.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.Future<GetIdResult> getIdAsync(GetIdRequest getIdRequest, AsyncHandler<GetIdRequest,GetIdResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
token+";"+tokenSecret.
This is a public API. You do not need any credentials to call this API.
getIdRequest
- Container for the necessary parameters to execute
the GetId operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
deleteIdentityPoolRequest
- Container for the necessary
parameters to execute the DeleteIdentityPool operation on
AmazonCognitoIdentity.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.Future<Void> deleteIdentityPoolAsync(DeleteIdentityPoolRequest deleteIdentityPoolRequest, AsyncHandler<DeleteIdentityPoolRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
deleteIdentityPoolRequest
- Container for the necessary
parameters to execute the DeleteIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest) throws AmazonServiceException, AmazonClientException
Updates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolRequest
- Container for the necessary
parameters to execute the UpdateIdentityPool operation on
AmazonCognitoIdentity.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.Future<UpdateIdentityPoolResult> updateIdentityPoolAsync(UpdateIdentityPoolRequest updateIdentityPoolRequest, AsyncHandler<UpdateIdentityPoolRequest,UpdateIdentityPoolResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Updates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolRequest
- Container for the necessary
parameters to execute the UpdateIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest) throws AmazonServiceException, AmazonClientException
Returns credentials for the the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
getCredentialsForIdentityRequest
- Container for the necessary
parameters to execute the GetCredentialsForIdentity operation on
AmazonCognitoIdentity.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.Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest, AsyncHandler<GetCredentialsForIdentityRequest,GetCredentialsForIdentityResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns credentials for the the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
getCredentialsForIdentityRequest
- Container for the necessary
parameters to execute the GetCredentialsForIdentity operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(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.
You must use AWS Developer credentials to call this API.
mergeDeveloperIdentitiesRequest
- Container for the necessary
parameters to execute the MergeDeveloperIdentities operation on
AmazonCognitoIdentity.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.Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest, AsyncHandler<MergeDeveloperIdentitiesRequest,MergeDeveloperIdentitiesResult> asyncHandler) 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.
You must use AWS Developer credentials to call this API.
mergeDeveloperIdentitiesRequest
- Container for the necessary
parameters to execute the MergeDeveloperIdentities operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest) throws AmazonServiceException, AmazonClientException
Lists all of the Cognito identity pools registered for your account.
This is a public API. You do not need any credentials to call this API.
listIdentityPoolsRequest
- Container for the necessary parameters
to execute the ListIdentityPools operation on AmazonCognitoIdentity.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.Future<ListIdentityPoolsResult> listIdentityPoolsAsync(ListIdentityPoolsRequest listIdentityPoolsRequest, AsyncHandler<ListIdentityPoolsRequest,ListIdentityPoolsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists all of the Cognito identity pools registered for your account.
This is a public API. You do not need any credentials to call this API.
listIdentityPoolsRequest
- Container for the necessary parameters
to execute the ListIdentityPools operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<GetOpenIdTokenResult> getOpenIdTokenAsync(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.
This is a public API. You do not need any credentials to call this API.
getOpenIdTokenRequest
- Container for the necessary parameters to
execute the GetOpenIdToken operation on AmazonCognitoIdentity.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.Future<GetOpenIdTokenResult> getOpenIdTokenAsync(GetOpenIdTokenRequest getOpenIdTokenRequest, AsyncHandler<GetOpenIdTokenRequest,GetOpenIdTokenResult> asyncHandler) 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.
This is a public API. You do not need any credentials to call this API.
getOpenIdTokenRequest
- Container for the necessary parameters to
execute the GetOpenIdToken operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(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.
You must use AWS Developer credentials to call this API.
lookupDeveloperIdentityRequest
- Container for the necessary
parameters to execute the LookupDeveloperIdentity operation on
AmazonCognitoIdentity.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.Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest, AsyncHandler<LookupDeveloperIdentityRequest,LookupDeveloperIdentityResult> asyncHandler) 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.
You must use AWS Developer credentials to call this API.
lookupDeveloperIdentityRequest
- Container for the necessary
parameters to execute the LookupDeveloperIdentity operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DescribeIdentity operation on AmazonCognitoIdentity.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.Future<DescribeIdentityResult> describeIdentityAsync(DescribeIdentityRequest describeIdentityRequest, AsyncHandler<DescribeIdentityRequest,DescribeIdentityResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DescribeIdentity operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<Void> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the SetIdentityPoolRoles operation on
AmazonCognitoIdentity.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.Future<Void> setIdentityPoolRolesAsync(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest, AsyncHandler<SetIdentityPoolRolesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the SetIdentityPoolRoles operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<Void> unlinkIdentityAsync(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.
This is a public API. You do not need any credentials to call this API.
unlinkIdentityRequest
- Container for the necessary parameters to
execute the UnlinkIdentity operation on AmazonCognitoIdentity.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.Future<Void> unlinkIdentityAsync(UnlinkIdentityRequest unlinkIdentityRequest, AsyncHandler<UnlinkIdentityRequest,Void> asyncHandler) 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.
This is a public API. You do not need any credentials to call this API.
unlinkIdentityRequest
- Container for the necessary parameters to
execute the UnlinkIdentity operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest) throws AmazonServiceException, AmazonClientException
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities operation on AmazonCognitoIdentity.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.Future<ListIdentitiesResult> listIdentitiesAsync(ListIdentitiesRequest listIdentitiesRequest, AsyncHandler<ListIdentitiesRequest,ListIdentitiesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
listIdentitiesRequest
- Container for the necessary parameters to
execute the ListIdentities operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest) throws AmazonServiceException, AmazonClientException
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesRequest
- Container for the necessary
parameters to execute the GetIdentityPoolRoles operation on
AmazonCognitoIdentity.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.Future<GetIdentityPoolRolesResult> getIdentityPoolRolesAsync(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest, AsyncHandler<GetIdentityPoolRolesRequest,GetIdentityPoolRolesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
getIdentityPoolRolesRequest
- Container for the necessary
parameters to execute the GetIdentityPoolRoles operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(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
.
You must use AWS Developer credentials to call this API.
getOpenIdTokenForDeveloperIdentityRequest
- Container for the
necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity
operation on AmazonCognitoIdentity.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.Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest, AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,GetOpenIdTokenForDeveloperIdentityResult> asyncHandler) 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
.
You must use AWS Developer credentials to call this API.
getOpenIdTokenForDeveloperIdentityRequest
- Container for the
necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity
operation on AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Future<CreateIdentityPoolResult> createIdentityPoolAsync(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. You must use AWS Developer credentials to call this API.
createIdentityPoolRequest
- Container for the necessary
parameters to execute the CreateIdentityPool operation on
AmazonCognitoIdentity.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.Future<CreateIdentityPoolResult> createIdentityPoolAsync(CreateIdentityPoolRequest createIdentityPoolRequest, AsyncHandler<CreateIdentityPoolRequest,CreateIdentityPoolResult> asyncHandler) 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. You must use AWS Developer credentials to call this API.
createIdentityPoolRequest
- Container for the necessary
parameters to execute the CreateIdentityPool operation on
AmazonCognitoIdentity.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Copyright © 2015. All rights reserved.