put_deliverability_dashboard_option ¶

def put_deliverability_dashboard_option(
    self,
    dashboard_enabled: "capo_pinpoint_email.types.enabled.Enabled",
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
    subscribed_domains: Optional[
        "capo_pinpoint_email.types.domain_deliverability_tracking_options.DomainDeliverabilityTrackingOptions"
    ] = None,
) -> "capo_pinpoint_email.types.put_deliverability_dashboard_option_response.PutDeliverabilityDashboardOptionResponse":
    """<p>Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>

    Args:
        dashboard_enabled: <p>Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to <code>true</code>.</p>
        subscribed_domains: <p>An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.</p>

    Raises:
        capo_pinpoint_email.errors.already_exists_exception.AlreadyExistsException: <p>The resource specified in your request already exists.</p>
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.limit_exceeded_exception.LimitExceededException: <p>There are too many instances of the specified resource type.</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.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.put_deliverability_dashboard_option_request.PutDeliverabilityDashboardOptionRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.put_deliverability_dashboard_option_response.PutDeliverabilityDashboardOptionResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_deliverability_dashboard_option

        output, http_response = (
            capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_deliverability_dashboard_option.put_deliverability_dashboard_option(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutDeliverabilityDashboardOption")
    )
    input_: capo_pinpoint_email.types.put_deliverability_dashboard_option_request.PutDeliverabilityDashboardOptionRequest = {
        "dashboard_enabled": dashboard_enabled
    }
    if subscribed_domains is not None:
        input_["subscribed_domains"] = subscribed_domains

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