Skip to content

Cognito Identity  >  Operations  >  delete_identities

delete_identities

Operation

delete_identities async

delete_identities(input: DeleteIdentitiesInput, plugins: list[Plugin] | None = None) -> DeleteIdentitiesOutput

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

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

Parameters:

Name Type Description Default
input DeleteIdentitiesInput

An instance of DeleteIdentitiesInput.

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
DeleteIdentitiesOutput

An instance of DeleteIdentitiesOutput.

Input

DeleteIdentitiesInput dataclass

Input to the DeleteIdentities action.

Attributes

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

A list of 1-60 identities that you want to delete.

Output

DeleteIdentitiesOutput dataclass

Returned in response to a successful DeleteIdentities operation.

Attributes

unprocessed_identity_ids class-attribute instance-attribute
unprocessed_identity_ids: list[UnprocessedIdentityId] | None = None

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.