Skip to content

ReimportApiRequest

Source code in docs_src/capo_apigatewayv2/types/reimport_api_request.py 
12
13
14
15
16
17
18
19
20
class ReimportApiRequest(TypedDict, closed=True):
    api_id: "capo_apigatewayv2.types.__string.__string"
    """<p>The API identifier.</p>"""
    basepath: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"""
    body: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>The OpenAPI definition. Supported only for HTTP APIs.</p>"""
    fail_on_warnings: NotRequired["capo_apigatewayv2.types.__boolean.__boolean"]
    """<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>"""

api_id instance-attribute 

api_id: __string

The API identifier.

basepath instance-attribute 

basepath: NotRequired[__string]

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

body instance-attribute 

body: NotRequired[__string]

The OpenAPI definition. Supported only for HTTP APIs.

fail_on_warnings instance-attribute 

fail_on_warnings: NotRequired[__boolean]

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.