Class: Aws::Pinpoint::Types::CampaignResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::CampaignResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about the status, configuration, and other settings for a campaign.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #additional_treatments ⇒ Array<Types::TreatmentResource>

  An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

• #application_id ⇒ String

  The unique identifier for the application that the campaign applies to.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the campaign.

• #creation_date ⇒ String

  The date, in ISO 8601 format, when the campaign was created.

• #default_state ⇒ Types::CampaignState

  The current status of the campaign’s default treatment.

• #description ⇒ String

  The custom description of the campaign.

• #holdout_percent ⇒ Integer

  The allocated percentage of users (segment members) who shouldn’t receive messages from the campaign.

• #hook ⇒ Types::CampaignHook

  The settings for the AWS Lambda function to use as a code hook for the campaign.

• #id ⇒ String

  The unique identifier for the campaign.

• #is_paused ⇒ Boolean

  Specifies whether the campaign is paused.

• #last_modified_date ⇒ String

  The date, in ISO 8601 format, when the campaign was last modified.

• #limits ⇒ Types::CampaignLimits

  The messaging limits for the campaign.

• #message_configuration ⇒ Types::MessageConfiguration

  The message configuration settings for the campaign.

• #name ⇒ String

  The name of the campaign.

• #schedule ⇒ Types::Schedule

  The schedule settings for the campaign.

• #segment_id ⇒ String

  The unique identifier for the segment that’s associated with the campaign.

• #segment_version ⇒ Integer

  The version number of the segment that’s associated with the campaign.

• #state ⇒ Types::CampaignState

  The current status of the campaign.

• #tags ⇒ Hash<String,String>

  A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.

• #template_configuration ⇒ Types::TemplateConfiguration

  The message template that’s used for the campaign.

• #treatment_description ⇒ String

  The custom description of a variation of the campaign that’s used for A/B testing.

• #treatment_name ⇒ String

  The custom name of a variation of the campaign that’s used for A/B testing.

• #version ⇒ Integer

  The version number of the campaign.

Instance Attribute Details

#additional_treatments ⇒ Array<Types::TreatmentResource>

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

Returns:

• (Array<Types::TreatmentResource>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#application_id ⇒ String

The unique identifier for the application that the campaign applies to.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#creation_date ⇒ String

The date, in ISO 8601 format, when the campaign was created.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#default_state ⇒ Types::CampaignState

The current status of the campaign’s default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

Returns:

• (Types::CampaignState)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#description ⇒ String

The custom description of the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#holdout_percent ⇒ Integer

The allocated percentage of users (segment members) who shouldn’t receive messages from the campaign.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#hook ⇒ Types::CampaignHook

The settings for the AWS Lambda function to use as a code hook for the campaign.

Returns:

• (Types::CampaignHook)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#is_paused ⇒ Boolean

Specifies whether the campaign is paused. A paused campaign doesn’t run unless you resume it by changing this value to false.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#last_modified_date ⇒ String

The date, in ISO 8601 format, when the campaign was last modified.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#limits ⇒ Types::CampaignLimits

The messaging limits for the campaign.

Returns:

• (Types::CampaignLimits)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings for the campaign.

Returns:

• (Types::MessageConfiguration)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#name ⇒ String

The name of the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

The schedule settings for the campaign.

Returns:

• (Types::Schedule)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#segment_id ⇒ String

The unique identifier for the segment that’s associated with the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#segment_version ⇒ Integer

The version number of the segment that’s associated with the campaign.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#state ⇒ Types::CampaignState

The current status of the campaign.

Returns:

• (Types::CampaignState)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#template_configuration ⇒ Types::TemplateConfiguration

The message template that’s used for the campaign.

Returns:

• (Types::TemplateConfiguration)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#treatment_description ⇒ String

The custom description of a variation of the campaign that’s used for A/B testing.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#treatment_name ⇒ String

The custom name of a variation of the campaign that’s used for A/B testing.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#version ⇒ Integer

The version number of the campaign.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 2624

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :arn,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :hook,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end