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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Schedule as input to an Aws::Client method, you can use a vanilla Hash:

{
  end_time: "__string",
  event_filter: {
    dimensions: { # required
      attributes: {
        "__string" => {
          attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
      },
      event_type: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"], # required
      },
      metrics: {
        "__string" => {
          comparison_operator: "__string", # required
          value: 1.0, # required
        },
      },
    },
    filter_type: "SYSTEM", # required, 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", # required
  timezone: "__string",
}

Specifies the schedule settings for a campaign.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ String

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

Returns:

  • (String) —

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

#event_filter ⇒ Types::CampaignEventFilter

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

Returns:

  • (Types::CampaignEventFilter) —

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

#frequency ⇒ String

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

Possible values:

  • ONCE
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • EVENT

Returns:

  • (String) —

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

#is_local_time ⇒ Boolean

Specifies whether the start and end times for the campaign schedule use each recipient\'s local time. To base the schedule on each recipient\'s local time, set this value to true.

Returns:

  • (Boolean) —

    Specifies whether the start and end times for the campaign schedule use each recipient\'s local time.

#quiet_time ⇒ Types::QuietTime

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn\'t send messages to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

  • The current time in the endpoint\'s time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

  • The current time in the endpoint\'s time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn\'t met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

Returns:

#start_time ⇒ String

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

Returns:

  • (String) —

    The scheduled time when the campaign began or will begin.

#timezone ⇒ String

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: 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, and UTC-11.

Returns:

  • (String) —

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.