Skip to content

get_deliverability_test_report async

get_deliverability_test_report(
    report_id: ReportId,
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
) -> GetDeliverabilityTestReportResponse

Retrieve the results of a predictive inbox placement test.

Parameters:

  • report_id (ReportId) –

    A unique string that identifies the predictive inbox placement test.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/async_pinpoint_email.py
async def get_deliverability_test_report(
    self,
    report_id: "capo_pinpoint_email.types.report_id.ReportId",
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
) -> "capo_pinpoint_email.types.get_deliverability_test_report_response.GetDeliverabilityTestReportResponse":
    """<p>Retrieve the results of a predictive inbox placement test.</p>

    Args:
        report_id: <p>A unique string that identifies the predictive inbox placement test.</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.get_deliverability_test_report_request.GetDeliverabilityTestReportRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_email.types.get_deliverability_test_report_response.GetDeliverabilityTestReportResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_deliverability_test_report

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDeliverabilityTestReport")
    )
    input_: capo_pinpoint_email.types.get_deliverability_test_report_request.GetDeliverabilityTestReportRequest = {
        "report_id": report_id
    }

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