Table Of Contents


User Guide

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

[ aws . apigateway ]



See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--rest-api-id <value>
[--position <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--rest-api-id (string)

[Required] The string identifier of the associated RestApi .

--position (string)

The current pagination position in the paged result set.

--limit (integer)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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.


position -> (string)

items -> (list)

The current page of elements from this collection.


A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

Documenting an API , DocumentationPart , DocumentationVersions

version -> (string)

The version identifier of the API documentation snapshot.

createdDate -> (timestamp)

The date when the API documentation snapshot is created.

description -> (string)

The description of the API documentation snapshot.