You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Treatment resource

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The unique treatment ID.

Returns:

  • (String)


4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#message_configurationTypes::MessageConfiguration

The message configuration settings.



4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#scheduleTypes::Schedule

The campaign schedule.

Returns:



4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#size_percentInteger

The allocated percentage of users for this treatment.

Returns:

  • (Integer)


4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#stateTypes::CampaignState

The treatment status.



4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#treatment_descriptionString

A custom description for the treatment.

Returns:

  • (String)


4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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

#treatment_nameString

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

Returns:

  • (String)


4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4365

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