get_base_path_mapping¶
Operation¶
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 |
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 |
Input¶
dataclass
¶
Request to describe a BasePathMapping resource.
Attributes¶
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.
class-attribute
instance-attribute
¶
domain_name: str | None = None
The domain name of the BasePathMapping resource to be described.
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¶
dataclass
¶
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Attributes¶
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.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
stage: str | None = None
The name of the associated stage.