get_base_path_mapping `async` ¶

get_base_path_mapping(
    domain_name: String,
    base_path: String,
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    domain_name_id: Optional[String] = None,
) -> BasePathMapping

Describe a BasePathMapping resource.

Parameters:

domain_name (String) –

The domain name of the BasePathMapping resource to be described.
domain_name_id (Optional[String], default: None ) –

The identifier for the domain name resource. Supported only for private custom domain names.
base_path (String) –

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 any base path name after the domain name.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_api_gateway/_services/async_api_gateway.py

async def get_base_path_mapping(
    self,
    domain_name: "capo_api_gateway.types.string.String",
    base_path: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    domain_name_id: Optional["capo_api_gateway.types.string.String"] = None,
) -> "capo_api_gateway.types.base_path_mapping.BasePathMapping":
    """<p>Describe a BasePathMapping resource.</p>

    Args:
        domain_name: <p>The domain name of the BasePathMapping resource to be described.</p>
        domain_name_id: <p>The identifier for the domain name resource. Supported only for private custom domain names. </p>
        base_path: <p>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 any base path name after the domain name.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_api_gateway.types.get_base_path_mapping_request.GetBasePathMappingRequest]",
    ) -> AsyncOperationResponse[
        "capo_api_gateway.types.base_path_mapping.BasePathMapping"
    ]:
        import capo_api_gateway._operations.backplane_control_service.get_base_path_mapping

        (
            output,
            http_response,
        ) = await capo_api_gateway._operations.backplane_control_service.get_base_path_mapping.async_get_base_path_mapping(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBasePathMapping")
    )
    input_: capo_api_gateway.types.get_base_path_mapping_request.GetBasePathMappingRequest = {
        "domain_name": domain_name,
        "base_path": base_path,
    }
    if domain_name_id is not None:
        input_["domain_name_id"] = domain_name_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_base_path_mapping async ¶

get_base_path_mapping `async` ¶