Skip to content

delete_identities

Operation

delete_identities

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

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIdentitiesOutput

An instance of DeleteIdentitiesOutput.

delete_identities async

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

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIdentitiesOutput

An instance of DeleteIdentitiesOutput.

Input

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

DeleteIdentitiesInputDict

Bases: TypedDict

Dictionary form of DeleteIdentitiesInput.

Attributes

identity_ids_to_delete instance-attribute
identity_ids_to_delete: Required[Sequence[str]]

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

DeleteIdentitiesInput dataclass

Bases: _SerdeShape

Input to the DeleteIdentities action.

Attributes

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

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

Output

DeleteIdentitiesOutput dataclass

Bases: _SerdeShape

Returned in response to a successful DeleteIdentities operation.

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.

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

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