update_base_path_mapping¶
Operation¶
async
¶
update_base_path_mapping(input: UpdateBasePathMappingInput, plugins: list[Plugin] | None = None) -> UpdateBasePathMappingOutput
Changes information about the BasePathMapping resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateBasePathMappingInput
|
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 |
|---|---|
UpdateBasePathMappingOutput
|
An instance of |
Input¶
dataclass
¶
A request to change information about the BasePathMapping resource.
Attributes¶
class-attribute
instance-attribute
¶
base_path: str | None = None
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
class-attribute
instance-attribute
¶
domain_name: str | None = None
The domain name of the BasePathMapping resource to change.
class-attribute
instance-attribute
¶
domain_name_id: str | None = None
The identifier for the domain name resource. Supported only for private custom domain names.
class-attribute
instance-attribute
¶
patch_operations: list[PatchOperation] | None = None
For more information about supported patch operations, see Patch Operations.
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.