Skip to content

get_deliverability_dashboard_options

get_deliverability_dashboard_options(
    *, config_overrides: Optional[PinpointEmailClientConfig] = None
) -> GetDeliverabilityDashboardOptionsResponse

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, 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.

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 Amazon Pinpoint Pricing.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
def get_deliverability_dashboard_options(
    self, *, config_overrides: Optional[PinpointEmailClientConfig] = None
) -> "capo_pinpoint_email.types.get_deliverability_dashboard_options_response.GetDeliverabilityDashboardOptionsResponse":
    """<p>Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, 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>

    Raises:
        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.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.get_deliverability_dashboard_options_request.GetDeliverabilityDashboardOptionsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.get_deliverability_dashboard_options_response.GetDeliverabilityDashboardOptionsResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_deliverability_dashboard_options

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDeliverabilityDashboardOptions")
    )
    input_: capo_pinpoint_email.types.get_deliverability_dashboard_options_request.GetDeliverabilityDashboardOptionsRequest = {}

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