Skip to content

list_capacity_reservations

list_capacity_reservations(
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxCapacityReservationsCount] = None,
) -> ListCapacityReservationsOutput

Lists the capacity reservations for the current account.

Parameters:

  • next_token (Optional[Token], default: None ) –

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

  • max_results (Optional[MaxCapacityReservationsCount], default: None ) –

    Specifies the maximum number of results to return.

Raises:

  • InternalServerException –

    Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException –

    Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • UnknownServiceError –

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

Source code in docs_src/capo_athena/_services/athena.py
def list_capacity_reservations(
    self,
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    next_token: Optional["capo_athena.types.token.Token"] = None,
    max_results: Optional[
        "capo_athena.types.max_capacity_reservations_count.MaxCapacityReservationsCount"
    ] = None,
) -> "capo_athena.types.list_capacity_reservations_output.ListCapacityReservationsOutput":
    """<p>Lists the capacity reservations for the current account.</p>

    Args:
        next_token: <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.</p>
        max_results: <p>Specifies the maximum number of results to return.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.list_capacity_reservations_input.ListCapacityReservationsInput]",
    ) -> OperationResponse[
        "capo_athena.types.list_capacity_reservations_output.ListCapacityReservationsOutput"
    ]:
        import capo_athena._operations.amazon_athena.list_capacity_reservations

        output, http_response = (
            capo_athena._operations.amazon_athena.list_capacity_reservations.list_capacity_reservations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCapacityReservations")
    )
    input_: capo_athena.types.list_capacity_reservations_input.ListCapacityReservationsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output