Skip to content

describe_identity

Operation

describe_identity

describe_identity(request: DescribeIdentityInput | DescribeIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityInputDict]) -> 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
request DescribeIdentityInput | DescribeIdentityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIdentityOutput

An instance of DescribeIdentityOutput.

describe_identity async

describe_identity(request: DescribeIdentityInput | DescribeIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityInputDict]) -> 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
request DescribeIdentityInput | DescribeIdentityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIdentityOutput

An instance of DescribeIdentityOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeIdentityInputDict

Bases: TypedDict

Dictionary form of DescribeIdentityInput.

Attributes

identity_id instance-attribute
identity_id: Required[str]

A unique identifier in the format REGION:GUID.

DescribeIdentityInput dataclass

Bases: _SerdeShape

Input to the DescribeIdentity action.

Attributes

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

A unique identifier in the format REGION:GUID.

Output

DescribeIdentityOutput dataclass

Bases: _SerdeShape

A description of the identity.

Attributes

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

Date on which the identity was created.

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

A unique identifier in the format REGION:GUID.

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

Date on which the identity was last modified.

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

The provider names.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.