Amazon Pinpoint · JSON Structure

Amazon Pinpoint Endpoint Location Structure

Specifies geographic information about an endpoint.

Type: object Properties: 6
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

EndpointLocation is a JSON Structure definition published by Amazon Pinpoint, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

City Country Latitude Longitude PostalCode Region

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-endpoint-location-structure.json",
  "name": "EndpointLocation",
  "description": "Specifies geographic information about an endpoint.",
  "type": "object",
  "properties": {
    "City": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the city where the endpoint is located."
        }
      ]
    },
    "Country": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States."
        }
      ]
    },
    "Latitude": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__double"
        },
        {
          "description": "The latitude coordinate of the endpoint location, rounded to one decimal place."
        }
      ]
    },
    "Longitude": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__double"
        },
        {
          "description": "The longitude coordinate of the endpoint location, rounded to one decimal place."
        }
      ]
    },
    "PostalCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The postal or ZIP code for the area where the endpoint is located."
        }
      ]
    },
    "Region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state."
        }
      ]
    }
  }
}