create_base_path_mapping¶
Operation¶
create_base_path_mapping
¶
create_base_path_mapping(request: CreateBasePathMappingInput | CreateBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBasePathMappingInputDict]) -> CreateBasePathMappingOutput
Creates a new BasePathMapping resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateBasePathMappingInput | CreateBasePathMappingInputDict | 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[CreateBasePathMappingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateBasePathMappingOutput
|
An instance of |
create_base_path_mapping
async
¶
create_base_path_mapping(request: CreateBasePathMappingInput | CreateBasePathMappingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBasePathMappingInputDict]) -> CreateBasePathMappingOutput
Creates a new BasePathMapping resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateBasePathMappingInput | CreateBasePathMappingInputDict | 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[CreateBasePathMappingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateBasePathMappingOutput
|
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.
CreateBasePathMappingInputDict
¶
Bases: TypedDict
Dictionary form of CreateBasePathMappingInput.
Attributes¶
base_path
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. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
domain_name
instance-attribute
¶
The domain name of the BasePathMapping resource to create.
domain_name_id
instance-attribute
¶
domain_name_id: str | None
The identifier for the domain name resource. Required for private custom domain names.
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
CreateBasePathMappingInput
dataclass
¶
Bases: _SerdeShape
Requests API Gateway to create a new BasePathMapping resource.
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. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
domain_name
class-attribute
instance-attribute
¶
domain_name: str | None = ...
The domain name of the BasePathMapping resource to create.
domain_name_id
class-attribute
instance-attribute
¶
domain_name_id: str | None = ...
The identifier for the domain name resource. Required for private custom domain names.
Output¶
CreateBasePathMappingOutput
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.