update_base_path_mapping¶
Operation¶
update_base_path_mapping
¶
update_base_path_mapping(request: UpdateBasePathMappingInput | UpdateBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateBasePathMappingInputDict]) -> UpdateBasePathMappingOutput
Changes information about the BasePathMapping resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateBasePathMappingInput | UpdateBasePathMappingInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateBasePathMappingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateBasePathMappingOutput
|
An instance of |
update_base_path_mapping
async
¶
update_base_path_mapping(request: UpdateBasePathMappingInput | UpdateBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateBasePathMappingInputDict]) -> UpdateBasePathMappingOutput
Changes information about the BasePathMapping resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateBasePathMappingInput | UpdateBasePathMappingInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateBasePathMappingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateBasePathMappingOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateBasePathMappingInputDict
¶
Bases: TypedDict
Dictionary form of UpdateBasePathMappingInput.
Attributes¶
base_path
instance-attribute
¶
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
domain_name
instance-attribute
¶
The domain name of the BasePathMapping resource to change.
domain_name_id
instance-attribute
¶
domain_name_id: str | None
The identifier for the domain name resource. Supported only for private custom domain names.
patch_operations
instance-attribute
¶
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None
For more information about supported patch operations, see Patch Operations.
UpdateBasePathMappingInput
dataclass
¶
Bases: _SerdeShape
A request to change information about the BasePathMapping resource.
Attributes¶
base_path
class-attribute
instance-attribute
¶
base_path: str | None = ...
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
domain_name
class-attribute
instance-attribute
¶
domain_name: str | None = ...
The domain name of the BasePathMapping resource to change.
domain_name_id
class-attribute
instance-attribute
¶
domain_name_id: str | None = ...
The identifier for the domain name resource. Supported only for private custom domain names.
patch_operations
class-attribute
instance-attribute
¶
patch_operations: list[PatchOperation] | None = ...
For more information about supported patch operations, see Patch Operations.
Output¶
UpdateBasePathMappingOutput
dataclass
¶
Bases: _SerdeShape
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 = ...
The base path name that callers of the API must provide as part of the URL after the domain name.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.