EC2 / Client / get_capacity_reservation_usage

get_capacity_reservation_usage#

EC2.Client.get_capacity_reservation_usage(**kwargs)#

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner’s usage.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_reservation_usage(
    CapacityReservationId='string',
    NextToken='string',
    MaxResults=123,
    DryRun=True|False
)
Parameters:

  • CapacityReservationId (string) –

    [REQUIRED]

    The ID of the Capacity Reservation.

  • NextToken (string) – The token to use to retrieve the next page of results.

  • MaxResults (integer) –

    The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

    Valid range: Minimum value of 1. Maximum value of 1000.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'CapacityReservationId': 'string',
    'InstanceType': 'string',
    'TotalInstanceCount': 123,
    'AvailableInstanceCount': 123,
    'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed',
    'InstanceUsages': [
        {
            'AccountId': 'string',
            'UsedInstanceCount': 123
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • CapacityReservationId (string) –

      The ID of the Capacity Reservation.

    • InstanceType (string) –

      The type of instance for which the Capacity Reservation reserves capacity.

    • TotalInstanceCount (integer) –

      The number of instances for which the Capacity Reservation reserves capacity.

    • AvailableInstanceCount (integer) –

      The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

    • State (string) –

      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The Capacity Reservation is active and the capacity is available for your use.

      • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

      • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

    • InstanceUsages (list) –

      Information about the Capacity Reservation usage.

      • (dict) –

        Information about the Capacity Reservation usage.

        • AccountId (string) –

          The ID of the Amazon Web Services account that is making use of the Capacity Reservation.

        • UsedInstanceCount (integer) –

          The number of instances the Amazon Web Services account currently has in the Capacity Reservation.