Skip to content

put_configuration_set_tracking_options async

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

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

Parameters:

  • configuration_set_name (ConfigurationSetName) –

    The name of the configuration set that you want to add a custom tracking domain to.

  • custom_redirect_domain (Optional[CustomRedirectDomain], default: None ) –

    The domain that you want to use to track open and click events.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/async_pinpoint_email.py
async def put_configuration_set_tracking_options(
    self,
    configuration_set_name: "capo_pinpoint_email.types.configuration_set_name.ConfigurationSetName",
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
    custom_redirect_domain: Optional[
        "capo_pinpoint_email.types.custom_redirect_domain.CustomRedirectDomain"
    ] = None,
) -> "capo_pinpoint_email.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 using Amazon Pinpoint.</p>

    Args:
        configuration_set_name: <p>The name of the configuration set that you want to add a custom tracking domain to.</p>
        custom_redirect_domain: <p>The domain that you want to use to track open and click events.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint_email.types.put_configuration_set_tracking_options_request.PutConfigurationSetTrackingOptionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_email.types.put_configuration_set_tracking_options_response.PutConfigurationSetTrackingOptionsResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_configuration_set_tracking_options

        (
            output,
            http_response,
        ) = await capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_configuration_set_tracking_options.async_put_configuration_set_tracking_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutConfigurationSetTrackingOptions")
    )
    input_: capo_pinpoint_email.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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output