EC2 / Client / describe_capacity_reservation_cancellation_quotes

describe_capacity_reservation_cancellation_quotes

EC2.Client.describe_capacity_reservation_cancellation_quotes(**kwargs)

Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action.

See also: AWS API Documentation

Request Syntax

response = client.describe_capacity_reservation_cancellation_quotes(
    CapacityReservationCancellationQuoteIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• CapacityReservationCancellationQuoteIds (list) –

  The IDs of the cancellation quotes to describe.

  • (string) –

• MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

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

• Filters (list) –

  One or more filters. Filter names and values are case-sensitive.

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

Return type:

dict

Returns:

Response Syntax

{
    'CapacityReservationCancellationQuotes': [
        {
            'CapacityReservationCancellationQuoteId': 'string',
            'CapacityReservationId': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'ExpirationTime': datetime(2015, 1, 1),
            'QuoteState': 'pending'|'active'|'expired',
            'CurrentConfiguration': {
                'InstanceCount': 123,
                'ReservationState': 'string'
            },
            'CancellationTerms': [
                {
                    'CancellationType': 'commitment-wind-down',
                    'ReservationState': 'string',
                    'CommittedInstanceCount': 123,
                    'ChargeCommitmentDurationHours': 123,
                    'ChargeEndDate': datetime(2015, 1, 1)
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • CapacityReservationCancellationQuotes (list) –

    Information about the Capacity Reservation cancellation quotes.

    • (dict) –

      Describes a Capacity Reservation cancellation quote, which provides the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.

      • CapacityReservationCancellationQuoteId (string) –

        The ID of the cancellation quote.

      • CapacityReservationId (string) –

        The ID of the Capacity Reservation associated with the cancellation quote.

      • CreateTime (datetime) –

        The date and time at which the cancellation quote was created.

      • ExpirationTime (datetime) –

        The date and time at which the cancellation quote expires.

      • QuoteState (string) –

        The state of the cancellation quote. Possible values include pending, active, and expired.

      • CurrentConfiguration (dict) –

        The current configuration of the Capacity Reservation.

        • InstanceCount (integer) –

          The number of instances in the Capacity Reservation.

        • ReservationState (string) –

          The current state of the Capacity Reservation.

      • CancellationTerms (list) –

        The cancellation terms associated with the quote, including the fee type and charge details.

        • (dict) –

          Describes the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.

          • CancellationType (string) –

            The type of cancellation charge. Possible values include commitment-wind-down.

          • ReservationState (string) –

            The state that the Capacity Reservation will transition to after cancellation.

          • CommittedInstanceCount (integer) –

            The number of instances under commitment after cancellation.

          • ChargeCommitmentDurationHours (integer) –

            The number of hours for which cancellation charges will apply.

          • ChargeEndDate (datetime) –

            The date and time at which cancellation charges will stop.

      • Tags (list) –

        The tags assigned to the cancellation quote.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

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