Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Parameters:
Raises:
Source code in docs_src/capo_ses/_services/ses.py
| def update_configuration_set_tracking_options(
self,
configuration_set_name: "capo_ses.types.configuration_set_name.ConfigurationSetName",
tracking_options: "capo_ses.types.tracking_options.TrackingOptions",
*,
config_overrides: Optional[SESClientConfig] = None,
) -> "capo_ses.types.update_configuration_set_tracking_options_response.UpdateConfigurationSetTrackingOptionsResponse":
"""<p>Modifies an association between a configuration set and a custom domain for open and click event tracking. </p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Amazon SES Developer Guide</a>.</p>
Args:
configuration_set_name: <p>The name of the configuration set.</p>
Raises:
capo_ses.errors.configuration_set_does_not_exist_exception.ConfigurationSetDoesNotExistException: <p>Indicates that the configuration set does not exist.</p>
capo_ses.errors.invalid_tracking_options_exception.InvalidTrackingOptionsException: <p>Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:</p> <ul> <li> <p>When the tracking domain you specified is not verified in Amazon SES.</p> </li> <li> <p>When the tracking domain you specified is not a valid domain or subdomain.</p> </li> </ul>
capo_ses.errors.tracking_options_does_not_exist_exception.TrackingOptionsDoesNotExistException: <p>Indicates that the TrackingOptions object you specified does not exist.</p>
capo_ses.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ses.types.update_configuration_set_tracking_options_request.UpdateConfigurationSetTrackingOptionsRequest]",
) -> OperationResponse[
"capo_ses.types.update_configuration_set_tracking_options_response.UpdateConfigurationSetTrackingOptionsResponse"
]:
import capo_ses._operations.simple_email_service.update_configuration_set_tracking_options
output, http_response = (
capo_ses._operations.simple_email_service.update_configuration_set_tracking_options.update_configuration_set_tracking_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateConfigurationSetTrackingOptions")
)
input_: capo_ses.types.update_configuration_set_tracking_options_request.UpdateConfigurationSetTrackingOptionsRequest = {
"configuration_set_name": configuration_set_name,
"tracking_options": tracking_options,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|