ListSuppressedDestinations - Amazon SES API v2

ListSuppressedDestinations

Retrieves a list of email addresses that are on the suppression list for your account.

Request Syntax

GET /v2/email/suppression/addresses?EndDate=EndDate&NextToken=NextToken&PageSize=PageSize&Reason=Reasons&StartDate=StartDate HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EndDate

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.

NextToken

A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

PageSize

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

Reasons

The factors that caused the email address to be added to .

Valid Values: BOUNCE | COMPLAINT

StartDate

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "SuppressedDestinationSummaries": [ { "EmailAddress": "string", "LastUpdateTime": number, "Reason": "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.

NextToken

A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

Type: String

SuppressedDestinationSummaries

A list of summaries, each containing a summary for a suppressed email destination.

Type: Array of SuppressedDestinationSummary objects

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InvalidNextTokenException

The specified request includes an invalid or expired token.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: