create_configuration_set_tracking_options `async` ¶

create_configuration_set_tracking_options(
    configuration_set_name: ConfigurationSetName,
    tracking_options: TrackingOptions,
    *,
    config_overrides: Optional[AsyncSESClientConfig] = None,
) -> CreateConfigurationSetTrackingOptionsResponse

Creates 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:

configuration_set_name (ConfigurationSetName) –

The name of the configuration set that the tracking options should be associated with.

Raises:

ConfigurationSetDoesNotExistException –

Indicates that the configuration set does not exist.
InvalidTrackingOptionsException –
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:
- When the tracking domain you specified is not verified in Amazon SES.
- When the tracking domain you specified is not a valid domain or subdomain.
TrackingOptionsAlreadyExistsException –

Indicates that the configuration set you specified already contains a TrackingOptions object.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ses/_services/async_ses.py

async def create_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[AsyncSESClientConfig] = None,
) -> "capo_ses.types.create_configuration_set_tracking_options_response.CreateConfigurationSetTrackingOptionsResponse":
    """<p>Creates 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 that the tracking options should be associated with.</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_already_exists_exception.TrackingOptionsAlreadyExistsException: <p>Indicates that the configuration set you specified already contains a TrackingOptions object.</p>
        capo_ses.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ses.types.create_configuration_set_tracking_options_request.CreateConfigurationSetTrackingOptionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ses.types.create_configuration_set_tracking_options_response.CreateConfigurationSetTrackingOptionsResponse"
    ]:
        import capo_ses._operations.simple_email_service.create_configuration_set_tracking_options

        (
            output,
            http_response,
        ) = await capo_ses._operations.simple_email_service.create_configuration_set_tracking_options.async_create_configuration_set_tracking_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateConfigurationSetTrackingOptions")
    )
    input_: capo_ses.types.create_configuration_set_tracking_options_request.CreateConfigurationSetTrackingOptionsRequest = {
        "configuration_set_name": configuration_set_name,
        "tracking_options": tracking_options,
    }

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

create_configuration_set_tracking_options async ¶

create_configuration_set_tracking_options `async` ¶