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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Campaign definition

Instance Attribute Summary

• #additional_treatments ⇒ Array<Types::TreatmentResource>

  Treatments that are defined in addition to the default treatment.

• #application_id ⇒ String

  The ID of the application to which the campaign applies.

• #creation_date ⇒ String

  The date the campaign was created in ISO 8601 format.

• #default_state ⇒ Types::CampaignState

  The status of the campaign’s default treatment.

• #description ⇒ String

  A description of the campaign.

• #holdout_percent ⇒ Integer

  The allocated percentage of end users who will not receive messages from this campaign.

• #id ⇒ String

  The unique campaign ID.

• #is_paused ⇒ Boolean

  Indicates whether the campaign is paused.

• #last_modified_date ⇒ String

  The date the campaign was last updated in ISO 8601 format.

• #limits ⇒ Types::CampaignLimits

  The campaign limits settings.

• #message_configuration ⇒ Types::MessageConfiguration

  The message configuration settings.

• #name ⇒ String

  The custom name of the campaign.

• #schedule ⇒ Types::Schedule

  The campaign schedule.

• #segment_id ⇒ String

  The ID of the segment to which the campaign sends messages.

• #segment_version ⇒ Integer

  The version of the segment to which the campaign sends messages.

• #state ⇒ Types::CampaignState

  The campaign status.

• #treatment_description ⇒ String

  A custom description for the treatment.

• #treatment_name ⇒ String

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

• #version ⇒ Integer

  The campaign version number.

Instance Attribute Details

#additional_treatments ⇒ Array<Types::TreatmentResource>

Treatments that are defined in addition to the default treatment.

Returns:

• (Array<Types::TreatmentResource>)

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

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

#application_id ⇒ String

The ID of the application to which the campaign applies.

Returns:

• (String)

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

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

#creation_date ⇒ String

The date the campaign was created in ISO 8601 format.

Returns:

• (String)

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

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

#default_state ⇒ Types::CampaignState

The status of the campaign’s default treatment. Only present for A/B test campaigns.

Returns:

• (Types::CampaignState)

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

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

#description ⇒ String

A description of the campaign.

Returns:

• (String)

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

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

#holdout_percent ⇒ Integer

The allocated percentage of end users who will not receive messages from this campaign.

Returns:

• (Integer)

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

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

#id ⇒ String

The unique campaign ID.

Returns:

• (String)

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

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

#is_paused ⇒ Boolean

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

Returns:

• (Boolean)

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

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

#last_modified_date ⇒ String

The date the campaign was last updated in ISO 8601 format.

Returns:

• (String)

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

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

#limits ⇒ Types::CampaignLimits

The campaign limits settings.

Returns:

• (Types::CampaignLimits)

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

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

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings.

Returns:

• (Types::MessageConfiguration)

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

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

#name ⇒ String

The custom name of the campaign.

Returns:

• (String)

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

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

#schedule ⇒ Types::Schedule

The campaign schedule.

Returns:

• (Types::Schedule)

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

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

#segment_id ⇒ String

The ID of the segment to which the campaign sends messages.

Returns:

• (String)

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

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

#segment_version ⇒ Integer

The version of the segment to which the campaign sends messages.

Returns:

• (Integer)

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

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

#state ⇒ Types::CampaignState

The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.

Returns:

• (Types::CampaignState)

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

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

#treatment_description ⇒ String

A custom description for the treatment.

Returns:

• (String)

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

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

#treatment_name ⇒ String

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

Returns:

• (String)

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

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

#version ⇒ Integer

The campaign version number.

Returns:

• (Integer)

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

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