describe_campaign(**kwargs)¶Describes the given campaign, including its status.
A campaign can be in one of the following states:
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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign.
{
'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
The properties of the campaign.
The name of the campaign.
The Amazon Resource Name (ARN) of the campaign.
The Amazon Resource Name (ARN) of a specific version of the solution.
Specifies the requested minimum provisioned transactions (recommendations) per second.
The configuration details of a campaign.
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.
The status of the campaign.
A campaign can be in one of the following states:
If a campaign fails, the reason behind the failure.
The date and time (in Unix format) that the campaign was created.
The date and time (in Unix format) that the campaign was last updated.
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
The Amazon Resource Name (ARN) of the deployed solution version.
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
The configuration details of a campaign.
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.
The status of the campaign update.
A campaign update can be in one of the following states:
If a campaign update fails, the reason behind the failure.
The date and time (in Unix time) that the campaign update was created.
The date and time (in Unix time) that the campaign update was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundException