ImportRestApiRequest

import type { ImportRestApiRequest } from "https://aws-api.deno.dev/v0.4/services/apigateway.ts?docs=full";

A POST request to import an API to API Gateway using an input of an API definition file.

interface ImportRestApiRequest {

body: Uint8Array | string;

failOnWarnings?: boolean | null;

parameters?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

body: Uint8Array | string

[src]

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.

failOnWarnings?: boolean | null

[src]

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.

parameters?: {

[key: string]: string | null | undefined;

} | null

[src]

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: