[ aws . cognito-identity ]

delete-identities

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-identities
--identity-ids-to-delete <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identity-ids-to-delete (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To delete identity pool

This example deletes an identity ppol.

Command:

aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111"

Output:

{
  "UnprocessedIdentityIds": []
}

Output

UnprocessedIdentityIds -> (list)

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

(structure)

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.