Skip to main content

credentials_for_identities

Creates, updates, deletes, gets or lists a credentials_for_identities resource.

Overview

Namecredentials_for_identities
TypeResource
Idaws.cognito_identity.credentials_for_identities

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
credentialsobjectCredentials for the provided identity ID.
identity_idstringA unique identifier in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_credentials_for_identityselectregionReturns 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 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.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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 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.

SELECT
credentials,
identity_id
FROM aws.cognito_identity.credentials_for_identities
WHERE region = '{{ region }}' -- required
;