CreateConfigurationSet
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. 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/configuration-sets HTTP/1.1
Content-type: application/json
{
"ConfigurationSetName": "string",
"DeliveryOptions": {
"MaxDeliverySeconds": number,
"SendingPoolName": "string",
"TlsPolicy": "string"
},
"ReputationOptions": {
"LastFreshStart": number,
"ReputationMetricsEnabled": boolean
},
"SendingOptions": {
"SendingEnabled": boolean
},
"SuppressionOptions": {
"SuppressedReasons": [ "string" ]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TrackingOptions": {
"CustomRedirectDomain": "string",
"HttpsPolicy": "string"
},
"VdmOptions": {
"DashboardOptions": {
"EngagementMetrics": "string"
},
"GuardianOptions": {
"OptimizedSharedDelivery": "string"
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ConfigurationSetName
-
The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
Type: String
Required: Yes
- DeliveryOptions
-
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
Type: DeliveryOptions object
Required: No
- ReputationOptions
-
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
Type: ReputationOptions object
Required: No
- SendingOptions
-
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
Type: SendingOptions object
Required: No
- SuppressionOptions
-
An object that contains information about the suppression list preferences for your account.
Type: SuppressionOptions object
Required: No
- Tags
-
An array of objects that define the tags (keys and values) to associate with the configuration set.
Type: Array of Tag objects
Required: No
- TrackingOptions
-
An object that defines the open and click tracking options for emails that you send using the configuration set.
Type: TrackingOptions object
Required: No
- VdmOptions
-
An object that defines the VDM options for emails that you send using the configuration set.
Type: VdmOptions object
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
The resource specified in your request already exists.
HTTP Status Code: 400
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- ConcurrentModificationException
-
The resource is being modified by another operation or thread.
HTTP Status Code: 500
- LimitExceededException
-
There are too many instances of the specified resource type.
HTTP Status Code: 400
- NotFoundException
-
The resource you attempted to access doesn't exist.
HTTP Status Code: 404
- 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:
