A feature of the API Gateway control service for creating a new API from an external API definition file.
See https://paws-r.github.io/docs/apigateway/import_rest_api.html for full documentation.
apigateway_import_rest_api(failOnWarnings = NULL, parameters = NULL, body)A query parameter to indicate whether to rollback the API creation
(true) or not (false) when a warning is encountered. The default
value is false.
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 parameters as
ignore=documentation.
To configure the endpoint type, set parameters as
endpointConfigurationTypes=EDGE,
endpointConfigurationTypes=REGIONAL, or
endpointConfigurationTypes=PRIVATE. The default endpoint type is
EDGE.
To handle imported basepath, set parameters as basepath=ignore,
basepath=prepend or basepath=split.
For example, the AWS CLI command to exclude documentation from the imported API is:
The AWS CLI command to set the regional endpoint on the imported API is:
[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.