describe_campaign

describe_campaign(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_campaign(
    campaignArn='string'
)
Parameters
campaignArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the campaign.

Return type
dict
Returns
Response Syntax
{
    'campaign': {
        'name': 'string',
        'campaignArn': 'string',
        'solutionVersionArn': 'string',
        'minProvisionedTPS': 123,
        'campaignConfig': {
            'itemExplorationConfig': {
                'string': 'string'
            }
        },
        'status': 'string',
        'failureReason': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1),
        'latestCampaignUpdate': {
            'solutionVersionArn': 'string',
            'minProvisionedTPS': 123,
            'campaignConfig': {
                'itemExplorationConfig': {
                    'string': 'string'
                }
            },
            'status': 'string',
            'failureReason': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --
    • campaign (dict) --

      The properties of the campaign.

      • name (string) --

        The name of the campaign.

      • campaignArn (string) --

        The Amazon Resource Name (ARN) of the campaign.

      • solutionVersionArn (string) --

        The Amazon Resource Name (ARN) of a specific version of the solution.

      • minProvisionedTPS (integer) --

        Specifies the requested minimum provisioned transactions (recommendations) per second.

      • campaignConfig (dict) --

        The configuration details of a campaign.

        • itemExplorationConfig (dict) --

          Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

          • (string) --
            • (string) --
      • status (string) --

        The status of the campaign.

        A campaign can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
        • DELETE PENDING > DELETE IN_PROGRESS
      • failureReason (string) --

        If a campaign fails, the reason behind the failure.

      • creationDateTime (datetime) --

        The date and time (in Unix format) that the campaign was created.

      • lastUpdatedDateTime (datetime) --

        The date and time (in Unix format) that the campaign was last updated.

      • latestCampaignUpdate (dict) --

        Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

        • solutionVersionArn (string) --

          The Amazon Resource Name (ARN) of the deployed solution version.

        • minProvisionedTPS (integer) --

          Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

        • campaignConfig (dict) --

          The configuration details of a campaign.

          • itemExplorationConfig (dict) --

            Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

            • (string) --
              • (string) --
        • status (string) --

          The status of the campaign update.

          A campaign update can be in one of the following states:

          • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
          • DELETE PENDING > DELETE IN_PROGRESS
        • failureReason (string) --

          If a campaign update fails, the reason behind the failure.

        • creationDateTime (datetime) --

          The date and time (in Unix time) that the campaign update was created.

        • lastUpdatedDateTime (datetime) --

          The date and time (in Unix time) that the campaign update was last updated.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException
  • Personalize.Client.exceptions.ResourceNotFoundException