Export Api

apigatewayv2_export_api

R Documentation

Export api

Description

Export api

Usage

apigatewayv2_export_api(ApiId, ExportVersion, IncludeExtensions,
  OutputType, Specification, StageName)

Arguments

ApiId

[required] The API identifier.

ExportVersion

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

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

OutputType

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

Specification

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

StageName

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

Value

A list with the following syntax:

list(
  body = raw
)

Request syntax

svc$export_api(
  ApiId = "string",
  ExportVersion = "string",
  IncludeExtensions = TRUE|FALSE,
  OutputType = "YAML"|"JSON",
  Specification = "OAS30",
  StageName = "string"
)