Personalize / Client / describe_campaign

describe_campaign#

Personalize.Client.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.

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'
            },
            'enableMetadataWithRecommendations': True|False,
            'syncWithLatestSolutionVersion': True|False
        },
        'status': 'string',
        'failureReason': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1),
        'latestCampaignUpdate': {
            'solutionVersionArn': 'string',
            'minProvisionedTPS': 123,
            'campaignConfig': {
                'itemExplorationConfig': {
                    'string': 'string'
                },
                'enableMetadataWithRecommendations': True|False,
                'syncWithLatestSolutionVersion': True|False
            },
            '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 the solution version the campaign uses.
  - minProvisionedTPS (integer) –
    
    Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
  - 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) –
    - enableMetadataWithRecommendations (boolean) –
      
      Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.
      
      If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
    - syncWithLatestSolutionVersion (boolean) –
      
      Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.
      
      For more information about automatic campaign updates, see Enabling automatic campaign updates.
  - 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) –
      - enableMetadataWithRecommendations (boolean) –
        
        Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.
        
        If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
      - syncWithLatestSolutionVersion (boolean) –
        
        Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.
        
        For more information about automatic campaign updates, see Enabling automatic campaign updates.
    - 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