Skip to content

Cognito Identity  >  Operations  >  describe_identity

describe_identity

Operation

describe_identity async 

describe_identity(input: DescribeIdentityInput, plugins: list[Plugin] | None = None) -> DescribeIdentityOutput

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.

Parameters:

Name Type Description Default
input DescribeIdentityInput

An instance of DescribeIdentityInput.

 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
DescribeIdentityOutput

An instance of DescribeIdentityOutput.

Input

DescribeIdentityInput dataclass

Input to the DescribeIdentity action.

Attributes

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

A unique identifier in the format REGION:GUID.

Output

DescribeIdentityOutput dataclass

A description of the identity.

Attributes

creation_date class-attribute instance-attribute 
creation_date: datetime | None = None

Date on which the identity was created.

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

A unique identifier in the format REGION:GUID.

last_modified_date class-attribute instance-attribute 
last_modified_date: datetime | None = None

Date on which the identity was last modified.

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

The provider names.