Athena / Client / get_capacity_reservation

get_capacity_reservation

Athena.Client.get_capacity_reservation(**kwargs)

Returns information about the capacity reservation with the specified name.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_reservation(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the capacity reservation.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityReservation': {
        '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) –

    • CapacityReservation (dict) –

      The requested capacity reservation structure.

      • 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