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",
  },
}

Specifies the default settings for an application.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_hook ⇒ Types::CampaignHook

The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the <link linkend=“apps-application-id-campaigns-campaign-id” />

Campaign</link> resource to define custom Lambda function settings for the campaign.

Returns:



17550
17551
17552
17553
17554
17555
17556
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 17550

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

#cloud_watch_metrics_enabled ⇒ Boolean

Specifies whether to enable application-related alarms in Amazon CloudWatch.

Returns:

  • (Boolean) 


17550
17551
17552
17553
17554
17555
17556
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 17550

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

#limits ⇒ Types::CampaignLimits

The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the <link linkend=“apps-application-id-campaigns-campaign-id” />

Campaign</link> resource to define custom limits for the campaign.

Returns:



17550
17551
17552
17553
17554
17555
17556
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 17550

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 campaigns and journeys 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 <link linkend=“apps-application-id-campaigns-campaign-id” />

Campaign</link> resource or the <link linkend=“apps-application-id-journeys-journey-id” />

Journey</link> resource to define a custom quiet time for the campaign or journey.

Returns:



17550
17551
17552
17553
17554
17555
17556
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 17550

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