SESV2 / Client / list_email_identities

list_email_identities#

SESV2.Client.list_email_identities(**kwargs)#

Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren’t. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.

See also: AWS API Documentation

Request Syntax

response = client.list_email_identities(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

  • PageSize (integer) –

    The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 0, and can be no more than 1000.

Return type:

dict

Returns:

Response Syntax

{
    'EmailIdentities': [
        {
            'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
            'IdentityName': 'string',
            'SendingEnabled': True|False,
            'VerificationStatus': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A list of all of the identities that you’ve attempted to verify, regardless of whether or not those identities were successfully verified.

    • EmailIdentities (list) –

      An array that includes all of the email identities associated with your Amazon Web Services account.

      • (dict) –

        Information about an email identity.

        • IdentityType (string) –

          The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.

        • IdentityName (string) –

          The address or domain of the identity.

        • SendingEnabled (boolean) –

          Indicates whether or not you can send email from the identity.

          An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.

        • VerificationStatus (string) –

          The verification status of the identity. The status can be one of the following:

          • PENDING – The verification process was initiated, but Amazon SES hasn’t yet been able to verify the identity.

          • SUCCESS – The verification process completed successfully.

          • FAILED – The verification process failed.

          • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification status of the identity.

          • NOT_STARTED – The verification process hasn’t been initiated for the identity.

    • NextToken (string) –

      A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

Exceptions

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException