Class: Aws::Pinpoint::Types::Schedule

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

Overview

Note:

When making an API call, you may pass Schedule data as a hash:

{
  end_time: "__string",
  event_filter: {
    dimensions: {
      attributes: {
        "__string" => {
          attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"],
        },
      },
      event_type: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      metrics: {
        "__string" => {
          comparison_operator: "__string",
          value: 1.0,
        },
      },
    },
    filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
  },
  frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
  is_local_time: false,
  quiet_time: {
    end: "__string",
    start: "__string",
  },
  start_time: "__string",
  timezone: "__string",
}

Shcedule that defines when a campaign is run.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ String

The scheduled time that the campaign ends in ISO 8601 format.

Returns:

  • (String) 


7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#event_filter ⇒ Types::CampaignEventFilter

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.

Returns:



7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#frequency ⇒ String

How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Returns:

  • (String) 


7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#is_local_time ⇒ Boolean

Indicates whether the campaign schedule takes effect according to each user’s local time.

Returns:

  • (Boolean) 


7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#quiet_time ⇒ Types::QuietTime

The default quiet time for the campaign. The campaign doesn’t send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don’t include this attribute, they’ll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn’t send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint’s time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint’s time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.

Returns:



7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#start_time ⇒ String

The scheduled time that the campaign begins in ISO 8601 format.

Returns:

  • (String) 


7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end

#timezone ⇒ String

The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11

Returns:

  • (String) 


7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7715

class Schedule < Struct.new(
  :end_time,
  :event_filter,
  :frequency,
  :is_local_time,
  :quiet_time,
  :start_time,
  :timezone)
  include Aws::Structure
end