Amazon PrivateLink · JSON Structure

Amazon Privatelink Service Detail Structure

ServiceDetail schema from Amazon PrivateLink API

Type: object Properties: 8
NetworkingPrivate ConnectivitySecurityVPCZero TrustEndpoint Services

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

Properties

ServiceName ServiceId ServiceType AvailabilityZones Owner BaseEndpointDnsNames PrivateDnsName AcceptanceRequired

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-privatelink/refs/heads/main/json-structure/amazon-privatelink-service-detail-structure.json",
  "name": "ServiceDetail",
  "description": "ServiceDetail schema from Amazon PrivateLink API",
  "type": "object",
  "properties": {
    "ServiceName": {
      "type": "string",
      "description": "Name of the endpoint service"
    },
    "ServiceId": {
      "type": "string",
      "description": "Unique ID of the endpoint service"
    },
    "ServiceType": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Type of service"
    },
    "AvailabilityZones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Availability zones"
    },
    "Owner": {
      "type": "string",
      "description": "Owner AWS account ID"
    },
    "BaseEndpointDnsNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Base DNS names for the endpoint service"
    },
    "PrivateDnsName": {
      "type": "string",
      "description": "Private DNS name"
    },
    "AcceptanceRequired": {
      "type": "boolean",
      "description": "Whether acceptance is required"
    }
  }
}