apigateway_get_export

Exports a deployed version of a RestApi in a specified format.
See <a href="https://paws-r.github.io/docs/apigateway/get_export.html">https://paws-r.github.io/docs/apigateway/get_export.html</a> for full documentation.

internal

Interface to 'Amazon Web Services' networking and content
delivery services, including 'Route 53' Domain Name System service,
'CloudFront' content delivery, load balancing, and more
<https://aws.amazon.com/>.

Dyfan Jones

paws.networking

'Amazon Web Services' Networking & Content Delivery Services

David Kretch

Adam Banker

Amazon.com, Inc. 

apigateway_get_export function

<dl><dt>restApiId</dt>
<dd>[required] The string identifier of the associated RestApi.</dd>
<dt>stageName</dt>
<dd>[required] The name of the Stage that will be exported.</dd>
<dt>exportType</dt>
<dd>[required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and
'swagger' for Swagger/OpenAPI 2.0.</dd>
<dt>parameters</dt>
<dd>A key-value map of query string parameters that specify properties of
the export, depending on the requested <code>exportType</code>. For <code>exportType</code>
<code>oas30</code> and <code>swagger</code>, any combination of the following parameters are
supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will
export the API with x-amazon-apigateway-integration extensions.
<code>extensions='authorizers'</code> will export the API with
x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API
with Postman extensions, allowing for import to the Postman tool</dd>
<dt>accepts</dt>
<dd>The content-type of the export, for example <code>application/json</code>.
Currently <code>application/json</code> and <code>application/yaml</code> are supported for
<code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the
<code>Accept</code> header for direct API requests.</dd></dl>

Arguments

Exports a deployed version of a RestApi in a specified format.
See <a href='https://paws-r.github.io/docs/apigateway/get_export.html'>https://paws-r.github.io/docs/apigateway/get_export.html</a> for full documentation.

Exports a deployed version of a RestApi in a specified format — apigateway_get_export

<dl>

<dt>restApiId</dt>
<dd>[required] The string identifier of the associated RestApi.</dd>


<dt>stageName</dt>
<dd>[required] The name of the Stage that will be exported.</dd>


<dt>exportType</dt>
<dd>[required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and
'swagger' for Swagger/OpenAPI 2.0.</dd>


<dt>parameters</dt>
<dd>A key-value map of query string parameters that specify properties of
the export, depending on the requested <code>exportType</code>. For <code>exportType</code>
<code>oas30</code> and <code>swagger</code>, any combination of the following parameters are
supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will
export the API with x-amazon-apigateway-integration extensions.
<code>extensions='authorizers'</code> will export the API with
x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API
with Postman extensions, allowing for import to the Postman tool</dd>


<dt>accepts</dt>
<dd>The content-type of the export, for example <code>application/json</code>.
Currently <code>application/json</code> and <code>application/yaml</code> are supported for
<code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the
<code>Accept</code> header for direct API requests.</dd>

</dl>

apigateway_get_export: Exports a deployed version of a RestApi in a specified format

Description

Usage

Arguments