get_domain_deliverability_campaign ¶

def get_domain_deliverability_campaign(
    self,
    campaign_id: "capo_pinpoint_email.types.campaign_id.CampaignId",
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
) -> "capo_pinpoint_email.types.get_domain_deliverability_campaign_response.GetDomainDeliverabilityCampaignResponse":
    """<p>Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code> operation).</p>

    Args:
        campaign_id: <p>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.</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.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.get_domain_deliverability_campaign_request.GetDomainDeliverabilityCampaignRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.get_domain_deliverability_campaign_response.GetDomainDeliverabilityCampaignResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_domain_deliverability_campaign

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDomainDeliverabilityCampaign")
    )
    input_: capo_pinpoint_email.types.get_domain_deliverability_campaign_request.GetDomainDeliverabilityCampaignRequest = {
        "campaign_id": campaign_id
    }

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