You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arnString

The Amazon Resource Name (ARN) of the campaign.

Returns:

  • (String)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#creation_date_timeTime

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

Returns:

  • (Time)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#failure_reasonString

If a campaign fails, the reason behind the failure.

Returns:

  • (String)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#last_updated_date_timeTime

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

Returns:

  • (Time)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#latest_campaign_updateTypes::CampaignUpdateSummary

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



187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#min_provisioned_tpsInteger

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

Returns:

  • (Integer)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#nameString

The name of the campaign.

Returns:

  • (String)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#solution_version_arnString

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

Returns:

  • (String)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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

#statusString

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)


187
188
189
190
191
192
193
194
195
196
197
198
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 187

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