PinpointEmail / Paginator / ListEmailIdentities


class PinpointEmail.Paginator.ListEmailIdentities#
paginator = client.get_paginator('list_email_identities')

Creates an iterator that will paginate through responses from PinpointEmail.Client.list_email_identities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'EmailIdentities': [
            'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
            'IdentityName': 'string',
            'SendingEnabled': True|False


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.