Amazon Managed Grafana · JSON Structure

Amazon Managed Grafana Create Workspace Api Key Response Structure

CreateWorkspaceApiKeyResponse schema from Amazon Managed Grafana API

Type: object Properties: 3 Required: 3
DashboardsMonitoringObservabilityVisualization

CreateWorkspaceApiKeyResponse is a JSON Structure definition published by Amazon Managed Grafana, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

key keyName workspaceId

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-grafana/refs/heads/main/json-structure/amazon-managed-grafana-create-workspace-api-key-response-structure.json",
  "name": "CreateWorkspaceApiKeyResponse",
  "description": "CreateWorkspaceApiKeyResponse schema from Amazon Managed Grafana API",
  "type": "object",
  "properties": {
    "key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApiKeyToken"
        },
        {
          "description": "The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace."
        }
      ]
    },
    "keyName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApiKeyName"
        },
        {
          "description": "The name of the key that was created."
        }
      ]
    },
    "workspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "The ID of the workspace that the key is valid for."
        }
      ]
    }
  },
  "required": [
    "key",
    "keyName",
    "workspaceId"
  ]
}