Skip to content

Cognito Identity  >  Operations  >  get_id

get_id

Operation

get_id async 

get_id(input: GetIdInput, plugins: list[Plugin] | None = None) -> GetIdOutput

Generates (or retrieves) IdentityID. Supplying multiple logins will create an implicit linked account.

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

Parameters:

Name Type Description Default
input GetIdInput

An instance of GetIdInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetIdOutput

An instance of GetIdOutput.

Input

GetIdInput dataclass

Input to the GetId action.

Attributes

account_id class-attribute instance-attribute 
account_id: str | None = None

A standard Amazon Web Services account ID (9+ digits).

identity_pool_id class-attribute instance-attribute 
identity_pool_id: str | None = None

An identity pool ID in the format REGION:GUID.

logins class-attribute instance-attribute 
logins: dict[str, str] | None = None

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

  • Facebook: graph.facebook.com

  • Amazon Cognito user pool: cognito-idp.``<region>.amazonaws.com/``<your_user_pool_id>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

Output

GetIdOutput dataclass

Returned in response to a GetId request.

Attributes

identity_id class-attribute instance-attribute 
identity_id: str | None = None

A unique identifier in the format REGION:GUID.