identities

Creates, updates, deletes, gets or lists an identities resource.

Overview

Name	identities
Type	Resource
Id	aws.cognito_identity.identities

Fields

The following fields are returned by SELECT queries:

list_identities

Name	Datatype	Description
identities	array	An object containing a set of identities and associated mappings.
identity_pool_id	string	An identity pool ID in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>)
next_token	string	A pagination token. (pattern: <code>[\S]+</code>)

describe_identity

Name	Datatype	Description
creation_date	string (date-time)	Date on which the identity was created.
identity_id	string	A unique identifier in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>)
last_modified_date	string (date-time)	Date on which the identity was last modified.
logins	array	The provider names.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_identities	select	region		Lists the identities in an identity pool. You must use Amazon Web Services developer credentials to call this operation.
describe_identity	select	region		Returns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use Amazon Web Services developer credentials to call this operation.
delete_identities	delete	region		Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use Amazon Web Services developer credentials to call this operation.
unlink_identity	exec	region, IdentityId, LoginsToRemove		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_identities

Lists the identities in an identity pool. You must use Amazon Web Services developer credentials to call this operation.

SELECT
identities,
identity_pool_id,
next_token
FROM aws.cognito_identity.identities
WHERE region = '{{ region }}' -- required
;

describe_identity

Returns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use Amazon Web Services developer credentials to call this operation.

SELECT
creation_date,
identity_id,
last_modified_date,
logins
FROM aws.cognito_identity.identities
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_identities

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use Amazon Web Services developer credentials to call this operation.

DELETE FROM aws.cognito_identity.identities
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

unlink_identity

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.

EXEC aws.cognito_identity.identities.unlink_identity 
@region='{{ region }}' --required 
@@json=
'{
"IdentityId": "{{ IdentityId }}", 
"Logins": "{{ Logins }}", 
"LoginsToRemove": "{{ LoginsToRemove }}"
}'
;