Skip to content

get_domain_deliverability_campaign

get_domain_deliverability_campaign(
    campaign_id: CampaignId, *, config_overrides: Optional[SESv2ClientConfig] = None
) -> GetDomainDeliverabilityCampaignResponse

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.

Parameters:

  • campaign_id (CampaignId) –

    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

Raises:

Source code in docs_src/capo_sesv2/_services/se_sv2.py
def get_domain_deliverability_campaign(
    self,
    campaign_id: "capo_sesv2.types.campaign_id.CampaignId",
    *,
    config_overrides: Optional[SESv2ClientConfig] = None,
) -> "capo_sesv2.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.</p>

    Args:
        campaign_id: <p>The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.</p>

    Raises:
        capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_sesv2.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_sesv2._operations.simple_email_service_v2.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_sesv2.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