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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::WriteApplicationSettingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the default settings for an application.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #journey_limits ⇒ Types::ApplicationSettingsJourneyLimits

  The default sending limits for journeys in the application.

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

Campaign</link> resource.

Returns:

• (Types::CampaignHook)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13686

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_metrics_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13686

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#journey_limits ⇒ Types::ApplicationSettingsJourneyLimits

The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

Returns:

• (Types::ApplicationSettingsJourneyLimits)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13686

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time,
  :journey_limits)
  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 <link linkend=“apps-application-id-campaigns-campaign-id” />

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

Journey</link> resource, respectively.

Returns:

• (Types::CampaignLimits)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13686

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time,
  :journey_limits)
  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 <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:

• (Types::QuietTime)

# File 'lib/aws-sdk-pinpoint/types.rb', line 13686

class WriteApplicationSettingsRequest < Struct.new(
  :campaign_hook,
  :cloud_watch_metrics_enabled,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end