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

ListConfigurationSets

List all of the configuration sets associated with your account in the current region.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Request Syntax


POST /v2/email/list-configuration-sets 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 configuration sets. You can filter by a substring of the configuration set name.

Type: String to string map

Valid Keys: CONFIGURATION_SET_NAME_CONTAINS

Value Length Constraints: Minimum length of 1.

Required: No

NextToken

A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

Type: String

Required: No

PageSize

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

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationSets": [ "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.

ConfigurationSets

An array that contains all of the configuration sets in your Amazon SES account in the current AWS Region.

Type: Array of strings

NextToken

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, 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