PutConfigurationSetDeliveryOptions
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
Request Syntax
PUT /v2/email/configuration-sets/ConfigurationSetName/delivery-options HTTP/1.1
Content-type: application/json
{
"MaxDeliverySeconds": number,
"SendingPoolName": "string",
"SharedPoolDeliveryMode": "string",
"TlsPolicy": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- ConfigurationSetName
-
The name of the configuration set to associate with a dedicated IP pool.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- MaxDeliverySeconds
-
The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes).
Type: Long
Valid Range: Minimum value of 300. Maximum value of 50400.
Required: No
- SendingPoolName
-
The name of the dedicated IP pool to associate with the configuration set.
Type: String
Required: No
-
The shared pool delivery mode for email that you send with the configuration set from shared IP addresses. This setting overrides the shared pool delivery mode of your account. Can be one of the following:
-
GLOBAL– Amazon SES delivers from your sending Region first and, when it improves your deliverability, also uses Amazon SES shared IP addresses with established sending history in other AWS Regions within the same AWS partition. -
REGIONAL– Amazon SES delivers your email only from shared IP addresses in your sending Region. -
ACCOUNT– The configuration set uses the shared pool delivery mode of your account.
If you don't specify a value, the current value doesn't change.
Type: String
Valid Values:
GLOBAL | REGIONAL | ACCOUNTRequired: No
-
- TlsPolicy
-
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is
REQUIRE, messages are only delivered if a TLS connection can be established. If the value isOPTIONAL, messages can be delivered in plain text if a TLS connection can't be established.Type: String
Valid Values:
REQUIRE | OPTIONALRequired: 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 Error Types.
- BadRequestException
-
The input you provided is invalid.
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: