Amazon Pinpoint · JSON Structure

Amazon Pinpoint Set Dimension Structure

Specifies the dimension type and values for a segment dimension.

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

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

Properties

DimensionType Values

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-set-dimension-structure.json",
  "name": "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"
  ]
}