Api Gateway  >  Operations  >  delete_base_path_mapping

delete_base_path_mapping

Operation

delete_base_path_mapping async

delete_base_path_mapping(input: DeleteBasePathMappingInput, plugins: list[Plugin] | None = None) -> DeleteBasePathMappingOutput

Deletes the BasePathMapping resource.

Parameters:

Name	Type	Description	Default
input	DeleteBasePathMappingInput	An instance of DeleteBasePathMappingInput.	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
DeleteBasePathMappingOutput	An instance of DeleteBasePathMappingOutput.

Input

DeleteBasePathMappingInput dataclass

A request to delete the BasePathMapping resource.

Attributes

base_path class-attribute instance-attribute

base_path: str | None = None

The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

domain_name class-attribute instance-attribute

domain_name: str | None = None

The domain name of the BasePathMapping resource to delete.

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

DeleteBasePathMappingOutput dataclass

Dataclass for DeleteBasePathMappingOutput structure.