Update Campaign
personalize_update_campaign | R Documentation |
Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration¶
Description¶
Updates a campaign to deploy a retrained solution version with an
existing campaign, change your campaign's minProvisionedTPS
, or modify
your campaign's configuration. For example, you can set
enableMetadataWithRecommendations
to true for an existing campaign.
To update a campaign to start automatically using the latest solution version, specify the following:
-
For the
SolutionVersionArn
parameter, specify the Amazon Resource Name (ARN) of your solution inSolutionArn/$LATEST
format. -
In the
campaignConfig
, setsyncWithLatestSolutionVersion
totrue
.
To update a campaign, the campaign status must be ACTIVE or CREATE
FAILED. Check the campaign status using the describe_campaign
operation.
You can still get recommendations from a campaign while an update is in
progress. The campaign will use the previous solution version and
campaign configuration to generate recommendations until the latest
campaign update status is Active
.
For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
Usage¶
personalize_update_campaign(campaignArn, solutionVersionArn,
minProvisionedTPS, campaignConfig)
Arguments¶
campaignArn |
[required] The Amazon Resource Name (ARN) of the campaign. |
solutionVersionArn |
The Amazon Resource Name (ARN) of a new model to deploy. To
specify the latest solution version of your solution, specify the ARN of
your solution in To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates. |
minProvisionedTPS |
Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support. A
high |
campaignConfig |
The configuration details of a campaign. |
Value¶
A list with the following syntax:
list(
campaignArn = "string"
)
Request syntax¶
svc$update_campaign(
campaignArn = "string",
solutionVersionArn = "string",
minProvisionedTPS = 123,
campaignConfig = list(
itemExplorationConfig = list(
"string"
),
enableMetadataWithRecommendations = TRUE|FALSE,
syncWithLatestSolutionVersion = TRUE|FALSE
)
)