Api Gateway  >  Operations  >  get_base_path_mappings

get_base_path_mappings

Operation

get_base_path_mappings async

get_base_path_mappings(input: GetBasePathMappingsInput, plugins: list[Plugin] | None = None) -> GetBasePathMappingsOutput

Represents a collection of BasePathMapping resources.

Parameters:

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

Input

GetBasePathMappingsInput dataclass

A request to get information about a collection of BasePathMapping resources.

Attributes

domain_name class-attribute instance-attribute

domain_name: str | None = None

The domain name of a BasePathMapping resource.

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.

limit class-attribute instance-attribute

limit: int | None = None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position class-attribute instance-attribute

position: str | None = None

The current pagination position in the paged result set.

Output

GetBasePathMappingsOutput dataclass

Represents a collection of BasePathMapping resources.

Attributes

items class-attribute instance-attribute

items: list[BasePathMapping] | None = None

The current page of elements from this collection.

position class-attribute instance-attribute

position: str | None = None

The current pagination position in the paged result set.