Class: Aws::Pinpoint::Types::WriteApplicationSettingsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::WriteApplicationSettingsRequest
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
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,
session: 1,
},
quiet_time: {
end: "__string",
start: "__string",
},
}
Specifies the default settings for an application.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#campaign_hook ⇒ Types::CampaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application.
-
#cloud_watch_metrics_enabled ⇒ Boolean
Specifies whether to enable application-related alarms in Amazon CloudWatch.
-
#limits ⇒ Types::CampaignLimits
The default sending limits for campaigns in the application.
-
#quiet_time ⇒ Types::QuietTime
The default quiet time for campaigns in the application.
Instance Attribute Details
#campaign_hook ⇒ Types::CampaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the
Campaign resource.
20757 20758 20759 20760 20761 20762 20763 20764 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20757 class WriteApplicationSettingsRequest < Struct.new( :campaign_hook, :cloud_watch_metrics_enabled, :limits, :quiet_time) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_metrics_enabled ⇒ Boolean
Specifies whether to enable application-related alarms in Amazon CloudWatch.
20757 20758 20759 20760 20761 20762 20763 20764 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20757 class WriteApplicationSettingsRequest < Struct.new( :campaign_hook, :cloud_watch_metrics_enabled, :limits, :quiet_time) SENSITIVE = [] include Aws::Structure end |
#limits ⇒ Types::CampaignLimits
The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the
Campaign resource or the
Journey resource, respectively.
20757 20758 20759 20760 20761 20762 20763 20764 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20757 class WriteApplicationSettingsRequest < Struct.new( :campaign_hook, :cloud_watch_metrics_enabled, :limits, :quiet_time) SENSITIVE = [] include Aws::Structure end |
#quiet_time ⇒ Types::QuietTime
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 application (or a campaign or journey that has custom quiet time settings).
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 application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the
Campaign resource or the
Journey resource to define a custom quiet time for the campaign or journey.
20757 20758 20759 20760 20761 20762 20763 20764 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20757 class WriteApplicationSettingsRequest < Struct.new( :campaign_hook, :cloud_watch_metrics_enabled, :limits, :quiet_time) SENSITIVE = [] include Aws::Structure end |