PutConfigurationSetTrackingOptions
Specify a custom domain to use for open and click tracking elements in email that you send.
Request Syntax
PUT /v2/email/configuration-sets/ConfigurationSetName/tracking-options HTTP/1.1 Content-type: application/json
{ "CustomRedirectDomain": "string"
}
URI Request Parameters
The request uses the following URI parameters.
ConfigurationSetName (p. 147) The name of the configuration set.
Required: Yes
Request Body
The request accepts the following data in JSON format.
CustomRedirectDomain (p. 147)
The domain to use to track open and click events.
Type: String 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 (p. 281).
BadRequestException
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutDedicatedIpInPool
PutDedicatedIpInPool
Move a dedicated IP address to an existing dedicated IP pool.
Note
The dedicated IP address that you specify must already exist, and must be associated with your AWS account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
Request Syntax
PUT /v2/email/dedicated-ips/IP/pool HTTP/1.1 Content-type: application/json
{ "DestinationPoolName": "string"
}
URI Request Parameters
The request uses the following URI parameters.
IP (p. 149)
The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your AWS account.
Required: Yes
Request Body
The request accepts the following data in JSON format.
DestinationPoolName (p. 149)
The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
Type: String Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 281).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutDedicatedIpWarmupAttributes
PutDedicatedIpWarmupAttributes
Request Syntax
PUT /v2/email/dedicated-ips/IP/warmup HTTP/1.1 Content-type: application/json
{ "WarmupPercentage": number }
URI Request Parameters
The request uses the following URI parameters.
IP (p. 151)
The dedicated IP address that you want to update the warm-up attributes for.
Required: Yes
Request Body
The request accepts the following data in JSON format.
WarmupPercentage (p. 151)
The warm-up percentage that you want to associate with the dedicated IP address.
Type: Integer Required: Yes
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 (p. 281).
BadRequestException
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutDeliverabilityDashboardOption
PutDeliverabilityDashboardOption
Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
Request Syntax
PUT /v2/email/deliverability-dashboard HTTP/1.1 Content-type: application/json
{ "DashboardEnabled": boolean, "SubscribedDomains": [ {
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
DashboardEnabled (p. 153)
Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.
Type: Boolean Required: Yes
SubscribedDomains (p. 153)
An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
Type: Array of DomainDeliverabilityTrackingOption (p. 231) objects
Response Syntax
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 (p. 281).
AlreadyExistsException
The resource specified in your request already exists.
HTTP Status Code: 400 BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also