UpdateCampaign
Updates a campaign by either deploying a new solution or changing the value of the
campaign's minProvisionedTPS
parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
Note
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 on campaigns, see CreateCampaign.
Request Syntax
{
"campaignArn": "string
",
"campaignConfig": {
"itemExplorationConfig": {
"string
" : "string
"
}
},
"minProvisionedTPS": number
,
"solutionVersionArn": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- campaignArn
-
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: Yes
- campaignConfig
-
The configuration details of a campaign.
Type: CampaignConfig object
Required: No
- minProvisionedTPS
-
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high
minProvisionedTPS
will increase your bill. We recommend starting with 1 forminProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPS
as necessary.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- solutionVersionArn
-
The ARN of a new solution version to deploy.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: No
Response Syntax
{
"campaignArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- campaignArn
-
The same campaign ARN as given in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Errors
- InvalidInputException
-
Provide a valid value for the field or parameter.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in use.
HTTP Status Code: 400
- ResourceNotFoundException
-
Could not find the specified resource.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: