Skip to content

get_id

Operation

get_id

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

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIdOutput

An instance of GetIdOutput.

get_id async

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

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIdOutput

An instance of GetIdOutput.

Input

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

GetIdInputDict

Bases: TypedDict

Dictionary form of GetIdInput.

Attributes

account_id instance-attribute
account_id: str | None

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

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

logins instance-attribute
logins: Mapping[str, str] | 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

GetIdInput dataclass

Bases: _SerdeShape

Input to the GetId action.

Attributes

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

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

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

An identity pool ID in the format REGION:GUID.

logins class-attribute instance-attribute
logins: dict[str, str] | 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

Bases: _SerdeShape

Returned in response to a GetId request.

Attributes

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

A unique identifier in the format REGION:GUID.

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.