Struct aws_sdk_personalize::client::fluent_builders::CreateCampaign

pub struct CreateCampaign { /* private fields */ }

Fluent builder constructing a request to CreateCampaign.

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

Implementations

impl CreateCampaign

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateCampaign, AwsResponseRetryClassifier>, SdkError<CreateCampaignError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateCampaignOutput, SdkError<CreateCampaignError>>

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 name(self, input: impl Into<String>) -> Self

A name for the new campaign. The campaign name must be unique within your account.

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

A name for the new campaign. The campaign name must be unique within your account.

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

The Amazon Resource Name (ARN) of the solution version to deploy.

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

The Amazon Resource Name (ARN) of the solution version to deploy.

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

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

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.

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 tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of tags to apply to the campaign.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to apply to the campaign.

Trait Implementations

impl Clone for CreateCampaign

fn clone(&self) -> CreateCampaign

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCampaign

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

Formats the value using the given formatter.