Skip to content

WriteApplicationSettingsRequest

Source code in docs_src/capo_pinpoint/types/write_application_settings_request.py
class WriteApplicationSettingsRequest(TypedDict, closed=True):
    campaign_hook: NotRequired["capo_pinpoint.types.campaign_hook.CampaignHook"]
    """<p>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.</p> <p>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.</p>"""
    cloud_watch_metrics_enabled: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether to enable application-related alarms in Amazon CloudWatch.</p>"""
    event_tagging_enabled: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    limits: NotRequired["capo_pinpoint.types.campaign_limits.CampaignLimits"]
    """<p>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.</p>"""
    quiet_time: NotRequired["capo_pinpoint.types.quiet_time.QuietTime"]
    """<p>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:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>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).</p></li> <li><p>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).</p></li></ul> <p>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.</p> <p>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.</p>"""
    journey_limits: NotRequired[
        "capo_pinpoint.types.application_settings_journey_limits.ApplicationSettingsJourneyLimits"
    ]
    """<p>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.</p>"""

campaign_hook instance-attribute

campaign_hook: NotRequired[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.

cloud_watch_metrics_enabled instance-attribute

cloud_watch_metrics_enabled: NotRequired[__boolean]

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

event_tagging_enabled instance-attribute

event_tagging_enabled: NotRequired[__boolean]

journey_limits instance-attribute

journey_limits: NotRequired[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.

limits instance-attribute

limits: NotRequired[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.

quiet_time instance-attribute

quiet_time: NotRequired[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.