Skip to content

API Gateway  >  Operations  >  get_base_path_mapping

get_base_path_mapping

Operation

get_base_path_mapping async 

get_base_path_mapping(input: GetBasePathMappingInput, plugins: list[Plugin] | None = None) -> GetBasePathMappingOutput

Describe a BasePathMapping resource.

Parameters:

Name Type Description Default
input GetBasePathMappingInput

An instance of GetBasePathMappingInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetBasePathMappingOutput

An instance of GetBasePathMappingOutput.

Input

GetBasePathMappingInput dataclass

Request to describe a BasePathMapping resource.

Attributes

base_path class-attribute instance-attribute 
base_path: str | None = None

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 class-attribute instance-attribute 
domain_name: str | None = None

The domain name of the BasePathMapping resource to be described.

domain_name_id class-attribute instance-attribute 
domain_name_id: str | None = None

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

Output

GetBasePathMappingOutput dataclass

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

Attributes

base_path class-attribute instance-attribute 
base_path: str | None = None

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

rest_api_id class-attribute instance-attribute 
rest_api_id: str | None = None

The string identifier of the associated RestApi.

stage class-attribute instance-attribute 
stage: str | None = None

The name of the associated stage.