EC2 / Paginator / DescribeCapacityBlockExtensionHistory

DescribeCapacityBlockExtensionHistory

class EC2.Paginator.DescribeCapacityBlockExtensionHistory

paginator = client.get_paginator('describe_capacity_block_extension_history')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CapacityReservationIds (list) –

  The IDs of Capacity Block reservations that you want to display the history for.

  • (string) –

• Filters (list) –

  One or more filters

  • availability-zone - The Availability Zone of the extension.

  • availability-zone-id - The Availability Zone ID of the extension.

  • capacity-block-extension-offering-id - The ID of the extension offering.

  • capacity-block-extension-status - The status of the extension ( payment-pending | payment-failed | payment-succeeded).

  • capacity-reservation-id - The reservation ID of the extension.

  • instance-type - The instance type of the extension.

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

{
    'CapacityBlockExtensions': [
        {
            'CapacityReservationId': 'string',
            'InstanceType': 'string',
            'InstanceCount': 123,
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CapacityBlockExtensionOfferingId': 'string',
            'CapacityBlockExtensionDurationHours': 123,
            'CapacityBlockExtensionStatus': 'payment-pending'|'payment-failed'|'payment-succeeded',
            'CapacityBlockExtensionPurchaseDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionStartDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionEndDate': datetime(2015, 1, 1),
            'UpfrontFee': 'string',
            'CurrencyCode': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • CapacityBlockExtensions (list) –

    Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the Amazon Web Services Region that you’re currently using.

    • (dict) –

      Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block.

      • CapacityReservationId (string) –

        The reservation ID of the Capacity Block extension.

      • InstanceType (string) –

        The instance type of the Capacity Block extension.

      • InstanceCount (integer) –

        The number of instances in the Capacity Block extension.

      • AvailabilityZone (string) –

        The Availability Zone of the Capacity Block extension.

      • AvailabilityZoneId (string) –

        The Availability Zone ID of the Capacity Block extension.

      • CapacityBlockExtensionOfferingId (string) –

        The ID of the Capacity Block extension offering.

      • CapacityBlockExtensionDurationHours (integer) –

        The duration of the Capacity Block extension in hours.

      • CapacityBlockExtensionStatus (string) –

        The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses:

        • payment-pending - The Capacity Block extension payment is processing. If your payment can’t be processed within 12 hours, the Capacity Block extension is failed.

        • payment-failed - Payment for the Capacity Block extension request was not successful.

        • payment-succeeded - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID.

      • CapacityBlockExtensionPurchaseDate (datetime) –

        The date when the Capacity Block extension was purchased.

      • CapacityBlockExtensionStartDate (datetime) –

        The start date of the Capacity Block extension.

      • CapacityBlockExtensionEndDate (datetime) –

        The end date of the Capacity Block extension.

      • UpfrontFee (string) –

        The total price to be paid up front.

      • CurrencyCode (string) –

        The currency of the payment for the Capacity Block extension.