Skip to content

Cognito Identity  >  Operations  >  delete_identity_pool

delete_identity_pool

Operation

delete_identity_pool async 

delete_identity_pool(input: DeleteIdentityPoolInput, plugins: list[Plugin] | None = None) -> 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
input DeleteIdentityPoolInput

An instance of DeleteIdentityPoolInput.

 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
DeleteIdentityPoolOutput

An instance of DeleteIdentityPoolOutput.

Input

DeleteIdentityPoolInput dataclass

Input to the DeleteIdentityPool action.

Attributes

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

An identity pool ID in the format REGION:GUID.

Output

DeleteIdentityPoolOutput dataclass

Dataclass for DeleteIdentityPoolOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.