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

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

Overview

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_delivery_configurationTypes::CustomDeliveryConfiguration

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.



16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier for the treatment.

Returns:

  • (String)


16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#message_configurationTypes::MessageConfiguration

The message configuration settings for the treatment.



16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::Schedule

The schedule settings for the treatment.

Returns:



16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#size_percentInteger

The allocated percentage of users (segment members) that the treatment is sent to.

Returns:

  • (Integer)


16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#stateTypes::CampaignState

The current status of the treatment.



16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#template_configurationTypes::TemplateConfiguration

The message template to use for the treatment.



16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_descriptionString

The custom description of the treatment.

Returns:

  • (String)


16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_nameString

The custom name of the treatment.

Returns:

  • (String)


16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16066

class TreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :id,
  :message_configuration,
  :schedule,
  :size_percent,
  :state,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end