Module Values.UpdateCampaignRequestSource

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 in SolutionArn/$LATEST format. In the campaignConfig, set syncWithLatestSolutionVersion to true. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign 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.

Sourcetype nonrec t = {
  1. campaignArn : Arn.t;
    (*

    The Amazon Resource Name (ARN) of the campaign.

    *)
  2. solutionVersionArn : Arn.t option;
    (*

    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 SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig. 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.

    *)
  3. minProvisionedTPS : TransactionsPerSecond.t option;
    (*

    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 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

    *)
  4. campaignConfig : CampaignConfig.t option;
    (*

    The configuration details of a campaign.

    *)
}
Sourceval context_ : string
Sourceval make : ?solutionVersionArn:??? -> ?minProvisionedTPS:??? -> ?campaignConfig:??? -> campaignArn:Arn.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of TransactionsPerSecond.t | `String of Arn.t | `Structure of (string * [> `Boolean of Boolean.t | `Map of ([> `Enum of string | `String of ParameterName.t ] * [> `Double of RankingInfluenceWeight.t | `String of ParameterValue.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t