ExAws.CognitoIdentity.Core

Amazon Cognito Identity

Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.

Source

Summary

create_identity_pool!(client, input)

Same as create_identity_pool/2 but raise on error

create_identity_pool(client, input)

CreateIdentityPool

delete_identities!(client, input)

Same as delete_identities/2 but raise on error

delete_identities(client, input)

DeleteIdentities

delete_identity_pool!(client, input)

Same as delete_identity_pool/2 but raise on error

delete_identity_pool(client, input)

DeleteIdentityPool

describe_identity!(client, input)

Same as describe_identity/2 but raise on error

describe_identity(client, input)

DescribeIdentity

describe_identity_pool!(client, input)

Same as describe_identity_pool/2 but raise on error

describe_identity_pool(client, input)

DescribeIdentityPool

get_credentials_for_identity!(client, input)

Same as get_credentials_for_identity/2 but raise on error

get_credentials_for_identity(client, input)

GetCredentialsForIdentity

get_id!(client, input)

Same as get_id/2 but raise on error

get_id(client, input)

GetId

get_identity_pool_roles!(client, input)

Same as get_identity_pool_roles/2 but raise on error

get_identity_pool_roles(client, input)

GetIdentityPoolRoles

get_open_id_token!(client, input)

Same as get_open_id_token/2 but raise on error

get_open_id_token(client, input)

GetOpenIdToken

get_open_id_token_for_developer_identity!(client, input)

Same as get_open_id_token_for_developer_identity/2 but raise on error

get_open_id_token_for_developer_identity(client, input)

GetOpenIdTokenForDeveloperIdentity

list_identities!(client, input)

Same as list_identities/2 but raise on error

list_identities(client, input)

ListIdentities

list_identity_pools!(client, input)

Same as list_identity_pools/2 but raise on error

list_identity_pools(client, input)

ListIdentityPools

lookup_developer_identity!(client, input)

Same as lookup_developer_identity/2 but raise on error

lookup_developer_identity(client, input)

LookupDeveloperIdentity

merge_developer_identities!(client, input)

Same as merge_developer_identities/2 but raise on error

merge_developer_identities(client, input)

MergeDeveloperIdentities

set_identity_pool_roles!(client, input)

Same as set_identity_pool_roles/2 but raise on error

set_identity_pool_roles(client, input)

SetIdentityPoolRoles

unlink_developer_identity!(client, input)

Same as unlink_developer_identity/2 but raise on error

unlink_developer_identity(client, input)

UnlinkDeveloperIdentity

unlink_identity!(client, input)

Same as unlink_identity/2 but raise on error

unlink_identity(client, input)

UnlinkIdentity

update_identity_pool!(client, input)

Same as update_identity_pool/2 but raise on error

update_identity_pool(client, input)

UpdateIdentityPool

Types

identity_pool_name :: binary

token_duration :: integer

describe_identity_input :: [{:identity_id, identity_id}]

delete_identity_pool_input :: [{:identity_pool_id, identity_pool_id}]

merge_developer_identities_input :: [destination_user_identifier: developer_user_identifier, developer_provider_name: developer_provider_name, identity_pool_id: identity_pool_id, source_user_identifier: developer_user_identifier]

invalid_parameter_exception :: [{:message, binary}]

list_identities_response :: [identities: identities_list, identity_pool_id: identity_pool_id, next_token: pagination_key]

unprocessed_identity_id :: [error_code: error_code, identity_id: identity_id]

access_key_string :: binary

query_limit :: integer

create_identity_pool_input :: [allow_unauthenticated_identities: identity_pool_unauthenticated, developer_provider_name: developer_provider_name, identity_pool_name: identity_pool_name, open_id_connect_provider_ar_ns: oidc_provider_list, supported_login_providers: identity_providers]

identity_pool_short_description :: [identity_pool_id: identity_pool_id, identity_pool_name: identity_pool_name]

credentials :: [access_key_id: access_key_string, expiration: date_type, secret_key: secret_key_string, session_token: session_token_string]

list_identities_input :: [hide_disabled: hide_disabled, identity_pool_id: identity_pool_id, max_results: query_limit, next_token: pagination_key]

