list_portals `async` ¶

list_portals(
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    max_results: Optional[__string] = None,
    next_token: Optional[__string] = None,
) -> ListPortalsResponse

Lists portals.

Parameters:

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.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
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 list_portals(
    self,
    *,
    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.list_portals_response.ListPortalsResponse":
    """<p>Lists portals.</p>

    Args:
        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>

    Raises:
        capo_apigatewayv2.errors.access_denied_exception.AccessDeniedException
        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.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.list_portals_request.ListPortalsRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.list_portals_response.ListPortalsResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.list_portals

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPortals")
    )
    input_: capo_apigatewayv2.types.list_portals_request.ListPortalsRequest = {}
    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

list_portals async ¶

list_portals `async` ¶