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>

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

Returns:

  • (Array<Types::TreatmentResource>)

    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

#application_idString

The unique identifier for the application that the campaign applies to.

Returns:

  • (String)

    The unique identifier for the application that the campaign applies to.

#arnString

The Amazon Resource Name (ARN) of the campaign.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the campaign.

#creation_dateString

The date, ISO 8601 format, when the campaign was created.

Returns:

  • (String)

    The date, ISO 8601 format, when the campaign was created.

#default_stateTypes::CampaignState

The current status of the campaign\'s default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

Returns:

#descriptionString

The custom description of the campaign.

Returns:

  • (String)

    The custom description of the campaign.

#holdout_percentInteger

The allocated percentage of users (segment members) who shouldn\'t receive messages from the campaign.

Returns:

  • (Integer)

    The allocated percentage of users (segment members) who shouldn\'t receive messages from the campaign.

#hookTypes::CampaignHook

The settings for the AWS Lambda function to use as a code hook for the campaign.

Returns:

  • (Types::CampaignHook)

    The settings for the AWS Lambda function to use as a code hook for the campaign.

#idString

The unique identifier for the campaign.

Returns:

  • (String)

    The unique identifier for the campaign.

#is_pausedBoolean

Specifies whether the campaign is paused. A paused campaign doesn\'t run unless you resume it by changing this value to false.

Returns:

  • (Boolean)

    Specifies whether the campaign is paused.

#last_modified_dateString

The date, in ISO 8601 format, when the campaign was last modified.

Returns:

  • (String)

    The date, in ISO 8601 format, when the campaign was last modified.

#limitsTypes::CampaignLimits

The messaging limits for the campaign.

Returns:

#message_configurationTypes::MessageConfiguration

The message configuration settings for the campaign.

Returns:

#nameString

The name of the campaign.

Returns:

  • (String)

    The name of the campaign.

#scheduleTypes::Schedule

The schedule settings for the campaign.

Returns:

#segment_idString

The unique identifier for the segment that\'s associated with the campaign.

Returns:

  • (String)

    The unique identifier for the segment that\'s associated with the campaign.

#segment_versionInteger

The version number of the segment that\'s associated with the campaign.

Returns:

  • (Integer)

    The version number of the segment that\'s associated with the campaign.

#stateTypes::CampaignState

The current status of the campaign.

Returns:

#tagsHash<String,String>

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.

#treatment_descriptionString

The custom description of a variation of the campaign that\'s used for A/B testing.

Returns:

  • (String)

    The custom description of a variation of the campaign that\'s used for A/B testing.

#treatment_nameString

The custom name of a variation of the campaign that\'s used for A/B testing.

Returns:

  • (String)

    The custom name of a variation of the campaign that\'s used for A/B testing.

#versionInteger

The version number of the campaign.

Returns:

  • (Integer)

    The version number of the campaign.