Class: Aws::Pinpoint::Types::WriteApplicationSettingsRequest

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 WriteApplicationSettingsRequest data as a hash:

{
  campaign_hook: {
    lambda_function_name: "__string",
    mode: "DELIVERY", # accepts DELIVERY, FILTER
    web_url: "__string",
  },
  cloud_watch_metrics_enabled: false,
  limits: {
    daily: 1,
    maximum_duration: 1,
    messages_per_second: 1,
    total: 1,
  },
  quiet_time: {
    end: "__string",
    start: "__string",
  },
}

Creating application setting request

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_hook ⇒ Types::CampaignHook

Default campaign hook information.

Returns:



10482
10483
10484
10485
10486
10487
10488
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10482

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#cloud_watch_metrics_enabled ⇒ Boolean

The CloudWatchMetrics settings for the app.

Returns:

  • (Boolean) 


10482
10483
10484
10485
10486
10487
10488
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10482

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#limits ⇒ Types::CampaignLimits

The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.

Returns:



10482
10483
10484
10485
10486
10487
10488
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10482

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#quiet_time ⇒ Types::QuietTime

The default quiet time for the app. Campaigns in the app don’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 app. 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 an app to use quiet time, campaigns in that app don’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 app (or campaign, if applicable). - 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 app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

Returns:



10482
10483
10484
10485
10486
10487
10488
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10482

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time)
  include Aws::Structure
end