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

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

Overview

An object that describes the deployment of a solution version. For more information on campaigns, see [CreateCampaign].

[1]: docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html

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) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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.

[1]: docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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 the solution version the campaign uses.

Returns:

  • (String) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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 &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED

  • DELETE PENDING &gt; DELETE IN_PROGRESS

Returns:

  • (String) 


626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/aws-sdk-personalize/types.rb', line 626

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