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

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

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

Overview

Campaign definition

Instance Attribute Summary collapse

Instance Attribute Details

#additional_treatmentsArray<Types::TreatmentResource>

Treatments that are defined in addition to the default treatment.

Returns:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#application_idString

The ID of the application to which the campaign applies.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#creation_dateString

The date the campaign was created in ISO 8601 format.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#default_stateTypes::CampaignState

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



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#descriptionString

A description of the campaign.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#holdout_percentInteger

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

Returns:

  • (Integer)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#idString

The unique campaign ID.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#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)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#last_modified_dateString

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

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#limitsTypes::CampaignLimits

The campaign limits settings.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#message_configurationTypes::MessageConfiguration

The message configuration settings.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#nameString

The custom name of the campaign.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#scheduleTypes::Schedule

The campaign schedule.

Returns:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#segment_idString

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

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#segment_versionInteger

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

Returns:

  • (Integer)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#treatment_descriptionString

A custom description for the treatment.

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#treatment_nameString

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

Returns:

  • (String)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end

#versionInteger

The campaign version number.

Returns:

  • (Integer)


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 661

class CampaignResponse < Struct.new(
  :additional_treatments,
  :application_id,
  :creation_date,
  :default_state,
  :description,
  :holdout_percent,
  :id,
  :is_paused,
  :last_modified_date,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :state,
  :treatment_description,
  :treatment_name,
  :version)
  include Aws::Structure
end