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

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

Overview

Provides information about the status, configuration, and other settings for a campaign.

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:



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#application_idString

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

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#arnString

The Amazon Resource Name (ARN) of the campaign.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#creation_dateString

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

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#custom_delivery_configurationTypes::CustomDeliveryConfiguration

The delivery configuration settings for sending the campaign through a custom channel.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#default_stateTypes::CampaignState

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#descriptionString

The custom description of the campaign.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#holdout_percentInteger

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

Returns:

  • (Integer)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#hookTypes::CampaignHook

The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

Returns:



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#idString

The unique identifier for the campaign.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

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


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#last_modified_dateString

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

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#limitsTypes::CampaignLimits

The messaging limits for the campaign.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#message_configurationTypes::MessageConfiguration

The message configuration settings for the campaign.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#nameString

The name of the campaign.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#scheduleTypes::Schedule

The schedule settings for the campaign.

Returns:



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#segment_idString

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

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#segment_versionInteger

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

Returns:

  • (Integer)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#stateTypes::CampaignState

The current status of the campaign.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

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


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#template_configurationTypes::TemplateConfiguration

The message template that’s used for the campaign.



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#treatment_descriptionString

The custom description of the default treatment for the campaign.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#treatment_nameString

The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

Returns:

  • (String)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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

#versionInteger

The version number of the campaign.

Returns:

  • (Integer)


2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2670

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