ExportApiRequest

import type { ExportApiRequest } from "https://aws-api.deno.dev/v0.3/services/apigatewayv2.ts?docs=full";

interface ExportApiRequest {

ApiId: string;

ExportVersion?: string | null;

IncludeExtensions?: boolean | null;

OutputType: string;

Specification: string;

StageName?: string | null;

}

§Properties

ApiId: string

The API identifier.

ExportVersion?: string | null

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

IncludeExtensions?: boolean | null

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

OutputType: string

The output type of the exported definition file. Valid values are JSON and YAML.

Specification: string

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

StageName?: string | null

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.