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 | |
---|---|---|
CognitoIdentityPaginatorFactory |
Paginators for the CognitoIdentity service |
|
CognitoIdentityProviderInfo |
A provider representing an Amazon Cognito user pool and its client ID. |
|
ConcurrentModificationException |
Thrown if there are parallel requests to modify a resource. |
|
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 keys for
You must use AWS Developer credentials to call this API. |
|
CreateIdentityPoolResponse |
An object representing an Amazon Cognito identity pool. |
|
Credentials |
AWS credentials for API authentication. |
|
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 |
Returned in response to a successful |
|
DeleteIdentityPoolRequest |
Container for the parameters to the DeleteIdentityPool operation. Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API. |
|
DeleteIdentityPoolResponse |
This is the response object from the DeleteIdentityPool operation. |
|
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 |
An object representing an Amazon 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 |
A description of the identity. |
|
DeveloperUserAlreadyRegisteredException |
The provided developer user identifier is already registered with Cognito under a different identity ID. |
|
ExternalServiceException |
An exception thrown when a dependent service such as Facebook or Twitter is not responding |
|
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 |
Returned in response to a successful |
|
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 |
Returned in response to a successful |
|
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 |
Returned in response to a GetId request. |
|
GetOpenIdTokenForDeveloperIdentityRequest |
Container for the parameters to the GetOpenIdTokenForDeveloperIdentity operation.
Registers (or retrieves) a Cognito
You can use You must use AWS Developer credentials to call this API. |
|
GetOpenIdTokenForDeveloperIdentityResponse |
Returned in response to a successful |
|
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 10 minutes. This is a public API. You do not need any credentials to call this API. |
|
GetOpenIdTokenResponse |
Returned in response to a successful GetOpenIdToken request. |
|
GetPrincipalTagAttributeMapRequest |
Container for the parameters to the GetPrincipalTagAttributeMap operation.
Use |
|
GetPrincipalTagAttributeMapResponse |
This is the response object from the GetPrincipalTagAttributeMap operation. |
|
IdentityDescription |
A description of the identity. |
|
IdentityPoolShortDescription |
A description of the identity pool. |
|
InternalErrorException |
Thrown when the service encounters an error during processing the request. |
|
InvalidIdentityPoolConfigurationException |
Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. |
|
InvalidParameterException |
Thrown for missing or bad input parameter(s). |
|
LimitExceededException |
Thrown when the total number of user pools has exceeded a preset limit. |
|
ListIdentitiesRequest |
Container for the parameters to the ListIdentities operation. Lists the identities in an identity pool. You must use AWS Developer credentials to call this API. |
|
ListIdentitiesResponse |
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 |
The result of a successful ListIdentityPools action. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
LookupDeveloperIdentityRequest |
Container for the parameters to the LookupDeveloperIdentity operation.
Retrieves the
You must use AWS Developer credentials to call this API. |
|
LookupDeveloperIdentityResponse |
Returned in response to a successful |
|
MappingRule |
A rule that maps a claim name, a claim value, and a match type to a role ARN. |
|
MergeDeveloperIdentitiesRequest |
Container for the parameters to the MergeDeveloperIdentities operation.
Merges two users having different
The number of linked logins is limited to 20. So, the number of linked logins for
the source user, You must use AWS Developer credentials to call this API. |
|
MergeDeveloperIdentitiesResponse |
Returned in response to a successful |
|
NotAuthorizedException |
Thrown when a user is not authorized to access the requested resource. |
|
ResourceConflictException |
Thrown when a user tries to use a login which is already linked to another account. |
|
ResourceNotFoundException |
Thrown when the requested resource (for example, a dataset or record) does not exist. |
|
RoleMapping |
A role mapping. |
|
RulesConfigurationType |
A container for rules. |
|
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 |
This is the response object from the SetIdentityPoolRoles operation. |
|
SetPrincipalTagAttributeMapRequest |
Container for the parameters to the SetPrincipalTagAttributeMap operation. You can use this operation to use default (username and clientID) attribute or custom attribute mappings. |
|
SetPrincipalTagAttributeMapResponse |
This is the response object from the SetPrincipalTagAttributeMap operation. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general
category for more specific values. For example, if you have two versions of an identity
pool, one for testing and another for production, you might assign an Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TooManyRequestsException |
Thrown when a request is throttled. |
|
UnlinkDeveloperIdentityRequest |
Container for the parameters to the UnlinkDeveloperIdentity operation.
Unlinks a You must use AWS Developer credentials to call this API. |
|
UnlinkDeveloperIdentityResponse |
This is the response object from the UnlinkDeveloperIdentity operation. |
|
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 |
This is the response object from the UnlinkIdentity operation. |
|
UnprocessedIdentityId |
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateIdentityPoolRequest |
Container for the parameters to the UpdateIdentityPool operation. Updates an identity pool. You must use AWS Developer credentials to call this API. |
|
UpdateIdentityPoolResponse |
An object representing an Amazon Cognito identity pool. |
Name | Description | |
---|---|---|
ICognitoIdentityPaginatorFactory |
Paginators for the CognitoIdentity service |
|
IListIdentityPoolsPaginator |
Paginator for the ListIdentityPools operation |