Struct aws_sdk_personalize::operation::update_campaign::builders::UpdateCampaignFluentBuilder

pub struct UpdateCampaignFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateCampaign.

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.

Implementations

impl UpdateCampaignFluentBuilder

pub fn as_input(&self) -> &UpdateCampaignInputBuilder

Access the UpdateCampaign as a reference.

pub async fn send( self ) -> Result<UpdateCampaignOutput, SdkError<UpdateCampaignError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<UpdateCampaignOutput, UpdateCampaignError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn campaign_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the campaign.

pub fn set_campaign_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the campaign.

pub fn get_campaign_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the campaign.

pub fn solution_version_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_solution_version_arn(self, input: Option<String>) -> Self

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.

pub fn get_solution_version_arn(&self) -> &Option<String>

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.

pub fn min_provisioned_tps(self, input: i32) -> Self

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.

pub fn set_min_provisioned_tps(self, input: Option<i32>) -> Self

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.

pub fn get_min_provisioned_tps(&self) -> &Option<i32>

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.

pub fn campaign_config(self, input: CampaignConfig) -> Self

The configuration details of a campaign.

pub fn set_campaign_config(self, input: Option<CampaignConfig>) -> Self

The configuration details of a campaign.

pub fn get_campaign_config(&self) -> &Option<CampaignConfig>

The configuration details of a campaign.

Trait Implementations

impl Clone for UpdateCampaignFluentBuilder

fn clone(&self) -> UpdateCampaignFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateCampaignFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.