Request Syntax Request Parameters Response Elements Errors Examples See Also

DeleteIdentityPool

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

Note

Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Signing AWS API Requests

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.

IdentityPoolId

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.

Errors

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

InternalErrorException

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

message: The message returned by an InternalErrorException.

HTTP Status Code: 500

InvalidParameterException

Thrown for missing or bad input parameter(s).

message: The message returned by an InvalidParameterException.

HTTP Status Code: 400

NotAuthorizedException

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

message: The message returned by a NotAuthorizedException

HTTP Status Code: 400

ResourceNotFoundException

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

message: The message returned by a ResourceNotFoundException.

HTTP Status Code: 400

TooManyRequestsException

Thrown when a request is throttled.

message: Message returned by a TooManyRequestsException

HTTP Status Code: 400

Examples

DeleteIdentityPool

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"
}