Skip to content

get_api_mapping async

get_api_mapping(
    api_mapping_id: __string,
    domain_name: __string,
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
) -> GetApiMappingResponse

Gets an API mapping.

Parameters:

  • api_mapping_id (__string) –

    The API mapping identifier.

  • domain_name (__string) –

    The domain name.

Raises:

  • BadRequestException –

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

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • TooManyRequestsException –

    A limit has been exceeded. See the accompanying error message for details.

  • UnknownServiceError –

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

Source code in docs_src/capo_apigatewayv2/_services/async_api_gateway_v2.py
async def get_api_mapping(
    self,
    api_mapping_id: "capo_apigatewayv2.types.__string.__string",
    domain_name: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
) -> "capo_apigatewayv2.types.get_api_mapping_response.GetApiMappingResponse":
    """<p>Gets an API mapping.</p>

    Args:
        api_mapping_id: <p>The API mapping identifier.</p>
        domain_name: <p>The domain name.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apigatewayv2.types.get_api_mapping_request.GetApiMappingRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.get_api_mapping_response.GetApiMappingResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.get_api_mapping

        (
            output,
            http_response,
        ) = await capo_apigatewayv2._operations.api_gateway_v2.get_api_mapping.async_get_api_mapping(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApiMapping")
    )
    input_: capo_apigatewayv2.types.get_api_mapping_request.GetApiMappingRequest = {
        "api_mapping_id": api_mapping_id,
        "domain_name": domain_name,
    }

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