[ aws . personalize ]

describe-campaign

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-campaign
--campaign-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--campaign-arn (string)

The Amazon Resource Name (ARN) of the campaign.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

campaign -> (structure)

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 -> (structure)

The configuration details of a campaign.

itemExplorationConfig -> (map)

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.

key -> (string)

value -> (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 -> (timestamp)

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

lastUpdatedDateTime -> (timestamp)

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

latestCampaignUpdate -> (structure)

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 -> (structure)

The configuration details of a campaign.

itemExplorationConfig -> (map)

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.

key -> (string)

value -> (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 -> (timestamp)

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

lastUpdatedDateTime -> (timestamp)

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