aws_sdk_personalize/client/
create_campaign.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateCampaign`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_name):<br>required: **true**<br><p>A name for the new campaign. The campaign name must be unique within your account.</p><br>
7    ///   - [`solution_version_arn(impl Into<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::solution_version_arn) / [`set_solution_version_arn(Option<String>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_solution_version_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your <i>solution</i> in <code>SolutionArn/$LATEST</code> format. You must use this format if you set <code>syncWithLatestSolutionVersion</code> to <code>True</code> in the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html">CampaignConfig</a>.</p> <p>To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.</p> <p>For more information about automatic campaign updates, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>.</p><br>
8    ///   - [`min_provisioned_tps(i32)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::min_provisioned_tps) / [`set_min_provisioned_tps(Option<i32>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_min_provisioned_tps):<br>required: **false**<br><p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high <code>minProvisionedTPS</code> will increase your bill. We recommend starting with 1 for <code>minProvisionedTPS</code> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <code>minProvisionedTPS</code> as necessary.</p><br>
9    ///   - [`campaign_config(CampaignConfig)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::campaign_config) / [`set_campaign_config(Option<CampaignConfig>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_campaign_config):<br>required: **false**<br><p>The configuration details of a campaign.</p><br>
10    ///   - [`tags(Tag)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::set_tags):<br>required: **false**<br><p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the campaign.</p><br>
11    /// - On success, responds with [`CreateCampaignOutput`](crate::operation::create_campaign::CreateCampaignOutput) with field(s):
12    ///   - [`campaign_arn(Option<String>)`](crate::operation::create_campaign::CreateCampaignOutput::campaign_arn): <p>The Amazon Resource Name (ARN) of the campaign.</p>
13    /// - On failure, responds with [`SdkError<CreateCampaignError>`](crate::operation::create_campaign::CreateCampaignError)
14    pub fn create_campaign(&self) -> crate::operation::create_campaign::builders::CreateCampaignFluentBuilder {
15        crate::operation::create_campaign::builders::CreateCampaignFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_personalize/client/create_campaign.rs

aws_sdk_personalize/client/
create_campaign.rs
