Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . apigateway ]



A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--rest-api-id <value>
[--mode <value>]
[--fail-on-warnings | --no-fail-on-warnings]
[--parameters <value>]
--body <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--rest-api-id (string)

[Required] The string identifier of the associated RestApi .

--mode (string)

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Possible values:

  • merge
  • overwrite

--fail-on-warnings | --no-fail-on-warnings (boolean)

A query parameter to indicate whether to rollback the API update (true ) or not (false ) when a warning is encountered. The default value is false .

--parameters (map)

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--body (blob)

[Required] The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To overwrite an existing API using a Swagger template


aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'file:///path/to/API_Swagger_template.json'

To merge a Swagger template into an existing API


aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'file:///path/to/API_Swagger_template.json'


id -> (string)

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

name -> (string)

The API's name.

description -> (string)

The API's description.

createdDate -> (timestamp)

The timestamp when the API was created.

version -> (string)

A version identifier for the API.

warnings -> (list)

The warning messages reported when failonwarnings is turned on during API import.


binaryMediaTypes -> (list)

The list of binary media types supported by the RestApi . By default, the RestApi supports only UTF-8-encoded text payloads.


minimumCompressionSize -> (integer)

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

apiKeySource -> (string)

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

endpointConfiguration -> (structure)

The endpoint configuration of this RestApi showing the endpoint types of the API.

types -> (list)

A list of endpoint types of an API ( RestApi ) or its custom domain name ( DomainName ). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .


The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

policy -> (string)

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.