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

DeleteIdentities

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Request Syntax

{
   "IdentityIdsToDelete": [ "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.

IdentityIdsToDelete

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 60 items.

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

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

Required: Yes

Response Syntax

{
   "UnprocessedIdentityIds": [ 
      { 
         "ErrorCode": "string",
         "IdentityId": "string"
      }
   ]
}

Response Elements

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

The following data is returned in JSON format by the service.

UnprocessedIdentityIds

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

Type: Array of UnprocessedIdentityId objects

Array Members: Maximum number of 60 items.

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.

HTTP Status Code: 500

InvalidParameterException

Thrown for missing or bad input parameter(s).

HTTP Status Code: 400

TooManyRequestsException

Thrown when a request is throttled.

HTTP Status Code: 400

See Also

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