Amazon Pinpoint · JSON Structure

Amazon Pinpoint Application Settings Resource Structure

Provides information about an application, including the default settings for an application.

Type: object Properties: 5 Required: 1
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

ApplicationSettingsResource is a JSON Structure definition published by Amazon Pinpoint, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ApplicationId CampaignHook LastModifiedDate Limits QuietTime

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-application-settings-resource-structure.json",
  "name": "ApplicationSettingsResource",
  "description": "Provides information about an application, including the default settings for an application.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console."
        }
      ]
    },
    "CampaignHook": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignHook"
        },
        {
          "description": "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."
        }
      ]
    },
    "LastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time, in ISO 8601 format, when the application's settings were last modified."
        }
      ]
    },
    "Limits": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CampaignLimits"
        },
        {
          "description": "The default sending limits for campaigns in the application."
        }
      ]
    },
    "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>"
        }
      ]
    }
  },
  "required": [
    "ApplicationId"
  ]
}