AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
ConcurrentModificationException | CognitoIdentity exception | |
CreateIdentityPoolRequest |
Container for the parameters to the CreateIdentityPool operation.
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:
|
|
CreateIdentityPoolResponse | Configuration for accessing Amazon CreateIdentityPool service | |
CreateIdentityPoolResult | An object representing a Cognito identity pool. | |
Credentials | Credentials for the provided identity ID. | |
DeleteIdentitiesRequest |
Container for the parameters to the DeleteIdentities operation.
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. |
|
DeleteIdentitiesResponse | Configuration for accessing Amazon DeleteIdentities service | |
DeleteIdentitiesResult |
Returned in response to a successful DeleteIdentities operation.
|
|
DeleteIdentityPoolRequest |
Container for the parameters to the DeleteIdentityPool operation.
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. |
|
DeleteIdentityPoolResponse | ||
DescribeIdentityPoolRequest |
Container for the parameters to the DescribeIdentityPool operation.
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. |
|
DescribeIdentityPoolResponse | Configuration for accessing Amazon DescribeIdentityPool service | |
DescribeIdentityPoolResult | An object representing a Cognito identity pool. | |
DescribeIdentityRequest |
Container for the parameters to the DescribeIdentity operation.
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. |
|
DescribeIdentityResponse | Configuration for accessing Amazon DescribeIdentity service | |
DescribeIdentityResult | A description of the identity. | |
DeveloperUserAlreadyRegisteredException | CognitoIdentity exception | |
ExternalServiceException | CognitoIdentity exception | |
GetCredentialsForIdentityRequest |
Container for the parameters to the GetCredentialsForIdentity operation.
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. |
|
GetCredentialsForIdentityResponse | Configuration for accessing Amazon GetCredentialsForIdentity service | |
GetCredentialsForIdentityResult |
Returned in response to a successful GetCredentialsForIdentity operation.
|
|
GetIdentityPoolRolesRequest |
Container for the parameters to the GetIdentityPoolRoles operation.
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API. |
|
GetIdentityPoolRolesResponse | Configuration for accessing Amazon GetIdentityPoolRoles service | |
GetIdentityPoolRolesResult |
Returned in response to a successful GetIdentityPoolRoles operation.
|
|
GetIdRequest |
Container for the parameters to the GetId operation.
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. |
|
GetIdResponse | Configuration for accessing Amazon GetId service | |
GetIdResult | Returned in response to a GetId request. | |
GetOpenIdTokenForDeveloperIdentityRequest |
Container for the parameters to the GetOpenIdTokenForDeveloperIdentity operation.
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 You must use AWS Developer credentials to call this API. |
|
GetOpenIdTokenForDeveloperIdentityResponse | Configuration for accessing Amazon GetOpenIdTokenForDeveloperIdentity service | |
GetOpenIdTokenForDeveloperIdentityResult |
Returned in response to a successful GetOpenIdTokenForDeveloperIdentity
request.
|
|
GetOpenIdTokenRequest |
Container for the parameters to the GetOpenIdToken operation.
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. |
|
GetOpenIdTokenResponse | Configuration for accessing Amazon GetOpenIdToken service | |
GetOpenIdTokenResult | Returned in response to a successful GetOpenIdToken request. | |
IdentityDescription | A description of the identity. | |
IdentityPoolShortDescription | A description of the identity pool. | |
InternalErrorException | CognitoIdentity exception | |
InvalidIdentityPoolConfigurationException | CognitoIdentity exception | |
InvalidParameterException | CognitoIdentity exception | |
LimitExceededException | CognitoIdentity exception | |
ListIdentitiesRequest |
Container for the parameters to the ListIdentities operation.
Lists the identities in a pool.
You must use AWS Developer credentials to call this API. |
|
ListIdentitiesResponse | Configuration for accessing Amazon ListIdentities service | |
ListIdentitiesResult | The response to a ListIdentities request. | |
ListIdentityPoolsRequest |
Container for the parameters to the ListIdentityPools operation.
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API. |
|
ListIdentityPoolsResponse | Configuration for accessing Amazon ListIdentityPools service | |
ListIdentityPoolsResult | The result of a successful ListIdentityPools action. | |
LookupDeveloperIdentityRequest |
Container for the parameters to the LookupDeveloperIdentity operation.
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. |
|
LookupDeveloperIdentityResponse | Configuration for accessing Amazon LookupDeveloperIdentity service | |
LookupDeveloperIdentityResult |
Returned in response to a successful LookupDeveloperIdentity action.
|
|
MergeDeveloperIdentitiesRequest |
Container for the parameters to the MergeDeveloperIdentities operation.
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. |
|
MergeDeveloperIdentitiesResponse | Configuration for accessing Amazon MergeDeveloperIdentities service | |
MergeDeveloperIdentitiesResult |
Returned in response to a successful MergeDeveloperIdentities action.
|
|
NotAuthorizedException | CognitoIdentity exception | |
ResourceConflictException | CognitoIdentity exception | |
ResourceNotFoundException | CognitoIdentity exception | |
SetIdentityPoolRolesRequest |
Container for the parameters to the SetIdentityPoolRoles operation.
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. |
|
SetIdentityPoolRolesResponse | ||
TooManyRequestsException | CognitoIdentity exception | |
UnlinkDeveloperIdentityRequest |
Container for the parameters to the UnlinkDeveloperIdentity operation.
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. |
|
UnlinkDeveloperIdentityResponse | ||
UnlinkIdentityRequest |
Container for the parameters to the UnlinkIdentity operation.
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. |
|
UnlinkIdentityResponse | ||
UnprocessedIdentityId | An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. | |
UpdateIdentityPoolRequest |
Container for the parameters to the UpdateIdentityPool operation.
Updates a user pool.
You must use AWS Developer credentials to call this API. |
|
UpdateIdentityPoolResponse | Configuration for accessing Amazon UpdateIdentityPool service | |
UpdateIdentityPoolResult | An object representing a Cognito identity pool. |