Amazon Cognito Identity

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

client.delete_identities(
    IdentityIdsToDelete=[
        'string',
    ]
)

type IdentityIdsToDelete

list

param IdentityIdsToDelete

[REQUIRED]

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

• (string) --

rtype

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.

{'HideDisabled': 'boolean'}

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Request Syntax

client.list_identities(
    IdentityPoolId='string',
    MaxResults=123,
    NextToken='string',
    HideDisabled=True|False
)

type IdentityPoolId

string

param IdentityPoolId

[REQUIRED] An identity pool ID in the format REGION:GUID.

type MaxResults

integer

param MaxResults

[REQUIRED] The maximum number of identities to return.

type NextToken

string

param NextToken

A pagination token.

type HideDisabled

boolean

param HideDisabled

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

rtype

dict

returns

Response Syntax

{
    'IdentityPoolId': 'string',
    'Identities': [
        {
            'IdentityId': 'string',
            'Logins': [
                'string',
            ],
            'CreationDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- The response to a ListIdentities request.

  • IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.

  • Identities (list) -- An object containing a set of identities and associated mappings.

    • (dict) -- A description of the identity.

      • IdentityId (string) -- A unique identifier in the format REGION:GUID.

      • Logins (list) -- A set of optional name-value pairs that map provider names to provider tokens.

        • (string) --

      • CreationDate (datetime) --

        Date on which the identity was created.

      • LastModifiedDate (datetime) --

        Date on which the identity was last modified.

  • NextToken (string) -- A pagination token.