Class: Aws::Personalize::Types::Campaign

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::Campaign

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #campaign_arn ⇒ String

  The Amazon Resource Name (ARN) of the campaign.

• #campaign_config ⇒ Types::CampaignConfig

  The configuration details of a campaign.

• #creation_date_time ⇒ Time

  The date and time (in Unix format) that the campaign was created.

• #failure_reason ⇒ String

  If a campaign fails, the reason behind the failure.

• #last_updated_date_time ⇒ Time

  The date and time (in Unix format) that the campaign was last updated.

• #latest_campaign_update ⇒ Types::CampaignUpdateSummary

  Provides a summary of the properties of a campaign update.

• #min_provisioned_tps ⇒ Integer

  Specifies the requested minimum provisioned transactions (recommendations) per second.

• #name ⇒ String

  The name of the campaign.

• #solution_version_arn ⇒ String

  The Amazon Resource Name (ARN) of a specific version of the solution.

• #status ⇒ String

  The status of the campaign.

Instance Attribute Details

#campaign_arn ⇒ String

The Amazon Resource Name (ARN) of the campaign.

Returns:

• (String)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#campaign_config ⇒ Types::CampaignConfig

The configuration details of a campaign.

Returns:

• (Types::CampaignConfig)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ Time

The date and time (in Unix format) that the campaign was created.

Returns:

• (Time)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If a campaign fails, the reason behind the failure.

Returns:

• (String)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ Time

The date and time (in Unix format) that the campaign was last updated.

Returns:

• (Time)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#latest_campaign_update ⇒ Types::CampaignUpdateSummary

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

Returns:

• (Types::CampaignUpdateSummary)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#min_provisioned_tps ⇒ Integer

Specifies the requested minimum provisioned transactions (recommendations) per second.

Returns:

• (Integer)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the campaign.

Returns:

• (String)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arn ⇒ String

The Amazon Resource Name (ARN) of a specific version of the solution.

Returns:

• (String)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the campaign.

A campaign can be in one of the following states:

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

• DELETE PENDING > DELETE IN_PROGRESS

Returns:

• (String)

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

class Campaign < Struct.new(
  :name,
  :campaign_arn,
  :solution_version_arn,
  :min_provisioned_tps,
  :campaign_config,
  :status,
  :failure_reason,
  :creation_date_time,
  :last_updated_date_time,
  :latest_campaign_update)
  SENSITIVE = []
  include Aws::Structure
end