lookup_developer_identity_input :: [developer_user_identifier: developer_user_identifier, identity_id: identity_id, identity_pool_id: identity_pool_id, max_results: query_limit, next_token: pagination_key]

resource_conflict_exception :: [{:message, binary}]

secret_key_string :: binary

account_id :: binary

too_many_requests_exception :: [{:message, binary}]

error_code :: binary

identity_id :: binary

internal_error_exception :: [{:message, binary}]

get_id_input :: [account_id: account_id, identity_pool_id: identity_pool_id, logins: logins_map]

get_open_id_token_for_developer_identity_input :: [identity_id: identity_id, identity_pool_id: identity_pool_id, logins: logins_map, token_duration: token_duration]

identity_description :: [creation_date: date_type, identity_id: identity_id, last_modified_date: date_type, logins: logins_list]

identity_pool_id :: binary

not_authorized_exception :: [{:message, binary}]

hide_disabled :: boolean

role_type :: binary

limit_exceeded_exception :: [{:message, binary}]

arn_string :: binary

resource_not_found_exception :: [{:message, binary}]

pagination_key :: binary

get_open_id_token_input :: [identity_id: identity_id, logins: logins_map]

date_type :: integer

oidc_token :: binary

get_id_response :: [{:identity_id, identity_id}]

delete_identities_response :: [{:unprocessed_identity_ids, unprocessed_identity_id_list}]

identity_pool :: [allow_unauthenticated_identities: identity_pool_unauthenticated, developer_provider_name: developer_provider_name, identity_pool_id: identity_pool_id, identity_pool_name: identity_pool_name, open_id_connect_provider_ar_ns: oidc_provider_list, supported_login_providers: identity_providers]

delete_identities_input :: [{:identity_ids_to_delete, identity_id_list}]

list_identity_pools_input :: [max_results: query_limit, next_token: pagination_key]

external_service_exception :: [{:message, binary}]

concurrent_modification_exception :: [{:message, binary}]

lookup_developer_identity_response :: [developer_user_identifier_list: developer_user_identifier_list, identity_id: identity_id, next_token: pagination_key]

Functions

create_identity_pool(client, input)

Specs:

CreateIdentityPool

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. You must use AWS Developer credentials to call this API.

Source
create_identity_pool!(client, input)

