Skip to content

unlink_developer_identity

Operation

unlink_developer_identity(request: UnlinkDeveloperIdentityInput | UnlinkDeveloperIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnlinkDeveloperIdentityInputDict]) -> UnlinkDeveloperIdentityOutput

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.

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

Name Type Description Default
request UnlinkDeveloperIdentityInput | UnlinkDeveloperIdentityInputDict | 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[UnlinkDeveloperIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnlinkDeveloperIdentityOutput

An instance of UnlinkDeveloperIdentityOutput.

unlink_developer_identity(request: UnlinkDeveloperIdentityInput | UnlinkDeveloperIdentityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnlinkDeveloperIdentityInputDict]) -> UnlinkDeveloperIdentityOutput

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.

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

Name Type Description Default
request UnlinkDeveloperIdentityInput | UnlinkDeveloperIdentityInputDict | 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[UnlinkDeveloperIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnlinkDeveloperIdentityOutput

An instance of UnlinkDeveloperIdentityOutput.

Input

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

UnlinkDeveloperIdentityInputDict

Bases: TypedDict

Dictionary form of UnlinkDeveloperIdentityInput.

Attributes

developer_provider_name instance-attribute
developer_provider_name: Required[str]

The "domain" by which Cognito will refer to your users.

developer_user_identifier instance-attribute
developer_user_identifier: Required[str]

A unique ID used by your backend authentication process to identify a user.

identity_id instance-attribute
identity_id: Required[str]

A unique identifier in the format REGION:GUID.

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

UnlinkDeveloperIdentityInput dataclass

Bases: _SerdeShape

Input to the UnlinkDeveloperIdentity action.

Attributes

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

The "domain" by which Cognito will refer to your users.

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

A unique ID used by your backend authentication process to identify a user.

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

A unique identifier in the format REGION:GUID.

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

An identity pool ID in the format REGION:GUID.

Output

UnlinkDeveloperIdentityOutput dataclass

Bases: _SerdeShape

Dataclass for UnlinkDeveloperIdentityOutput structure.

Attributes

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.