Amazon Managed Prometheus Workspace Description Structure

Represents the properties of a workspace.

Type: object Properties: 7 Required: 4
ContainersMonitoringObservabilityPrometheus

WorkspaceDescription is a JSON Structure definition published by Amazon Managed Service for Prometheus, describing 7 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

workspaceId alias arn status prometheusEndpoint createdAt tags

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-managed-prometheus/refs/heads/main/json-structure/amazon-managed-prometheus-workspace-description-structure.json",
  "name": "WorkspaceDescription",
  "description": "Represents the properties of a workspace.",
  "type": "object",
  "properties": {
    "workspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "Unique string identifying this workspace."
        }
      ]
    },
    "alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceAlias"
        },
        {
          "description": "Alias of this workspace."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of this workspace."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceStatus"
        },
        {
          "description": "The status of this workspace."
        }
      ]
    },
    "prometheusEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Uri"
        },
        {
          "description": "Prometheus endpoint URI."
        }
      ]
    },
    "createdAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time when the workspace was created."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "The tags of this workspace."
        }
      ]
    }
  },
  "required": [
    "workspaceId",
    "arn",
    "status",
    "createdAt"
  ]
}