Skip to content

put_configuration_set_tracking_options

put_configuration_set_tracking_options(
    configuration_set_name: ConfigurationSetName,
    *,
    config_overrides: Optional[SESv2ClientConfig] = None,
    custom_redirect_domain: Optional[CustomRedirectDomain] = None,
    https_policy: Optional[HttpsPolicy] = None,
) -> PutConfigurationSetTrackingOptionsResponse

Specify a custom domain to use for open and click tracking elements in email that you send.

Parameters:

Raises:

Source code in docs_src/capo_sesv2/_services/se_sv2.py
def put_configuration_set_tracking_options(
    self,
    configuration_set_name: "capo_sesv2.types.configuration_set_name.ConfigurationSetName",
    *,
    config_overrides: Optional[SESv2ClientConfig] = None,
    custom_redirect_domain: Optional[
        "capo_sesv2.types.custom_redirect_domain.CustomRedirectDomain"
    ] = None,
    https_policy: Optional["capo_sesv2.types.https_policy.HttpsPolicy"] = None,
) -> "capo_sesv2.types.put_configuration_set_tracking_options_response.PutConfigurationSetTrackingOptionsResponse":
    """<p>Specify a custom domain to use for open and click tracking elements in email that you send.</p>

    Args:
        configuration_set_name: <p>The name of the configuration set.</p>
        custom_redirect_domain: <p>The domain to use to track open and click events.</p>

    Raises:
        capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_sesv2.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sesv2.types.put_configuration_set_tracking_options_request.PutConfigurationSetTrackingOptionsRequest]",
    ) -> OperationResponse[
        "capo_sesv2.types.put_configuration_set_tracking_options_response.PutConfigurationSetTrackingOptionsResponse"
    ]:
        import capo_sesv2._operations.simple_email_service_v2.put_configuration_set_tracking_options

        output, http_response = (
            capo_sesv2._operations.simple_email_service_v2.put_configuration_set_tracking_options.put_configuration_set_tracking_options(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutConfigurationSetTrackingOptions")
    )
    input_: capo_sesv2.types.put_configuration_set_tracking_options_request.PutConfigurationSetTrackingOptionsRequest = {
        "configuration_set_name": configuration_set_name
    }
    if custom_redirect_domain is not None:
        input_["custom_redirect_domain"] = custom_redirect_domain
    if https_policy is not None:
        input_["https_policy"] = https_policy

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output