Class: Aws::Pinpoint::Types::TreatmentResource

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::TreatmentResource

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Treatment resource

See Also:

• AWS API Documentation

Instance Attribute Summary

• #id ⇒ String

  The unique treatment ID.

• #message_configuration ⇒ Types::MessageConfiguration

  The message configuration settings.

• #schedule ⇒ Types::Schedule

  The campaign schedule.

• #size_percent ⇒ Integer

  The allocated percentage of users for this treatment.

• #state ⇒ Types::CampaignState

  The treatment 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.

Instance Attribute Details

#id ⇒ String

The unique treatment ID.

Returns:

• (String)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings.

Returns:

• (Types::MessageConfiguration)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

The campaign schedule.

Returns:

• (Types::Schedule)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#size_percent ⇒ Integer

The allocated percentage of users for this treatment.

Returns:

• (Integer)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#state ⇒ Types::CampaignState

The treatment status.

Returns:

• (Types::CampaignState)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#treatment_description ⇒ String

A custom description for the treatment.

Returns:

• (String)

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

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  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 9181

class TreatmentResource < Struct.new(
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end