Athena / Client / list_capacity_reservations

list_capacity_reservations#

Athena.Client.list_capacity_reservations(**kwargs)#

Lists the capacity reservations for the current account.

See also: AWS API Documentation

Request Syntax

response = client.list_capacity_reservations(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

  • MaxResults (integer) – Specifies the maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'CapacityReservations': [
        {
            'Name': 'string',
            'Status': 'PENDING'|'ACTIVE'|'CANCELLING'|'CANCELLED'|'FAILED'|'UPDATE_PENDING',
            'TargetDpus': 123,
            'AllocatedDpus': 123,
            'LastAllocation': {
                'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
                'StatusMessage': 'string',
                'RequestTime': datetime(2015, 1, 1),
                'RequestCompletionTime': datetime(2015, 1, 1)
            },
            'LastSuccessfulAllocationTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    • CapacityReservations (list) –

      The capacity reservations for the current account.

      • (dict) –

        A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

        • Name (string) –

          The name of the capacity reservation.

        • Status (string) –

          The status of the capacity reservation.

        • TargetDpus (integer) –

          The number of data processing units requested.

        • AllocatedDpus (integer) –

          The number of data processing units currently allocated.

        • LastAllocation (dict) –

          Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

          • Status (string) –

            The status of the capacity allocation.

          • StatusMessage (string) –

            The status message of the capacity allocation.

          • RequestTime (datetime) –

            The time when the capacity allocation was requested.

          • RequestCompletionTime (datetime) –

            The time when the capacity allocation request was completed.

        • LastSuccessfulAllocationTime (datetime) –

          The time of the most recent capacity allocation that succeeded.

        • CreationTime (datetime) –

          The time in UTC epoch millis when the capacity reservation was created.

Exceptions

  • Athena.Client.exceptions.InternalServerException

  • Athena.Client.exceptions.InvalidRequestException