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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_delivery_configuration ⇒ Types::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.

Returns:

#id ⇒ String

The unique identifier for the treatment.

Returns:

  • (String) —

    The unique identifier for the treatment.

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings for the treatment.

Returns:

#schedule ⇒ Types::Schedule

The schedule settings for the treatment.

Returns:

#size_percent ⇒ Integer

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

Returns:

  • (Integer) —

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

#state ⇒ Types::CampaignState

The current status of the treatment.

Returns:

#template_configuration ⇒ Types::TemplateConfiguration

The message template to use for the treatment.

Returns:

#treatment_description ⇒ String

The custom description of the treatment.

Returns:

  • (String) —

    The custom description of the treatment.

#treatment_name ⇒ String

The custom name of the treatment.

Returns:

  • (String) —

    The custom name of the treatment.