Skip to content

update_configuration_set_reputation_metrics_enabled

update_configuration_set_reputation_metrics_enabled(
    configuration_set_name: ConfigurationSetName,
    enabled: Enabled,
    *,
    config_overrides: Optional[SESClientConfig] = None,
) -> None

Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

You can execute this operation no more than once per second.

Parameters:

  • configuration_set_name (ConfigurationSetName) –

    The name of the configuration set to update.

  • enabled (Enabled) –

    Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

Raises:

Examples:

UpdateConfigurationSetReputationMetricsEnabled Set the reputationMetricsEnabled flag for a specific configuration set.

>>> client.update_configuration_set_reputation_metrics_enabled(configuration_set_name='foo', enabled=True)
Source code in docs_src/capo_ses/_services/ses.py
def update_configuration_set_reputation_metrics_enabled(
    self,
    configuration_set_name: "capo_ses.types.configuration_set_name.ConfigurationSetName",
    enabled: "capo_ses.types.enabled.Enabled",
    *,
    config_overrides: Optional[SESClientConfig] = None,
) -> None:
    """<p>Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.</p> <p>You can execute this operation no more than once per second.</p>

    Args:
        configuration_set_name: <p>The name of the configuration set to update.</p>
        enabled: <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.</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.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        UpdateConfigurationSetReputationMetricsEnabled
        Set the reputationMetricsEnabled flag for a specific configuration set.

        >>> client.update_configuration_set_reputation_metrics_enabled(configuration_set_name='foo', enabled=True)
    """

    def _handler(
        req: "OperationRequest[capo_ses.types.update_configuration_set_reputation_metrics_enabled_request.UpdateConfigurationSetReputationMetricsEnabledRequest]",
    ) -> OperationResponse[None]:
        import capo_ses._operations.simple_email_service.update_configuration_set_reputation_metrics_enabled

        output, http_response = (
            capo_ses._operations.simple_email_service.update_configuration_set_reputation_metrics_enabled.update_configuration_set_reputation_metrics_enabled(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateConfigurationSetReputationMetricsEnabled"),
    )
    input_: capo_ses.types.update_configuration_set_reputation_metrics_enabled_request.UpdateConfigurationSetReputationMetricsEnabledRequest = {
        "configuration_set_name": configuration_set_name,
        "enabled": enabled,
    }

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