Amazon Pinpoint · Schema

SetDimension

Specifies the dimension type and values for a segment dimension.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
DimensionType object
Values object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-set-dimension-schema.json Raw ↑
{
  "$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-set-dimension-schema.json",
  "title": "SetDimension",
  "description": "Specifies the dimension type and values for a segment dimension.",
  "type": "object",
  "properties": {
    "DimensionType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DimensionType"
        },
        {
          "description": "The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment."
        }
      ]
    },
    "Values": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOf__string"
        },
        {
          "description": "The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values."
        }
      ]
    }
  },
  "required": [
    "Values"
  ]
}