PutConfigurationSetSendingOptions - Amazon Pinpoint Email Service

PutConfigurationSetSendingOptions

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

Request Syntax

PUT /v1/email/configuration-sets/ConfigurationSetName/sending HTTP/1.1 Content-type: application/json { "SendingEnabled": boolean }

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to enable or disable email sending for.

Required: Yes

Request Body

The request accepts the following data in JSON format.

SendingEnabled

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

Type: Boolean

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: