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

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

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

Overview

Note:

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

{
  end_time: "__string",
  frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
  is_local_time: false,
  quiet_time: {
    end: "__string",
    start: "__string",
  },
  start_time: "__string",
  timezone: "__string",
}

Shcedule that defines when a campaign is run.

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeString

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

Returns:

  • (String)


5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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

#frequencyString

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

Returns:

  • (String)


5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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

#is_local_timeBoolean

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

Returns:

  • (Boolean)


5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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

#quiet_timeTypes::QuietTime

The time during which the campaign sends no messages.

Returns:



5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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

#start_timeString

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

Returns:

  • (String)


5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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

#timezoneString

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)


5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5507

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