PUT

/v1/email/configuration-sets/{ConfigurationSetName}/delivery-options

http://email.{region}.amazonaws.com/v1/email/configuration-sets/{ConfigurationSetName}/delivery-options

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.

Access Token Required: API Key

Path Parameters

ConfigurationSetNamestringrequired

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

Body Params

TlsPolicystring

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only delivered if a TLS connection can be established. If the value is <code>Optional</code>, messages can be delivered in plain text if a TLS connection can't be established.

SendingPoolNamestring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v1/email/configuration-sets/{ConfigurationSetName}/delivery-options' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT