Skip to content

ExportApiRequest

Source code in docs_src/capo_apigatewayv2/types/export_api_request.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class ExportApiRequest(TypedDict, closed=True):
    api_id: "capo_apigatewayv2.types.__string.__string"
    """<p>The API identifier.</p>"""
    export_version: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p>"""
    include_extensions: NotRequired["capo_apigatewayv2.types.__boolean.__boolean"]
    """<p>Specifies whether to include <a href="https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p>"""
    output_type: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>The output type of the exported definition file. Valid values are JSON and YAML.</p>"""
    specification: "capo_apigatewayv2.types.__string.__string"
    """<p>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</p>"""
    stage_name: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p>"""

api_id instance-attribute 

api_id: __string

The API identifier.

export_version instance-attribute 

export_version: NotRequired[__string]

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

include_extensions instance-attribute 

include_extensions: NotRequired[__boolean]

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

output_type instance-attribute 

output_type: NotRequired[__string]

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

specification instance-attribute 

specification: __string

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

stage_name instance-attribute 

stage_name: NotRequired[__string]

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