Skip to content

describe_campaign async

describe_campaign(
    id: CampaignId,
    *,
    config_overrides: Optional[AsyncConnectCampaignsV2ClientConfig] = None,
) -> DescribeCampaignResponse

Describes the specific campaign.

Raises:

Source code in docs_src/capo_connectcampaignsv2/_services/async_connect_campaigns_v2.py
async def describe_campaign(
    self,
    id: "capo_connectcampaignsv2.types.campaign_id.CampaignId",
    *,
    config_overrides: Optional[AsyncConnectCampaignsV2ClientConfig] = None,
) -> "capo_connectcampaignsv2.types.describe_campaign_response.DescribeCampaignResponse":
    """Describes the specific campaign.

    Raises:
        capo_connectcampaignsv2.errors.access_denied_exception.AccessDeniedException: You do not have sufficient access to perform this action.
        capo_connectcampaignsv2.errors.internal_server_exception.InternalServerException: Request processing failed because of an error or failure with the service.
        capo_connectcampaignsv2.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource was not found.
        capo_connectcampaignsv2.errors.validation_exception.ValidationException: The input fails to satisfy the constraints specified by an AWS service.
        capo_connectcampaignsv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connectcampaignsv2.types.describe_campaign_request.DescribeCampaignRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcampaignsv2.types.describe_campaign_response.DescribeCampaignResponse"
    ]:
        import capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.describe_campaign

        (
            output,
            http_response,
        ) = await capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.describe_campaign.async_describe_campaign(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_connectcampaignsv2.types.describe_campaign_response.DescribeCampaignResponse",
    ) -> dict[str, Any]:
        import capo_connectcampaignsv2.types.describe_campaign_response

        return capo_connectcampaignsv2.types.describe_campaign_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeCampaign", redact_output=_redact_output),
    )
    input_: capo_connectcampaignsv2.types.describe_campaign_request.DescribeCampaignRequest = {
        "id": id
    }

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