Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEmailIdentities

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

Request Syntax


POST /v2/email/list-identities HTTP/1.1
Content-type: application/json

{
   "Filter": { 
      "string" : "string" 
   },
   "NextToken": "string",
   "PageSize": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filter

An object that contains filters to apply when listing email identities. You can filter by a substring of the identity name, by identity type, or by verification status.

Type: String to string map

Valid Keys: IDENTITY_NAME_CONTAINS | IDENTITY_TYPE | VERIFICATION_STATUS

Value Length Constraints: Minimum length of 1.

Required: No

NextToken

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

Type: String

Required: No

PageSize

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.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EmailIdentities": [ 
      { 
         "IdentityName": "string",
         "IdentityType": "string",
         "SendingEnabled": boolean,
         "VerificationStatus": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmailIdentities

An array that includes all of the email identities associated with your AWS account.

Type: Array of IdentityInfo objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429