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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arn ⇒ String

The Amazon Resource Name (ARN) of the campaign.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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

#creation_date_time ⇒ Time

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

Returns:

  • (Time) 


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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

#failure_reason ⇒ String

If a campaign fails, the reason behind the failure.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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

#last_updated_date_time ⇒ Time

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

Returns:

  • (Time) 


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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

#name ⇒ String

The name of the campaign.

Returns:

  • (String) 


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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


738
739
740
741
742
743
744
745
746
747
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 738

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