SES / Client / list_identities

list_identities#

SES.Client.list_identities(**kwargs)#

Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

You can execute this operation no more than once per second.

Request Syntax

response = client.list_identities(
    IdentityType='EmailAddress'|'Domain',
    NextToken='string',
    MaxItems=123
)

Parameters:

IdentityType (string) – The type of the identities to list. Possible values are “EmailAddress” and “Domain”. If this parameter is omitted, then all identities will be listed.
NextToken (string) – The token to use for pagination.
MaxItems (integer) – The maximum number of identities per page. Possible values are 1-1000 inclusive.

Return type:

dict

Returns:

Response Syntax

{
    'Identities': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.
- Identities (list) –
  
  A list of identities.
  - (string) –
- NextToken (string) –
  
  The token used for pagination.

Examples

The following example lists the email address identities that have been submitted for verification with Amazon SES:

response = client.list_identities(
    IdentityType='EmailAddress',
    MaxItems=123,
    NextToken='',
)

print(response)

Expected Output:

{
    'Identities': [
        'user@example.com',
    ],
    'NextToken': '',
    'ResponseMetadata': {
        '...': '...',
    },
}