A feature of the API Gateway control service for creating a new API from an external API definition file
A feature of the API Gateway control service for creating a new API from an external API definition file.
apigateway_import_rest_api(failOnWarnings, parameters, body)
failOnWarnings |
A query parameter to indicate whether to rollback the API creation
( |
parameters |
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 To configure the endpoint type, set To handle imported For example, the AWS CLI command to exclude documentation from the imported API is: aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' The AWS CLI command to set the regional endpoint on the imported API is: aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json' |
body |
[required] [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. |
A list with the following syntax:
list(
id = "string",
name = "string",
description = "string",
createdDate = as.POSIXct(
"2015-01-01"
),
version = "string",
warnings = list(
"string"
),
binaryMediaTypes = list(
"string"
),
minimumCompressionSize = 123,
apiKeySource = "HEADER"|"AUTHORIZER",
endpointConfiguration = list(
types = list(
"REGIONAL"|"EDGE"|"PRIVATE"
),
vpcEndpointIds = list(
"string"
)
),
policy = "string",
tags = list(
"string"
),
disableExecuteApiEndpoint = TRUE|FALSE
)svc$import_rest_api(
failOnWarnings = TRUE|FALSE,
parameters = list(
"string"
),
body = raw
)Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.