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

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#additional_treatmentsArray<Types::TreatmentResource>

Returns:

#application_idString

The ID of the application to which the campaign applies.

Returns:

  • (String)

    The ID of the application to which the campaign applies.

#creation_dateString

The date the campaign was created in ISO 8601 format.

Returns:

  • (String)

    The date the campaign was created in ISO 8601 format.

#default_stateTypes::CampaignState

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

Returns:

#descriptionString

A description of the campaign.

Returns:

  • (String)

    A description of the campaign.

#holdout_percentInteger

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

Returns:

  • (Integer)

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

#idString

The unique campaign ID.

Returns:

  • (String)

    The unique campaign ID.

#is_pausedBoolean

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

Returns:

  • (Boolean)

    Indicates whether the campaign is paused.

#last_modified_dateString

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

Returns:

  • (String)

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

#limitsTypes::CampaignLimits

The campaign limits settings.

Returns:

#message_configurationTypes::MessageConfiguration

The message configuration settings.

Returns:

#nameString

The custom name of the campaign.

Returns:

  • (String)

    The custom name of the campaign.

#scheduleTypes::Schedule

The campaign schedule.

Returns:

#segment_idString

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

Returns:

  • (String)

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

#segment_versionInteger

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

Returns:

  • (Integer)

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

#stateTypes::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:

#treatment_descriptionString

A custom description for the treatment.

Returns:

  • (String)

    A custom description for the treatment.

#treatment_nameString

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

Returns:

  • (String)

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

#versionInteger

The campaign version number.

Returns:

  • (Integer)

    The campaign version number.