Aws apigateway: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 77: Line 77:
==create-deployment==
==create-deployment==


Creates an [[Amazon_API_Gateway_Concepts#Deployment_.28API_Deployment.29|API deployment]] (or [[Amazon_API_Gateway_Concepts#Stage|stage]]).
Creates an [[Amazon_API_Gateway_Concepts#Deployment_.28API_Deployment.29|API deployment]] which is used by a [[Amazon_API_Gateway_Concepts#Stage|stage]].


   aws apigateway create-deployment --rest-api-id <''api-id''> --stage-name <''stage-name''>
   aws apigateway create-deployment --rest-api-id <''api-id''> --stage-name <''stage-name''>

Revision as of 06:50, 2 March 2019

Internal

get-rest-apis

Returns information about existing APIs.

aws apigateway get-rest-apis
{
   "items": [
       {
           "apiKeySource": "HEADER",
           "description": "themyscira",
           "endpointConfiguration": {
               "types": [
                   "EDGE"
               ]
           },
           "version": "1.0",
           "createdDate": 1551007660,
           "id": "anhfchtuhe",
           "name": "themyscira"
       },
       {
           "apiKeySource": "HEADER",
           "description": "Api Documentation",
           "endpointConfiguration": {
               "types": [
                   "EDGE"
               ]
           },
           "version": "1.0",
           "createdDate": 1551394693,
           "id": "kizx5mwn97",
           "name": "blue"
       },
       {
           "apiKeySource": "HEADER",
           "description": "An Ops Service proxy integration",
           "endpointConfiguration": {
               "types": [
                   "REGIONAL"
               ]
           },
           "createdDate": 1550077237,
           "id": "pn8pztlmtc",
           "name": "ops"
       }
   ]
}

import-rest-api

Creates a new API from an external API definition file. The API definition file should be in OpenAPI 2.0 format, optionally carrying Amazon API Gateway extensions. The new API's name will be given by the OpenAPI 2.0 info.title element.

aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json'
aws apigateway  import-rest-api --body 'file:///Users/ovidiu/playground/api-gateway-playground/themyscira/build/swagger.json'

update-rest-api

Patches an existing API.

Also see:

Update an Existing OpenAPI Definition

put-rest-api

aws apigateway put-rest-api --rest-api-id 2yox4tmvlc --mode overwrite --body 'file://./themyscira-2.json'


Also see:

Update an Existing OpenAPI Definition

Deployment Operations

create-deployment

Creates an API deployment which is used by a stage.

 aws apigateway create-deployment --rest-api-id <api-id> --stage-name <stage-name>

update-deployment

aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2