| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Personalize.UpdateCampaign
Description
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 API.
You must wait until the status of the updated campaign is ACTIVE
before asking the campaign for recommendations.
For more information on campaigns, see CreateCampaign.
Synopsis
- data UpdateCampaign = UpdateCampaign' {}
- newUpdateCampaign :: Text -> UpdateCampaign
- updateCampaign_campaignConfig :: Lens' UpdateCampaign (Maybe CampaignConfig)
- updateCampaign_minProvisionedTPS :: Lens' UpdateCampaign (Maybe Natural)
- updateCampaign_solutionVersionArn :: Lens' UpdateCampaign (Maybe Text)
- updateCampaign_campaignArn :: Lens' UpdateCampaign Text
- data UpdateCampaignResponse = UpdateCampaignResponse' {
- campaignArn :: Maybe Text
- httpStatus :: Int
- newUpdateCampaignResponse :: Int -> UpdateCampaignResponse
- updateCampaignResponse_campaignArn :: Lens' UpdateCampaignResponse (Maybe Text)
- updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int
Creating a Request
data UpdateCampaign Source #
See: newUpdateCampaign smart constructor.
Constructors
| UpdateCampaign' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UpdateCampaign |
Create a value of UpdateCampaign with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignConfig:UpdateCampaign', updateCampaign_campaignConfig - The configuration details of a campaign.
$sel:minProvisionedTPS:UpdateCampaign', updateCampaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support.
$sel:solutionVersionArn:UpdateCampaign', updateCampaign_solutionVersionArn - The ARN of a new solution version to deploy.
$sel:campaignArn:UpdateCampaign', updateCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.
Request Lenses
updateCampaign_campaignConfig :: Lens' UpdateCampaign (Maybe CampaignConfig) Source #
The configuration details of a campaign.
updateCampaign_minProvisionedTPS :: Lens' UpdateCampaign (Maybe Natural) Source #
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
updateCampaign_solutionVersionArn :: Lens' UpdateCampaign (Maybe Text) Source #
The ARN of a new solution version to deploy.
updateCampaign_campaignArn :: Lens' UpdateCampaign Text Source #
The Amazon Resource Name (ARN) of the campaign.
Destructuring the Response
data UpdateCampaignResponse Source #
See: newUpdateCampaignResponse smart constructor.
Constructors
| UpdateCampaignResponse' | |
Fields
| |
Instances
newUpdateCampaignResponse Source #
Create a value of UpdateCampaignResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignArn:UpdateCampaign', updateCampaignResponse_campaignArn - The same campaign ARN as given in the request.
$sel:httpStatus:UpdateCampaignResponse', updateCampaignResponse_httpStatus - The response's http status code.
Response Lenses
updateCampaignResponse_campaignArn :: Lens' UpdateCampaignResponse (Maybe Text) Source #
The same campaign ARN as given in the request.
updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int Source #
The response's http status code.