Amazon Pinpoint · Schema
WriteApplicationSettingsRequest
Specifies the default settings for an application.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| CampaignHook | object | |
| CloudWatchMetricsEnabled | object | |
| EventTaggingEnabled | object | |
| Limits | object | |
| QuietTime | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-write-application-settings-request-schema.json",
"title": "WriteApplicationSettingsRequest",
"description": "Specifies the default settings for an application.",
"type": "object",
"properties": {
"CampaignHook": {
"allOf": [
{
"$ref": "#/components/schemas/CampaignHook"
},
{
"description": "<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>"
}
]
},
"CloudWatchMetricsEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "Specifies whether to enable application-related alarms in Amazon CloudWatch."
}
]
},
"EventTaggingEnabled": {
"$ref": "#/components/schemas/__boolean"
},
"Limits": {
"allOf": [
{
"$ref": "#/components/schemas/CampaignLimits"
},
{
"description": "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."
}
]
},
"QuietTime": {
"allOf": [
{
"$ref": "#/components/schemas/QuietTime"
},
{
"description": "<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>"
}
]
}
}
}