Class: Aws::Pinpoint::Types::CampaignResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CampaignResponse
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_treatments ⇒ Array<Types::TreatmentResource>
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
-
#application_id ⇒ String
The unique identifier for the application that the campaign applies to.
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the campaign.
-
#creation_date ⇒ String
The date, in ISO 8601 format, when the campaign was created.
-
#custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration
The delivery configuration settings for sending the campaign through a custom channel.
-
#default_state ⇒ Types::CampaignState
The current status of the campaign's default treatment.
-
#description ⇒ String
The custom description of the campaign.
-
#holdout_percent ⇒ Integer
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
-
#hook ⇒ Types::CampaignHook
The settings for the AWS Lambda function to use as a code hook for the campaign.
-
#id ⇒ String
The unique identifier for the campaign.
-
#is_paused ⇒ Boolean
Specifies whether the campaign is paused.
-
#last_modified_date ⇒ String
The date, in ISO 8601 format, when the campaign was last modified.
-
#limits ⇒ Types::CampaignLimits
The messaging limits for the campaign.
-
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings for the campaign.
-
#name ⇒ String
The name of the campaign.
-
#priority ⇒ Integer
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
-
#schedule ⇒ Types::Schedule
The schedule settings for the campaign.
-
#segment_id ⇒ String
The unique identifier for the segment that's associated with the campaign.
-
#segment_version ⇒ Integer
The version number of the segment that's associated with the campaign.
-
#state ⇒ Types::CampaignState
The current status of the campaign.
-
#tags ⇒ Hash<String,String>
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
-
#template_configuration ⇒ Types::TemplateConfiguration
The message template that’s used for the campaign.
-
#treatment_description ⇒ String
The custom description of the default treatment for the campaign.
-
#treatment_name ⇒ String
The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
-
#version ⇒ Integer
The version number of the campaign.
Instance Attribute Details
#additional_treatments ⇒ Array<Types::TreatmentResource>
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#application_id ⇒ String
The unique identifier for the application that the campaign applies to.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The Amazon Resource Name (ARN) of the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#creation_date ⇒ String
The date, in ISO 8601 format, when the campaign was created.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration
The delivery configuration settings for sending the campaign through a custom channel.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#default_state ⇒ Types::CampaignState
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The custom description of the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#holdout_percent ⇒ Integer
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#hook ⇒ Types::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.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The unique identifier for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#is_paused ⇒ Boolean
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#last_modified_date ⇒ String
The date, in ISO 8601 format, when the campaign was last modified.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#limits ⇒ Types::CampaignLimits
The messaging limits for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ Integer
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#schedule ⇒ Types::Schedule
The schedule settings for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#segment_id ⇒ String
The unique identifier for the segment that's associated with the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#segment_version ⇒ Integer
The version number of the segment that's associated with the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#state ⇒ Types::CampaignState
The current status of the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<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.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#template_configuration ⇒ Types::TemplateConfiguration
The message template that’s used for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#treatment_description ⇒ String
The custom description of the default treatment for the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#treatment_name ⇒ String
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.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |
#version ⇒ Integer
The version number of the campaign.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2343 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, :priority) SENSITIVE = [] include Aws::Structure end |