Skip to content

GetBasePathMappingRequest

Source code in docs_src/capo_api_gateway/types/get_base_path_mapping_request.py 
11
12
13
14
15
16
17
class GetBasePathMappingRequest(TypedDict, closed=True):
    domain_name: "capo_api_gateway.types.string.String"
    """<p>The domain name of the BasePathMapping resource to be described.</p>"""
    domain_name_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier for the domain name resource. Supported only for private custom domain names. </p>"""
    base_path: "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. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.</p>"""

base_path instance-attribute 

base_path: String

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

domain_name instance-attribute 

domain_name: String

The domain name of the BasePathMapping resource to be described.

domain_name_id instance-attribute 

domain_name_id: NotRequired[String]

The identifier for the domain name resource. Supported only for private custom domain names.