Skip to content

BasePathMapping

Source code in docs_src/capo_api_gateway/types/base_path_mapping.py
class BasePathMapping(TypedDict, closed=True):
    base_path: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>"""
    rest_api_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The string identifier of the associated RestApi.</p>"""
    stage: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of the associated stage.</p>"""

base_path instance-attribute

base_path: NotRequired[String]

The base path name that callers of the API must provide as part of the URL after the domain name.

rest_api_id instance-attribute

rest_api_id: NotRequired[String]

The string identifier of the associated RestApi.

stage instance-attribute

stage: NotRequired[String]

The name of the associated stage.