PinpointEmail / Client / list_email_identities

list_email_identities#

PinpointEmail.Client.list_email_identities(**kwargs)#

Returns a list of all of the email identities that are associated with your Amazon Pinpoint 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.

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
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

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

    • EmailIdentities (list) –

      An array that includes all of the identities associated with your Amazon Pinpoint account.

      • (dict) –

        Information about an email identity.

        • IdentityType (string) –

          The email identity type. The identity type can be one of the following:

          • EMAIL_ADDRESS – The identity is an email address.

          • DOMAIN – The identity is a domain.

          • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

        • IdentityName (string) –

          The address or domain of the identity.

        • SendingEnabled (boolean) –

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

          In Amazon Pinpoint, 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 Pinpoint to send email from that 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

  • PinpointEmail.Client.exceptions.TooManyRequestsException

  • PinpointEmail.Client.exceptions.BadRequestException