EC2 / Paginator / DescribeCapacityBlockStatus

DescribeCapacityBlockStatus

class EC2.Paginator.DescribeCapacityBlockStatus

paginator = client.get_paginator('describe_capacity_block_status')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_capacity_block_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CapacityBlockIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CapacityBlockIds (list) –

  The ID of the Capacity Block.

  • (string) –

• Filters (list) –

  One or more filters.

  • interconnect-status - The status of the interconnect for the Capacity Block ( ok | impaired | insufficient-data).

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityBlockStatuses': [
        {
            'CapacityBlockId': 'string',
            'InterconnectStatus': 'ok'|'impaired'|'insufficient-data',
            'TotalCapacity': 123,
            'TotalAvailableCapacity': 123,
            'TotalUnavailableCapacity': 123,
            'CapacityReservationStatuses': [
                {
                    'CapacityReservationId': 'string',
                    'TotalCapacity': 123,
                    'TotalAvailableCapacity': 123,
                    'TotalUnavailableCapacity': 123
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • CapacityBlockStatuses (list) –

    The availability of capacity for a Capacity Block.

    • (dict) –

      Describes the availability of capacity for a Capacity Block.

      • CapacityBlockId (string) –

        The ID of the Capacity Block.

      • InterconnectStatus (string) –

        The status of the high-bandwidth accelerator interconnect. Possible states include:

        • ok the accelerator interconnect is healthy.

        • impaired - accelerator interconnect communication is impaired.

        • insufficient-data - insufficient data to determine accelerator interconnect status.

      • TotalCapacity (integer) –

        The combined amount of Available and Unavailable capacity in the Capacity Block.

      • TotalAvailableCapacity (integer) –

        The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.

      • TotalUnavailableCapacity (integer) –

        The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.

      • CapacityReservationStatuses (list) –

        The availability of capacity for the Capacity Block reservations.

        • (dict) –

          Describes the availability of capacity for a Capacity Reservation.

          • CapacityReservationId (string) –

            The ID of the Capacity Reservation.

          • TotalCapacity (integer) –

            The combined amount of Available and Unavailable capacity in the Capacity Reservation.

          • TotalAvailableCapacity (integer) –

            The remaining capacity. Indicates the amount of resources that can be launched into the Capacity Reservation.

          • TotalUnavailableCapacity (integer) –

            The used capacity. Indicates that the capacity is in use by resources that are running in the Capacity Reservation.