Class: Aws::Personalize::Types::CreateCampaignRequest

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::CreateCampaignRequest

Defined in:

gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #campaign_config ⇒ Types::CampaignConfig

  The configuration details of a campaign.

• #min_provisioned_tps ⇒ Integer

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

• #name ⇒ String

  A name for the new campaign.

• #solution_version_arn ⇒ String

  The Amazon Resource Name (ARN) of the trained model to deploy with the campaign.

• #tags ⇒ Array<Types::Tag>

  A list of [tags][1] to apply to the campaign.

Instance Attribute Details

#campaign_config ⇒ Types::CampaignConfig

The configuration details of a campaign.

Returns:

• (Types::CampaignConfig)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1076

class CreateCampaignRequest < Struct.new(
  :name,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#min_provisioned_tps ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1076

class CreateCampaignRequest < Struct.new(
  :name,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1076

class CreateCampaignRequest < Struct.new(
  :name,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arn ⇒ String

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 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.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1076

class CreateCampaignRequest < Struct.new(
  :name,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags to apply to the campaign.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1076

class CreateCampaignRequest < Struct.new(
  :name,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end