Specs:

  • create_identity_pool!(client :: ExAws.CognitoIdentity.t, input :: create_identity_pool_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_identity_pool/2 but raise on error.

Source
delete_identities(client, input)

Specs:

  • delete_identities(client :: ExAws.CognitoIdentity.t, input :: delete_identities_input) :: ExAws.Request.JSON.response_t

DeleteIdentities

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.

Source
delete_identities!(client, input)

Specs:

  • delete_identities!(client :: ExAws.CognitoIdentity.t, input :: delete_identities_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_identities/2 but raise on error.

Source
delete_identity_pool(client, input)

Specs:

DeleteIdentityPool

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.

Source
delete_identity_pool!(client, input)

Specs:

  • delete_identity_pool!(client :: ExAws.CognitoIdentity.t, input :: delete_identity_pool_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_identity_pool/2 but raise on error.

Source
describe_identity(client, input)

Specs:

  • describe_identity(client :: ExAws.CognitoIdentity.t, input :: describe_identity_input) :: ExAws.Request.JSON.response_t

DescribeIdentity

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.

Source
describe_identity!(client, input)

Specs:

  • describe_identity!(client :: ExAws.CognitoIdentity.t, input :: describe_identity_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_identity/2 but raise on error.

Source
describe_identity_pool(client, input)

Specs:

DescribeIdentityPool

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.

Source
describe_identity_pool!(client, input)

Specs:

  • describe_identity_pool!(client :: ExAws.CognitoIdentity.t, input :: describe_identity_pool_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_identity_pool/2 but raise on error.

Source
get_credentials_for_identity(client, input)

Specs:

GetCredentialsForIdentity

Returns credentials for the 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.

Source
get_credentials_for_identity!(client, input)

Specs:

Same as get_credentials_for_identity/2 but raise on error.

Source
get_id(client, input)

Specs:

  • get_id(client :: ExAws.CognitoIdentity.t, input :: get_id_input) :: ExAws.Request.JSON.response_t

GetId

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

token+”;”+tokenSecret.

This is a public API. You do not need any credentials to call this API.

Source
get_id!(client, input)

Specs:

  • get_id!(client :: ExAws.CognitoIdentity.t, input :: get_id_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_id/2 but raise on error.

Source
get_identity_pool_roles(client, input)

Specs:

GetIdentityPoolRoles

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Source
get_identity_pool_roles!(client, input)

Specs:

  • get_identity_pool_roles!(client :: ExAws.CognitoIdentity.t, input :: get_identity_pool_roles_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_identity_pool_roles/2 but raise on error.

Source
get_open_id_token(client, input)

Specs:

  • get_open_id_token(client :: ExAws.CognitoIdentity.t, input :: get_open_id_token_input) :: ExAws.Request.JSON.response_t

GetOpenIdToken

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.

Source
get_open_id_token!(client, input)

Specs:

  • get_open_id_token!(client :: ExAws.CognitoIdentity.t, input :: get_open_id_token_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_open_id_token/2 but raise on error.

Source
get_open_id_token_for_developer_identity(client, input)

Specs:

GetOpenIdTokenForDeveloperIdentity

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.

Source
get_open_id_token_for_developer_identity!(client, input)

Specs:

Same as get_open_id_token_for_developer_identity/2 but raise on error.

Source
list_identities(client, input)

Specs:

  • list_identities(client :: ExAws.CognitoIdentity.t, input :: list_identities_input) :: ExAws.Request.JSON.response_t

ListIdentities

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Source
list_identities!(client, input)

Specs:

  • list_identities!(client :: ExAws.CognitoIdentity.t, input :: list_identities_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_identities/2 but raise on error.

Source
list_identity_pools(client, input)

Specs:

  • list_identity_pools(client :: ExAws.CognitoIdentity.t, input :: list_identity_pools_input) :: ExAws.Request.JSON.response_t

ListIdentityPools

Lists all of the Cognito identity pools registered for your account.

This is a public API. You do not need any credentials to call this API.

Source
list_identity_pools!(client, input)

Specs:

  • list_identity_pools!(client :: ExAws.CognitoIdentity.t, input :: list_identity_pools_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_identity_pools/2 but raise on error.

Source
lookup_developer_identity(client, input)

Specs:

LookupDeveloperIdentity

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers 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.

Source
lookup_developer_identity!(client, input)

Specs:

Same as lookup_developer_identity/2 but raise on error.

Source
merge_developer_identities(client, input)

Specs:

MergeDeveloperIdentities

Merges two users having different IdentityIds, 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.

Source
merge_developer_identities!(client, input)

Specs:

Same as merge_developer_identities/2 but raise on error.

Source
set_identity_pool_roles(client, input)

Specs:

SetIdentityPoolRoles

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.

Source
set_identity_pool_roles!(client, input)

Specs:

  • set_identity_pool_roles!(client :: ExAws.CognitoIdentity.t, input :: set_identity_pool_roles_input) :: ExAws.Request.JSON.success_t | no_return

Same as set_identity_pool_roles/2 but raise on error.

Source

Specs:

UnlinkDeveloperIdentity

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.

This is a public API. You do not need any credentials to call this API.

Source

Specs:

Same as unlink_developer_identity/2 but raise on error.

Source

Specs:

  • unlink_identity(client :: ExAws.CognitoIdentity.t, input :: unlink_identity_input) :: ExAws.Request.JSON.response_t

UnlinkIdentity

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.

Source

Specs:

  • unlink_identity!(client :: ExAws.CognitoIdentity.t, input :: unlink_identity_input) :: ExAws.Request.JSON.success_t | no_return

Same as unlink_identity/2 but raise on error.

Source
update_identity_pool(client, input)

Specs:

  • update_identity_pool(client :: ExAws.CognitoIdentity.t, input :: identity_pool) :: ExAws.Request.JSON.response_t

UpdateIdentityPool

Updates a user pool.

You must use AWS Developer credentials to call this API.

Source
update_identity_pool!(client, input)

Specs:

  • update_identity_pool!(client :: ExAws.CognitoIdentity.t, input :: identity_pool) :: ExAws.Request.JSON.success_t | no_return

Same as update_identity_pool/2 but raise on error.

Source