apigateway_import_rest_api

A feature of the API Gateway control service for creating a new API from an external API definition file.
See <a href="https://www.paws-r-sdk.com/docs/apigateway_import_rest_api/">https://www.paws-r-sdk.com/docs/apigateway_import_rest_api/</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_import_rest_api function

<dl><dt>failOnWarnings</dt>
<dd>A query parameter to indicate whether to rollback the API creation
(<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default
value is <code>false</code>.</dd>
<dt>parameters</dt>
<dd>A key-value map of context-specific query string parameters specifying
the behavior of different API importing operations. The following shows
operation-specific parameters and their supported values.
To exclude DocumentationParts from the import, set <code>parameters</code> as
<code>ignore=documentation</code>.
To configure the endpoint type, set <code>parameters</code> as
<code>endpointConfigurationTypes=EDGE</code>,
<code>endpointConfigurationTypes=REGIONAL</code>, or
<code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is
<code>EDGE</code>.
To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>,
<code>basepath=prepend</code> or <code>basepath=split</code>.</dd>
<dt>body</dt>
<dd>[required] The POST request body containing external API definitions. Currently,
only OpenAPI definition JSON/YAML files are supported. The maximum size
of the API definition file is 6MB.</dd></dl>

Arguments

A feature of the API Gateway control service for creating a new API from an external API definition file.
See <a href='https://www.paws-r-sdk.com/docs/apigateway_import_rest_api/'>https://www.paws-r-sdk.com/docs/apigateway_import_rest_api/</a> for full documentation.

A feature of the API Gateway control service for creating a new API from
an external API definition file — apigateway_import_rest_api

<dl>

<dt>failOnWarnings</dt>
<dd>A query parameter to indicate whether to rollback the API creation
(<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default
value is <code>false</code>.</dd>


<dt>parameters</dt>
<dd>A key-value map of context-specific query string parameters specifying
the behavior of different API importing operations. The following shows
operation-specific parameters and their supported values.
To exclude DocumentationParts from the import, set <code>parameters</code> as
<code>ignore=documentation</code>.
To configure the endpoint type, set <code>parameters</code> as
<code>endpointConfigurationTypes=EDGE</code>,
<code>endpointConfigurationTypes=REGIONAL</code>, or
<code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is
<code>EDGE</code>.
To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>,
<code>basepath=prepend</code> or <code>basepath=split</code>.</dd>


<dt>body</dt>
<dd>[required] The POST request body containing external API definitions. Currently,
only OpenAPI definition JSON/YAML files are supported. The maximum size
of the API definition file is 6MB.</dd>

</dl>

apigateway_import_rest_api: A feature of the API Gateway control service for creating a new API from an external API definition file

Description

Usage

Arguments