describe_campaign ¶

describe_campaign(
    campaign_arn: Arn, *, config_overrides: Optional[PersonalizeClientConfig] = None
) -> DescribeCampaignResponse

Describes the given campaign, including its status.

A campaign can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

Parameters:

campaign_arn (Arn) –

The Amazon Resource Name (ARN) of the campaign.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
ResourceNotFoundException –

Could not find the specified resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_personalize/_services/personalize.py

def describe_campaign(
    self,
    campaign_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_campaign_response.DescribeCampaignResponse":
    """<p>Describes the given campaign, including its status.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the <code>failureReason</code> key, which describes why.</p> <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>

    Args:
        campaign_arn: <p>The Amazon Resource Name (ARN) of the campaign.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_personalize.types.describe_campaign_request.DescribeCampaignRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.describe_campaign_response.DescribeCampaignResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.describe_campaign

        output, http_response = (
            capo_personalize._operations.amazon_personalize.describe_campaign.describe_campaign(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCampaign")
    )
    input_: capo_personalize.types.describe_campaign_request.DescribeCampaignRequest = {
        "campaign_arn": campaign_arn
    }

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