Amazon Pinpoint · JSON Structure

Amazon Pinpoint Segment Reference Structure

Specifies the segment identifier and version of a segment.

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

SegmentReference 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

Id Version

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-segment-reference-structure.json",
  "name": "SegmentReference",
  "description": "Specifies the segment identifier and version of a segment.",
  "type": "object",
  "properties": {
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the segment."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The version number of the segment."
        }
      ]
    }
  },
  "required": [
    "Id"
  ]
}