Skip to content

delete_identity_pool

Operation

delete_identity_pool

delete_identity_pool(request: DeleteIdentityPoolInput | DeleteIdentityPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIdentityPoolInputDict]) -> DeleteIdentityPoolOutput

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

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

Parameters:

Name Type Description Default
request DeleteIdentityPoolInput | DeleteIdentityPoolInputDict | 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[DeleteIdentityPoolInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIdentityPoolOutput

An instance of DeleteIdentityPoolOutput.

delete_identity_pool async

delete_identity_pool(request: DeleteIdentityPoolInput | DeleteIdentityPoolInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIdentityPoolInputDict]) -> DeleteIdentityPoolOutput

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

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

Parameters:

Name Type Description Default
request DeleteIdentityPoolInput | DeleteIdentityPoolInputDict | 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[DeleteIdentityPoolInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIdentityPoolOutput

An instance of DeleteIdentityPoolOutput.

Input

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

DeleteIdentityPoolInputDict

Bases: TypedDict

Dictionary form of DeleteIdentityPoolInput.

Attributes

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

DeleteIdentityPoolInput dataclass

Bases: _SerdeShape

Input to the DeleteIdentityPool action.

Attributes

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

An identity pool ID in the format REGION:GUID.

Output

DeleteIdentityPoolOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIdentityPoolOutput 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.