get_route_responses `async` ¶

get_route_responses(
    api_id: __string,
    route_id: __string,
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    max_results: Optional[__string] = None,
    next_token: Optional[__string] = None,
) -> GetRouteResponsesResponse

Gets the RouteResponses for a Route.

Parameters:

api_id (__string) –

The API identifier.
max_results (Optional[__string], default: None ) –

The maximum number of elements to be returned for this resource.
next_token (Optional[__string], default: None ) –

The next page of elements from this collection. Not valid for the last element of the collection.
route_id (__string) –

The route ID.

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_route_responses(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    route_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    max_results: Optional["capo_apigatewayv2.types.__string.__string"] = None,
    next_token: Optional["capo_apigatewayv2.types.__string.__string"] = None,
) -> (
    "capo_apigatewayv2.types.get_route_responses_response.GetRouteResponsesResponse"
):
    """<p>Gets the RouteResponses for a Route.</p>

    Args:
        api_id: <p>The API identifier.</p>
        max_results: <p>The maximum number of elements to be returned for this resource.</p>
        next_token: <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
        route_id: <p>The route ID.</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_route_responses_request.GetRouteResponsesRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.get_route_responses_response.GetRouteResponsesResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.get_route_responses

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRouteResponses")
    )
    input_: capo_apigatewayv2.types.get_route_responses_request.GetRouteResponsesRequest = {
        "api_id": api_id,
        "route_id": route_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

get_route_responses async ¶

get_route_responses `async` ¶