[ aws . apigateway ]
Exports a deployed version of a RestApi in a specified format.
See also: AWS API Documentation
get-export
--rest-api-id <value>
--stage-name <value>
--export-type <value>
[--parameters <value>]
[--accepts <value>]
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--rest-api-id
(string)
The string identifier of the associated RestApi.
--stage-name
(string)
The name of the Stage that will be exported.
--export-type
(string)
The type of export. Acceptable values are ‘oas30’ for OpenAPI 3.0.x and ‘swagger’ for Swagger/OpenAPI 2.0.
--parameters
(map)
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType
. ForexportType
oas30
andswagger
, any combination of the following parameters are supported:extensions='integrations'
orextensions='apigateway'
will export the API with x-amazon-apigateway-integration extensions.extensions='authorizers'
will export the API with x-amazon-apigateway-authorizer extensions.postman
will export the API with Postman extensions, allowing for import to the Postman toolkey -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--accepts
(string)
The content-type of the export, for example
application/json
. Currentlyapplication/json
andapplication/yaml
are supported forexportType
of``oas30`` andswagger
. This should be specified in theAccept
header for direct API requests.
outfile
(string)
Filename where the content will be saved
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get the JSON Swagger template for a stage
Command:
aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json
To get the JSON Swagger template + API Gateway Extentions for a stage
Command:
aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json
To get the JSON Swagger template + Postman Extensions for a stage
Command:
aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json
contentType -> (string)
The content-type header value in the HTTP response. This will correspond to a valid ‘accept’ type in the request.
contentDisposition -> (string)
The content-disposition header value in the HTTP response.
body -> (blob)
The binary blob response to GetExport, which contains the export.