1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateCampaignInput {
/// <p>A name for the new campaign. The campaign name must be unique within your account.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
pub solution_version_arn: ::std::option::Option<::std::string::String>,
/// <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>
pub min_provisioned_tps: ::std::option::Option<i32>,
/// <p>The configuration details of a campaign.</p>
pub campaign_config: ::std::option::Option<crate::types::CampaignConfig>,
/// <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>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateCampaignInput {
/// <p>A name for the new campaign. The campaign name must be unique within your account.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
pub fn solution_version_arn(&self) -> ::std::option::Option<&str> {
self.solution_version_arn.as_deref()
}
/// <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>
pub fn min_provisioned_tps(&self) -> ::std::option::Option<i32> {
self.min_provisioned_tps
}
/// <p>The configuration details of a campaign.</p>
pub fn campaign_config(&self) -> ::std::option::Option<&crate::types::CampaignConfig> {
self.campaign_config.as_ref()
}
/// <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>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl CreateCampaignInput {
/// Creates a new builder-style object to manufacture [`CreateCampaignInput`](crate::operation::create_campaign::CreateCampaignInput).
pub fn builder() -> crate::operation::create_campaign::builders::CreateCampaignInputBuilder {
crate::operation::create_campaign::builders::CreateCampaignInputBuilder::default()
}
}
/// A builder for [`CreateCampaignInput`](crate::operation::create_campaign::CreateCampaignInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateCampaignInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) solution_version_arn: ::std::option::Option<::std::string::String>,
pub(crate) min_provisioned_tps: ::std::option::Option<i32>,
pub(crate) campaign_config: ::std::option::Option<crate::types::CampaignConfig>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateCampaignInputBuilder {
/// <p>A name for the new campaign. The campaign name must be unique within your account.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>A name for the new campaign. The campaign name must be unique within your account.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>A name for the new campaign. The campaign name must be unique within your account.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
/// This field is required.
pub fn solution_version_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.solution_version_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
pub fn set_solution_version_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.solution_version_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
pub fn get_solution_version_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.solution_version_arn
}
/// <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>
pub fn min_provisioned_tps(mut self, input: i32) -> Self {
self.min_provisioned_tps = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_min_provisioned_tps(mut self, input: ::std::option::Option<i32>) -> Self {
self.min_provisioned_tps = input;
self
}
/// <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>
pub fn get_min_provisioned_tps(&self) -> &::std::option::Option<i32> {
&self.min_provisioned_tps
}
/// <p>The configuration details of a campaign.</p>
pub fn campaign_config(mut self, input: crate::types::CampaignConfig) -> Self {
self.campaign_config = ::std::option::Option::Some(input);
self
}
/// <p>The configuration details of a campaign.</p>
pub fn set_campaign_config(mut self, input: ::std::option::Option<crate::types::CampaignConfig>) -> Self {
self.campaign_config = input;
self
}
/// <p>The configuration details of a campaign.</p>
pub fn get_campaign_config(&self) -> &::std::option::Option<crate::types::CampaignConfig> {
&self.campaign_config
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <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>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <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>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <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>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateCampaignInput`](crate::operation::create_campaign::CreateCampaignInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_campaign::CreateCampaignInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_campaign::CreateCampaignInput {
name: self.name,
solution_version_arn: self.solution_version_arn,
min_provisioned_tps: self.min_provisioned_tps,
campaign_config: self.campaign_config,
tags: self.tags,
})
}
}