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

Class: Aws::Personalize::Types::CampaignSummary

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arnString

The Amazon Resource Name (ARN) of the campaign.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  include Aws::Structure
end

#creation_date_timeTime

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

Returns:

  • (Time)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  include Aws::Structure
end

#failure_reasonString

If a campaign fails, the reason behind the failure.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  include Aws::Structure
end

#last_updated_date_timeTime

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

Returns:

  • (Time)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  include Aws::Structure
end

#nameString

The name of the campaign.

Returns:

  • (String)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  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)


236
237
238
239
240
241
242
243
244
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 236

class CampaignSummary < Struct.new(
  :name,
  :campaign_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  include Aws::Structure
end