Amazon API Gateway · JSON Structure

V1 Create Deployment Request Structure

CreateDeploymentRequest schema from Amazon API Gateway v1 API

Type: object Properties: 2 Required: 1
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

CreateDeploymentRequest is a JSON Structure definition published by Amazon API Gateway, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

stageName description

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "stageName": {
      "type": "string",
      "description": "Name of the stage to deploy to.",
      "example": "my-resource"
    },
    "description": {
      "type": "string",
      "description": "Description of the deployment.",
      "example": "A description of this resource."
    }
  },
  "required": [
    "stageName"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v1-create-deployment-request-structure.json",
  "name": "CreateDeploymentRequest",
  "description": "CreateDeploymentRequest schema from Amazon API Gateway v1 API"
}