class Aws::APIGateway::Types::ImportRestApiRequest
A POST request to import an API to API Gateway using an input of an API definition file.
@note When making an API call, you may pass ImportRestApiRequest
data as a hash: { fail_on_warnings: false, parameters: { "String" => "String", }, body: "data", # required }
@!attribute [rw] fail_on_warnings
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`. @return [Boolean]
@!attribute [rw] 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 `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: 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' @return [Hash<String,String>]
@!attribute [rw] body
\[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. @return [String]
Constants
- SENSITIVE