List Email Identities

pinpointemail_list_email_identities

R Documentation

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account¶

Description¶

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.

Usage¶

pinpointemail_list_email_identities(NextToken, PageSize)

Arguments¶

NextToken

A token returned from a previous call to list_email_identities to indicate the position in the list of identities.

PageSize

The number of results to show in a single call to list_email_identities. 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.

Value¶

A list with the following syntax:

list(
  EmailIdentities = list(
    list(
      IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN",
      IdentityName = "string",
      SendingEnabled = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_email_identities(
  NextToken = "string",
  PageSize = 123
)