Table of Contents
A low-level client representing Amazon Cognito Identity:
import boto3
client = boto3.client('cognito-identity')
These are the available methods:
Check if an operation can be paginated.
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:
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.create_identity_pool(
IdentityPoolName='string',
AllowUnauthenticatedIdentities=True|False,
SupportedLoginProviders={
'string': 'string'
},
DeveloperProviderName='string',
OpenIdConnectProviderARNs=[
'string',
],
CognitoIdentityProviders=[
{
'ProviderName': 'string',
'ClientId': 'string',
'ServerSideTokenCheck': True|False
},
],
SamlProviderARNs=[
'string',
],
IdentityPoolTags={
'string': 'string'
}
)
[REQUIRED]
A string that you provide.
[REQUIRED]
TRUE if the identity pool supports unauthenticated logins.
Optional key:value pairs mapping provider names to provider app IDs.
The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (. ), underscore (_ ), and dash (- ).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
A list of OpendID Connect provider ARNs.
An array of Amazon Cognito user pools and their client IDs.
A provider representing an Amazon Cognito user pool and its client ID.
The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
The client ID for the Amazon Cognito user pool.
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Tags to assign to the 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.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
],
'CognitoIdentityProviders': [
{
'ProviderName': 'string',
'ClientId': 'string',
'ServerSideTokenCheck': True|False
},
],
'SamlProviderARNs': [
'string',
],
'IdentityPoolTags': {
'string': 'string'
}
}
Response Structure
(dict) --
An object representing an Amazon Cognito identity pool.
IdentityPoolId (string) --
An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) --
TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
A list of OpendID Connect provider ARNs.
CognitoIdentityProviders (list) --
A list representing an Amazon Cognito user pool and its client ID.
(dict) --
A provider representing an Amazon Cognito user pool and its client ID.
ProviderName (string) --
The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
ClientId (string) --
The client ID for the Amazon Cognito user pool.
ServerSideTokenCheck (boolean) --
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
SamlProviderARNs (list) --
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
IdentityPoolTags (dict) --
The tags that are assigned to the 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.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_identities(
IdentityIdsToDelete=[
'string',
]
)
[REQUIRED]
A list of 1-60 identities that you want to delete.
{
'UnprocessedIdentityIds': [
{
'IdentityId': 'string',
'ErrorCode': 'AccessDenied'|'InternalServerError'
},
]
}
Response Structure
Returned in response to a successful DeleteIdentities operation.
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
A unique identifier in the format REGION:GUID.
The error code indicating the type of error that occurred.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_identity_pool(
IdentityPoolId='string'
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_identity(
IdentityId='string'
)
[REQUIRED]
A unique identifier in the format REGION:GUID.
{
'IdentityId': 'string',
'Logins': [
'string',
],
'CreationDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
A description of the identity.
A unique identifier in the format REGION:GUID.
The provider names.
Date on which the identity was created.
Date on which the identity was last modified.
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_identity_pool(
IdentityPoolId='string'
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
],
'CognitoIdentityProviders': [
{
'ProviderName': 'string',
'ClientId': 'string',
'ServerSideTokenCheck': True|False
},
],
'SamlProviderARNs': [
'string',
],
'IdentityPoolTags': {
'string': 'string'
}
}
Response Structure
An object representing an Amazon Cognito identity pool.
An identity pool ID in the format REGION:GUID.
A string that you provide.
TRUE if the identity pool supports unauthenticated logins.
Optional key:value pairs mapping provider names to provider app IDs.
The "domain" by which Cognito will refer to your users.
A list of OpendID Connect provider ARNs.
A list representing an Amazon Cognito user pool and its client ID.
A provider representing an Amazon Cognito user pool and its client ID.
The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
The client ID for the Amazon Cognito user pool.
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
The tags that are assigned to the 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.
Generate a presigned url given a client, its method, and arguments
The presigned url
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.
See also: AWS API Documentation
Request Syntax
response = client.get_credentials_for_identity(
IdentityId='string',
Logins={
'string': 'string'
},
CustomRoleArn='string'
)
[REQUIRED]
A unique identifier in the format REGION:GUID.
A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".
Logins should not be specified when trying to get credentials for an unauthenticated identity.
The Logins parameter is required when using identities associated with external identity providers such as FaceBook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.
dict
Response Syntax
{
'IdentityId': 'string',
'Credentials': {
'AccessKeyId': 'string',
'SecretKey': 'string',
'SessionToken': 'string',
'Expiration': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Returned in response to a successful GetCredentialsForIdentity operation.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Credentials (dict) --
Credentials for the provided identity ID.
AccessKeyId (string) --
The Access Key portion of the credentials.
SecretKey (string) --
The Secret Access Key portion of the credentials
SessionToken (string) --
The Session Token portion of the credentials
Expiration (datetime) --
The date at which these credentials will expire.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_id(
AccountId='string',
IdentityPoolId='string',
Logins={
'string': 'string'
}
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:
dict
Response Syntax
{
'IdentityId': 'string'
}
Response Structure
(dict) --
Returned in response to a GetId request.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.get_identity_pool_roles(
IdentityPoolId='string'
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
{
'IdentityPoolId': 'string',
'Roles': {
'string': 'string'
},
'RoleMappings': {
'string': {
'Type': 'Token'|'Rules',
'AmbiguousRoleResolution': 'AuthenticatedRole'|'Deny',
'RulesConfiguration': {
'Rules': [
{
'Claim': 'string',
'MatchType': 'Equals'|'Contains'|'StartsWith'|'NotEqual',
'Value': 'string',
'RoleARN': 'string'
},
]
}
}
}
}
Response Structure
Returned in response to a successful GetIdentityPoolRoles operation.
An identity pool ID in the format REGION:GUID.
The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
How users for a specific identity provider are to mapped to roles. This is a String-to- RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
A role mapping.
The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
If you specify Token or Rules as the Type , AmbiguousRoleResolution is required.
Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.
The rules to be used for mapping users to roles.
If you specify Rules as the role mapping type, RulesConfiguration is required.
An array of rules. You can specify up to 25 rules per identity provider.
Rules are evaluated in order. The first one to match specifies the role.
A rule that maps a claim name, a claim value, and a match type to a role ARN.
The claim name that must be present in the token, for example, "isAdmin" or "paid".
The match condition that specifies how closely the claim value in the IdP token must match Value .
A brief string that the claim must match, for example, "paid" or "yes".
The role ARN.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_open_id_token(
IdentityId='string',
Logins={
'string': 'string'
}
)
[REQUIRED]
A unique identifier in the format REGION:GUID.
A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenId Connect provider, always include the id_token .
dict
Response Syntax
{
'IdentityId': 'string',
'Token': 'string'
}
Response Structure
(dict) --
Returned in response to a successful GetOpenIdToken request.
IdentityId (string) --
A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
Token (string) --
An OpenID token, valid for 10 minutes.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_open_id_token_for_developer_identity(
IdentityPoolId='string',
IdentityId='string',
Logins={
'string': 'string'
},
TokenDuration=123
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
[REQUIRED]
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier" . The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
dict
Response Syntax
{
'IdentityId': 'string',
'Token': 'string'
}
Response Structure
(dict) --
Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Token (string) --
An OpenID token.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.list_identities(
IdentityPoolId='string',
MaxResults=123,
NextToken='string',
HideDisabled=True|False
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
[REQUIRED]
The maximum number of identities to return.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'Identities': [
{
'IdentityId': 'string',
'Logins': [
'string',
],
'CreationDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response to a ListIdentities request.
IdentityPoolId (string) --
An identity pool ID in the format REGION:GUID.
Identities (list) --
An object containing a set of identities and associated mappings.
(dict) --
A description of the identity.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
Logins (list) --
The provider names.
CreationDate (datetime) --
Date on which the identity was created.
LastModifiedDate (datetime) --
Date on which the identity was last modified.
NextToken (string) --
A pagination token.
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.list_identity_pools(
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The maximum number of identities to return.
dict
Response Syntax
{
'IdentityPools': [
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result of a successful ListIdentityPools action.
IdentityPools (list) --
The identity pools returned by the ListIdentityPools action.
(dict) --
A description of the identity pool.
IdentityPoolId (string) --
An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
NextToken (string) --
A pagination token.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The tags that are assigned to the identity pool.
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values 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.
LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.lookup_developer_identity(
IdentityPoolId='string',
IdentityId='string',
DeveloperUserIdentifier='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{
'IdentityId': 'string',
'DeveloperUserIdentifierList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Returned in response to a successful LookupDeveloperIdentity action.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
DeveloperUserIdentifierList (list) --
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
NextToken (string) --
A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
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.
The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier , and the destination user, DestinationUserIdentifier , together should not be larger than 20. Otherwise, an exception will be thrown.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.merge_developer_identities(
SourceUserIdentifier='string',
DestinationUserIdentifier='string',
DeveloperProviderName='string',
IdentityPoolId='string'
)
[REQUIRED]
User identifier for the source user. The value should be a DeveloperUserIdentifier .
[REQUIRED]
User identifier for the destination user. The value should be a DeveloperUserIdentifier .
[REQUIRED]
The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (.), underscore (_), and dash (-).
[REQUIRED]
An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{
'IdentityId': 'string'
}
Response Structure
(dict) --
Returned in response to a successful MergeDeveloperIdentities action.
IdentityId (string) --
A unique identifier in the format REGION:GUID.
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.
See also: AWS API Documentation
Request Syntax
response = client.set_identity_pool_roles(
IdentityPoolId='string',
Roles={
'string': 'string'
},
RoleMappings={
'string': {
'Type': 'Token'|'Rules',
'AmbiguousRoleResolution': 'AuthenticatedRole'|'Deny',
'RulesConfiguration': {
'Rules': [
{
'Claim': 'string',
'MatchType': 'Equals'|'Contains'|'StartsWith'|'NotEqual',
'Value': 'string',
'RoleARN': 'string'
},
]
}
}
}
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
[REQUIRED]
The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
Up to 25 rules can be specified per identity provider.
A role mapping.
The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
If you specify Token or Rules as the Type , AmbiguousRoleResolution is required.
Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.
The rules to be used for mapping users to roles.
If you specify Rules as the role mapping type, RulesConfiguration is required.
An array of rules. You can specify up to 25 rules per identity provider.
Rules are evaluated in order. The first one to match specifies the role.
A rule that maps a claim name, a claim value, and a match type to a role ARN.
The claim name that must be present in the token, for example, "isAdmin" or "paid".
The match condition that specifies how closely the claim value in the IdP token must match Value .
A brief string that the claim must match, for example, "paid" or "yes".
The role ARN.
None
Assigns a set of tags to an 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 Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.
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.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the identity pool to assign the tags to.
The tags to assign to the identity pool.
dict
Response Syntax
{}
Response Structure
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.
See also: AWS API Documentation
Request Syntax
response = client.unlink_developer_identity(
IdentityId='string',
IdentityPoolId='string',
DeveloperProviderName='string',
DeveloperUserIdentifier='string'
)
[REQUIRED]
A unique identifier in the format REGION:GUID.
[REQUIRED]
An identity pool ID in the format REGION:GUID.
[REQUIRED]
The "domain" by which Cognito will refer to your users.
[REQUIRED]
A unique ID used by your backend authentication process to identify a user.
None
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.
See also: AWS API Documentation
Request Syntax
response = client.unlink_identity(
IdentityId='string',
Logins={
'string': 'string'
},
LoginsToRemove=[
'string',
]
)
[REQUIRED]
A unique identifier in the format REGION:GUID.
[REQUIRED]
A set of optional name-value pairs that map provider names to provider tokens.
[REQUIRED]
Provider names to unlink from this identity.
None
Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
The keys of the tags to remove from the user pool.
dict
Response Syntax
{}
Response Structure
Updates an identity pool.
You must use AWS Developer credentials to call this API.
See also: AWS API Documentation
Request Syntax
response = client.update_identity_pool(
IdentityPoolId='string',
IdentityPoolName='string',
AllowUnauthenticatedIdentities=True|False,
SupportedLoginProviders={
'string': 'string'
},
DeveloperProviderName='string',
OpenIdConnectProviderARNs=[
'string',
],
CognitoIdentityProviders=[
{
'ProviderName': 'string',
'ClientId': 'string',
'ServerSideTokenCheck': True|False
},
],
SamlProviderARNs=[
'string',
],
IdentityPoolTags={
'string': 'string'
}
)
[REQUIRED]
An identity pool ID in the format REGION:GUID.
[REQUIRED]
A string that you provide.
[REQUIRED]
TRUE if the identity pool supports unauthenticated logins.
Optional key:value pairs mapping provider names to provider app IDs.
A list of OpendID Connect provider ARNs.
A list representing an Amazon Cognito user pool and its client ID.
A provider representing an Amazon Cognito user pool and its client ID.
The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
The client ID for the Amazon Cognito user pool.
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
The tags that are assigned to the 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.
dict
Response Syntax
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string',
'AllowUnauthenticatedIdentities': True|False,
'SupportedLoginProviders': {
'string': 'string'
},
'DeveloperProviderName': 'string',
'OpenIdConnectProviderARNs': [
'string',
],
'CognitoIdentityProviders': [
{
'ProviderName': 'string',
'ClientId': 'string',
'ServerSideTokenCheck': True|False
},
],
'SamlProviderARNs': [
'string',
],
'IdentityPoolTags': {
'string': 'string'
}
}
Response Structure
(dict) --
An object representing an Amazon Cognito identity pool.
IdentityPoolId (string) --
An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) --
TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
A list of OpendID Connect provider ARNs.
CognitoIdentityProviders (list) --
A list representing an Amazon Cognito user pool and its client ID.
(dict) --
A provider representing an Amazon Cognito user pool and its client ID.
ProviderName (string) --
The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
ClientId (string) --
The client ID for the Amazon Cognito user pool.
ServerSideTokenCheck (boolean) --
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
SamlProviderARNs (list) --
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
IdentityPoolTags (dict) --
The tags that are assigned to the 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.
The available paginators are:
paginator = client.get_paginator('list_identity_pools')
Creates an iterator that will paginate through responses from CognitoIdentity.Client.list_identity_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'IdentityPools': [
{
'IdentityPoolId': 'string',
'IdentityPoolName': 'string'
},
],
}
Response Structure
The result of a successful ListIdentityPools action.
The identity pools returned by the ListIdentityPools action.
A description of the identity pool.
An identity pool ID in the format REGION:GUID.
A string that you provide.