@Generated(value="software.amazon.awssdk:codegen") public interface CognitoIdentityAsyncClient extends SdkClient
builder()
method.
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 | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CognitoIdentityAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CognitoIdentityAsyncClient . |
static CognitoIdentityAsyncClient |
create()
Create a
CognitoIdentityAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateIdentityPoolResponse> |
createIdentityPool(Consumer<CreateIdentityPoolRequest.Builder> createIdentityPoolRequest)
Creates a new identity pool.
|
default CompletableFuture<CreateIdentityPoolResponse> |
createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
Creates a new identity pool.
|
default CompletableFuture<DeleteIdentitiesResponse> |
deleteIdentities(Consumer<DeleteIdentitiesRequest.Builder> deleteIdentitiesRequest)
Deletes identities from an identity pool.
|
default CompletableFuture<DeleteIdentitiesResponse> |
deleteIdentities(DeleteIdentitiesRequest deleteIdentitiesRequest)
Deletes identities from an identity pool.
|
default CompletableFuture<DeleteIdentityPoolResponse> |
deleteIdentityPool(Consumer<DeleteIdentityPoolRequest.Builder> deleteIdentityPoolRequest)
Deletes a user pool.
|
default CompletableFuture<DeleteIdentityPoolResponse> |
deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
Deletes a user pool.
|
default CompletableFuture<DescribeIdentityResponse> |
describeIdentity(Consumer<DescribeIdentityRequest.Builder> describeIdentityRequest)
Returns metadata related to the given identity, including when the identity was created and any associated linked
logins.
|
default CompletableFuture<DescribeIdentityResponse> |
describeIdentity(DescribeIdentityRequest describeIdentityRequest)
Returns metadata related to the given identity, including when the identity was created and any associated linked
logins.
|
default CompletableFuture<DescribeIdentityPoolResponse> |
describeIdentityPool(Consumer<DescribeIdentityPoolRequest.Builder> describeIdentityPoolRequest)
Gets details about a particular identity pool, including the pool name, ID description, creation date, and
current number of users.
|
default CompletableFuture<DescribeIdentityPoolResponse> |
describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
Gets details about a particular identity pool, including the pool name, ID description, creation date, and
current number of users.
|
default CompletableFuture<GetCredentialsForIdentityResponse> |
getCredentialsForIdentity(Consumer<GetCredentialsForIdentityRequest.Builder> getCredentialsForIdentityRequest)
Returns credentials for the provided identity ID.
|
default CompletableFuture<GetCredentialsForIdentityResponse> |
getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
Returns credentials for the provided identity ID.
|
default CompletableFuture<GetIdResponse> |
getId(Consumer<GetIdRequest.Builder> getIdRequest)
Generates (or retrieves) a Cognito ID.
|
default CompletableFuture<GetIdResponse> |
getId(GetIdRequest getIdRequest)
Generates (or retrieves) a Cognito ID.
|
default CompletableFuture<GetIdentityPoolRolesResponse> |
getIdentityPoolRoles(Consumer<GetIdentityPoolRolesRequest.Builder> getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
|
default CompletableFuture<GetIdentityPoolRolesResponse> |
getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
|
default CompletableFuture<GetOpenIdTokenResponse> |
getOpenIdToken(Consumer<GetOpenIdTokenRequest.Builder> getOpenIdTokenRequest)
Gets an OpenID token, using a known Cognito ID.
|
default CompletableFuture<GetOpenIdTokenResponse> |
getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
Gets an OpenID token, using a known Cognito ID.
|
default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> |
getOpenIdTokenForDeveloperIdentity(Consumer<GetOpenIdTokenForDeveloperIdentityRequest.Builder> getOpenIdTokenForDeveloperIdentityRequest)
Registers (or retrieves) a Cognito
IdentityId and an OpenID Connect token for a user authenticated
by your backend authentication process. |
default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> |
getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
Registers (or retrieves) a Cognito
IdentityId and an OpenID Connect token for a user authenticated
by your backend authentication process. |
default CompletableFuture<ListIdentitiesResponse> |
listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)
Lists the identities in a pool.
|
default CompletableFuture<ListIdentitiesResponse> |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in a pool.
|
default CompletableFuture<ListIdentityPoolsResponse> |
listIdentityPools(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default CompletableFuture<ListIdentityPoolsResponse> |
listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
|
default CompletableFuture<LookupDeveloperIdentityResponse> |
lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier s associated with an IdentityId for an existing identity. |
default CompletableFuture<LookupDeveloperIdentityResponse> |
lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
Retrieves the
IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier s associated with an IdentityId for an existing identity. |
default CompletableFuture<MergeDeveloperIdentitiesResponse> |
mergeDeveloperIdentities(Consumer<MergeDeveloperIdentitiesRequest.Builder> mergeDeveloperIdentitiesRequest)
Merges two users having different
IdentityId s, existing in the same identity pool, and identified by
the same developer provider. |
default CompletableFuture<MergeDeveloperIdentitiesResponse> |
mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
Merges two users having different
IdentityId s, existing in the same identity pool, and identified by
the same developer provider. |
default CompletableFuture<SetIdentityPoolRolesResponse> |
setIdentityPoolRoles(Consumer<SetIdentityPoolRolesRequest.Builder> setIdentityPoolRolesRequest)
Sets the roles for an identity pool.
|
default CompletableFuture<SetIdentityPoolRolesResponse> |
setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
Sets the roles for an identity pool.
|
default CompletableFuture<UnlinkDeveloperIdentityResponse> |
unlinkDeveloperIdentity(Consumer<UnlinkDeveloperIdentityRequest.Builder> unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
default CompletableFuture<UnlinkDeveloperIdentityResponse> |
unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
Unlinks a
DeveloperUserIdentifier from an existing identity. |
default CompletableFuture<UnlinkIdentityResponse> |
unlinkIdentity(Consumer<UnlinkIdentityRequest.Builder> unlinkIdentityRequest)
Unlinks a federated identity from an existing account.
|
default CompletableFuture<UnlinkIdentityResponse> |
unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
Unlinks a federated identity from an existing account.
|
default CompletableFuture<UpdateIdentityPoolResponse> |
updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest)
Updates a user pool.
|
default CompletableFuture<UpdateIdentityPoolResponse> |
updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates a user pool.
|
serviceName
close
static final String SERVICE_NAME
static CognitoIdentityAsyncClient create()
CognitoIdentityAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CognitoIdentityAsyncClientBuilder builder()
CognitoIdentityAsyncClient
.default CompletableFuture<CreateIdentityPoolResponse> 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 limit on identity pools is 60 per 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.default CompletableFuture<CreateIdentityPoolResponse> createIdentityPool(Consumer<CreateIdentityPoolRequest.Builder> createIdentityPoolRequest)
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:
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.
This is a convenience which creates an instance of the CreateIdentityPoolRequest.Builder
avoiding the
need to create one manually via CreateIdentityPoolRequest.builder()
createIdentityPoolRequest
- A Consumer
that will call methods on CreateIdentityPoolInput.Builder
to create a request.
Input to the CreateIdentityPool action.default CompletableFuture<DeleteIdentitiesResponse> 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.default CompletableFuture<DeleteIdentitiesResponse> deleteIdentities(Consumer<DeleteIdentitiesRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteIdentitiesRequest.Builder
avoiding the need
to create one manually via DeleteIdentitiesRequest.builder()
deleteIdentitiesRequest
- A Consumer
that will call methods on DeleteIdentitiesInput.Builder
to create a request.
Input to the DeleteIdentities
action.default CompletableFuture<DeleteIdentityPoolResponse> deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
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
- Input to the DeleteIdentityPool action.default CompletableFuture<DeleteIdentityPoolResponse> deleteIdentityPool(Consumer<DeleteIdentityPoolRequest.Builder> deleteIdentityPoolRequest)
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.
This is a convenience which creates an instance of the DeleteIdentityPoolRequest.Builder
avoiding the
need to create one manually via DeleteIdentityPoolRequest.builder()
deleteIdentityPoolRequest
- A Consumer
that will call methods on DeleteIdentityPoolInput.Builder
to create a request.
Input to the DeleteIdentityPool action.default CompletableFuture<DescribeIdentityResponse> 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.default CompletableFuture<DescribeIdentityResponse> describeIdentity(Consumer<DescribeIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeIdentityRequest.Builder
avoiding the need
to create one manually via DescribeIdentityRequest.builder()
describeIdentityRequest
- A Consumer
that will call methods on DescribeIdentityInput.Builder
to create a request.
Input to the DescribeIdentity
action.default CompletableFuture<DescribeIdentityPoolResponse> 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.default CompletableFuture<DescribeIdentityPoolResponse> describeIdentityPool(Consumer<DescribeIdentityPoolRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeIdentityPoolRequest.Builder
avoiding the
need to create one manually via DescribeIdentityPoolRequest.builder()
describeIdentityPoolRequest
- A Consumer
that will call methods on DescribeIdentityPoolInput.Builder
to create a
request. Input to the DescribeIdentityPool action.default CompletableFuture<GetCredentialsForIdentityResponse> 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.default CompletableFuture<GetCredentialsForIdentityResponse> getCredentialsForIdentity(Consumer<GetCredentialsForIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the GetCredentialsForIdentityRequest.Builder
avoiding
the need to create one manually via GetCredentialsForIdentityRequest.builder()
getCredentialsForIdentityRequest
- A Consumer
that will call methods on GetCredentialsForIdentityInput.Builder
to create a
request. Input to the GetCredentialsForIdentity
action.default CompletableFuture<GetIdResponse> 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.default CompletableFuture<GetIdResponse> getId(Consumer<GetIdRequest.Builder> 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.
This is a convenience which creates an instance of the GetIdRequest.Builder
avoiding the need to create
one manually via GetIdRequest.builder()
getIdRequest
- A Consumer
that will call methods on GetIdInput.Builder
to create a request. Input to the
GetId action.default CompletableFuture<GetIdentityPoolRolesResponse> 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.default CompletableFuture<GetIdentityPoolRolesResponse> getIdentityPoolRoles(Consumer<GetIdentityPoolRolesRequest.Builder> getIdentityPoolRolesRequest)
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the GetIdentityPoolRolesRequest.Builder
avoiding the
need to create one manually via GetIdentityPoolRolesRequest.builder()
getIdentityPoolRolesRequest
- A Consumer
that will call methods on GetIdentityPoolRolesInput.Builder
to create a
request. Input to the GetIdentityPoolRoles
action.default CompletableFuture<GetOpenIdTokenResponse> 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 15 minutes.
This is a public API. You do not need any credentials to call this API.
getOpenIdTokenRequest
- Input to the GetOpenIdToken action.default CompletableFuture<GetOpenIdTokenResponse> getOpenIdToken(Consumer<GetOpenIdTokenRequest.Builder> 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 15 minutes.
This is a public API. You do not need any credentials to call this API.
This is a convenience which creates an instance of the GetOpenIdTokenRequest.Builder
avoiding the need to
create one manually via GetOpenIdTokenRequest.builder()
getOpenIdTokenRequest
- A Consumer
that will call methods on GetOpenIdTokenInput.Builder
to create a request.
Input to the GetOpenIdToken action.default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> 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.default CompletableFuture<GetOpenIdTokenForDeveloperIdentityResponse> getOpenIdTokenForDeveloperIdentity(Consumer<GetOpenIdTokenForDeveloperIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the GetOpenIdTokenForDeveloperIdentityRequest.Builder
avoiding the need to create one manually via GetOpenIdTokenForDeveloperIdentityRequest.builder()
getOpenIdTokenForDeveloperIdentityRequest
- A Consumer
that will call methods on GetOpenIdTokenForDeveloperIdentityInput.Builder
to
create a request. Input to the GetOpenIdTokenForDeveloperIdentity
action.default CompletableFuture<ListIdentitiesResponse> listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
listIdentitiesRequest
- Input to the ListIdentities action.default CompletableFuture<ListIdentitiesResponse> listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the ListIdentitiesRequest.Builder
avoiding the need to
create one manually via ListIdentitiesRequest.builder()
listIdentitiesRequest
- A Consumer
that will call methods on ListIdentitiesInput.Builder
to create a request.
Input to the ListIdentities action.default CompletableFuture<ListIdentityPoolsResponse> 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.default CompletableFuture<ListIdentityPoolsResponse> listIdentityPools(Consumer<ListIdentityPoolsRequest.Builder> listIdentityPoolsRequest)
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the ListIdentityPoolsRequest.Builder
avoiding the need
to create one manually via ListIdentityPoolsRequest.builder()
listIdentityPoolsRequest
- A Consumer
that will call methods on ListIdentityPoolsInput.Builder
to create a request.
Input to the ListIdentityPools action.default CompletableFuture<LookupDeveloperIdentityResponse> lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
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
- Input to the LookupDeveloperIdentityInput
action.default CompletableFuture<LookupDeveloperIdentityResponse> lookupDeveloperIdentity(Consumer<LookupDeveloperIdentityRequest.Builder> lookupDeveloperIdentityRequest)
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.
This is a convenience which creates an instance of the LookupDeveloperIdentityRequest.Builder
avoiding
the need to create one manually via LookupDeveloperIdentityRequest.builder()
lookupDeveloperIdentityRequest
- A Consumer
that will call methods on LookupDeveloperIdentityInput.Builder
to create a
request. Input to the LookupDeveloperIdentityInput
action.default CompletableFuture<MergeDeveloperIdentitiesResponse> 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.
You must use AWS Developer credentials to call this API.
mergeDeveloperIdentitiesRequest
- Input to the MergeDeveloperIdentities
action.default CompletableFuture<MergeDeveloperIdentitiesResponse> mergeDeveloperIdentities(Consumer<MergeDeveloperIdentitiesRequest.Builder> 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.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the MergeDeveloperIdentitiesRequest.Builder
avoiding
the need to create one manually via MergeDeveloperIdentitiesRequest.builder()
mergeDeveloperIdentitiesRequest
- A Consumer
that will call methods on MergeDeveloperIdentitiesInput.Builder
to create a
request. Input to the MergeDeveloperIdentities
action.default CompletableFuture<SetIdentityPoolRolesResponse> 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.default CompletableFuture<SetIdentityPoolRolesResponse> setIdentityPoolRoles(Consumer<SetIdentityPoolRolesRequest.Builder> 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.
This is a convenience which creates an instance of the SetIdentityPoolRolesRequest.Builder
avoiding the
need to create one manually via SetIdentityPoolRolesRequest.builder()
setIdentityPoolRolesRequest
- A Consumer
that will call methods on SetIdentityPoolRolesInput.Builder
to create a
request. Input to the SetIdentityPoolRoles
action.default CompletableFuture<UnlinkDeveloperIdentityResponse> 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.default CompletableFuture<UnlinkDeveloperIdentityResponse> unlinkDeveloperIdentity(Consumer<UnlinkDeveloperIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the UnlinkDeveloperIdentityRequest.Builder
avoiding
the need to create one manually via UnlinkDeveloperIdentityRequest.builder()
unlinkDeveloperIdentityRequest
- A Consumer
that will call methods on UnlinkDeveloperIdentityInput.Builder
to create a
request. Input to the UnlinkDeveloperIdentity
action.default CompletableFuture<UnlinkIdentityResponse> 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.default CompletableFuture<UnlinkIdentityResponse> unlinkIdentity(Consumer<UnlinkIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the UnlinkIdentityRequest.Builder
avoiding the need to
create one manually via UnlinkIdentityRequest.builder()
unlinkIdentityRequest
- A Consumer
that will call methods on UnlinkIdentityInput.Builder
to create a request.
Input to the UnlinkIdentity action.default CompletableFuture<UpdateIdentityPoolResponse> updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
Updates a user pool.
You must use AWS Developer credentials to call this API.
updateIdentityPoolRequest
- An object representing an Amazon Cognito identity pool.default CompletableFuture<UpdateIdentityPoolResponse> updateIdentityPool(Consumer<UpdateIdentityPoolRequest.Builder> updateIdentityPoolRequest)
Updates a user pool.
You must use AWS Developer credentials to call this API.
This is a convenience which creates an instance of the UpdateIdentityPoolRequest.Builder
avoiding the
need to create one manually via UpdateIdentityPoolRequest.builder()
updateIdentityPoolRequest
- A Consumer
that will call methods on IdentityPool.Builder
to create a request. An object
representing an Amazon Cognito identity pool.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.