Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

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 /v1/email/configuration-sets/ConfigurationSetName/delivery-options HTTP/1.1 Content-type: application/json { "SendingPoolName": "string", "TlsPolicy": "string" }

URI Request Parameters

The request requires the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to associate with a dedicated IP pool.

Request Body

The request accepts the following data in JSON format.

SendingPoolName

The name of the dedicated IP pool that you want to associate with the configuration set.

Type: String

Required: 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 is Optional, messages can be delivered in plain text if a TLS connection can't be established.

Type: String

Valid Values: REQUIRE | OPTIONAL

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.

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: