delete_identities

delete_identities(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_identities(
    IdentityIdsToDelete=[
        'string',
    ]
)
Parameters
IdentityIdsToDelete (list) --

[REQUIRED]

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

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'UnprocessedIdentityIds': [
        {
            'IdentityId': 'string',
            'ErrorCode': 'AccessDenied'|'InternalServerError'
        },
    ]
}

Response Structure

  • (dict) --

    Returned in response to a successful DeleteIdentities operation.

    • UnprocessedIdentityIds (list) --

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

      • (dict) --

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

        • IdentityId (string) --

          A unique identifier in the format REGION:GUID.

        • ErrorCode (string) --

          The error code indicating the type of error that occurred.

Exceptions

  • CognitoIdentity.Client.exceptions.InvalidParameterException
  • CognitoIdentity.Client.exceptions.TooManyRequestsException
  • CognitoIdentity.Client.exceptions.InternalErrorException