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

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::CampaignResponse

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.

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.

Returns:

(Array<Types::TreatmentResource>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::CustomDeliveryConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::CampaignState)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::CampaignHook)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::CampaignLimits)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::MessageConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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

Returns:

(Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::Schedule)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::CampaignState)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Types::TemplateConfiguration)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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.

Returns:

(Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2283

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_treatments ⇒ Array<Types::TreatmentResource>

#application_id ⇒ String

#arn ⇒ String

#creation_date ⇒ String

#custom_delivery_configuration ⇒ Types::CustomDeliveryConfiguration

#default_state ⇒ Types::CampaignState

#description ⇒ String

#holdout_percent ⇒ Integer

#hook ⇒ Types::CampaignHook

#id ⇒ String

#is_paused ⇒ Boolean

#last_modified_date ⇒ String

#limits ⇒ Types::CampaignLimits

#message_configuration ⇒ Types::MessageConfiguration

#name ⇒ String

#priority ⇒ Integer

#schedule ⇒ Types::Schedule

#segment_id ⇒ String

#segment_version ⇒ Integer

#state ⇒ Types::CampaignState

#tags ⇒ Hash<String,String>

#template_configuration ⇒ Types::TemplateConfiguration

#treatment_description ⇒ String

#treatment_name ⇒ String

#version ⇒ Integer

#additional_treatments ⇒ `Array<Types::TreatmentResource>`

#application_id ⇒ `String`

#arn ⇒ `String`

#creation_date ⇒ `String`

#custom_delivery_configuration ⇒ `Types::CustomDeliveryConfiguration`

#default_state ⇒ `Types::CampaignState`

#description ⇒ `String`

#holdout_percent ⇒ `Integer`

#hook ⇒ `Types::CampaignHook`

#id ⇒ `String`

#is_paused ⇒ `Boolean`

#last_modified_date ⇒ `String`

#limits ⇒ `Types::CampaignLimits`

#message_configuration ⇒ `Types::MessageConfiguration`

#name ⇒ `String`

#priority ⇒ `Integer`

#schedule ⇒ `Types::Schedule`

#segment_id ⇒ `String`

#segment_version ⇒ `Integer`

#state ⇒ `Types::CampaignState`

#tags ⇒ `Hash<String,String>`

#template_configuration ⇒ `Types::TemplateConfiguration`

#treatment_description ⇒ `String`

#treatment_name ⇒ `String`

#version ⇒ `Integer`