Amazon Cognito Federated Identities
API Reference (API Version 2014-06-30)


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

You must use AWS Developer credentials to call this API.

Request Syntax

{ "IdentityPoolId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


An identity pool ID in the format REGION:GUID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


Thrown when the service encounters an error during processing the request.

HTTP Status Code: 500


Thrown for missing or bad input parameter(s).

HTTP Status Code: 400


Thrown when a user is not authorized to access the requested resource.

HTTP Status Code: 400


Thrown when the requested resource (for example, a dataset or record) does not exist.

HTTP Status Code: 400


Thrown when a request is throttled.

HTTP Status Code: 400



The following is an example of a DeleteIdentityPool request. The request body has been formatted for readability and may not match the content-length value.

Sample Request

POST / HTTP/1.1 CONTENT-TYPE: application/json CONTENT-LENGTH: 222 X-AMZ-TARGET: com.amazonaws.cognito.identity.model.AWSCognitoIdentityService.DeleteIdentityPool HOST: <endpoint> X-AMZ-DATE: 20140804T214319Z AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature> { "IdentityPoolId": "us-east-1:177a950c-2c08-43f0-9983-28727EXAMPLE" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: