ApiKey

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name	Type	Description
id	string	The identifier of the API key.
value	string	The value of the API key.
name	string	The name of the API key.
customerId	string	An AWS Marketplace customer identifier.
description	string
enabled	boolean	Whether the API key can be used by callers.
createdDate	string
lastUpdatedDate	string
stageKeys	array
tags	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApiKey",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The identifier of the API key."
    },
    "value": {
      "type": "string",
      "description": "The value of the API key."
    },
    "name": {
      "type": "string",
      "description": "The name of the API key."
    },
    "customerId": {
      "type": "string",
      "description": "An AWS Marketplace customer identifier."
    },
    "description": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the API key can be used by callers."
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdatedDate": {
      "type": "string",
      "format": "date-time"
    },
    "stageKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "object"
    }
  }
}