EC2 / Client / describe_capacity_reservation_date_change_quotes

describe_capacity_reservation_date_change_quotes

EC2.Client.describe_capacity_reservation_date_change_quotes(**kwargs)

Describes one or more Capacity Reservation date change quotes that you generated by using the CreateCapacityReservationDateChangeQuote operation.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CapacityReservationModificationQuoteIds (list) –

  The IDs of the date change 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

{
    'CapacityReservationModificationQuotes': [
        {
            'CapacityReservationModificationQuoteId': 'string',
            'CapacityReservationId': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'ExpirationTime': datetime(2015, 1, 1),
            'QuoteState': 'active'|'expired',
            'CurrentConfiguration': {
                'InstanceCount': 123,
                'ReservationState': 'string',
                'StartDate': datetime(2015, 1, 1),
                'OriginalStartDate': datetime(2015, 1, 1)
            },
            'ModificationTerms': {
                'ReservationUpdate': {
                    'NewCommitmentEndDate': datetime(2015, 1, 1),
                    'NewStartDate': datetime(2015, 1, 1),
                    'NewCommitmentDuration': 123
                }
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • CapacityReservationModificationQuotes (list) –

    Information about the Capacity Reservation date change quotes.

    • (dict) –

      Describes a Capacity Reservation modification quote, which provides the terms for changing the start date or the commitment of a future-dated Capacity Reservation.

      • CapacityReservationModificationQuoteId (string) –

        The ID of the modification quote.

      • CapacityReservationId (string) –

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

      • CreateTime (datetime) –

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

      • ExpirationTime (datetime) –

        The date and time at which the modification quote expires.

      • QuoteState (string) –

        The state of the modification quote itself. Possible values are:

        • active - The quote can still be used.

        • expired - The quote can no longer be used. A quote becomes expired at its expirationTime.

      • CurrentConfiguration (dict) –

        The configuration that the Capacity Reservation has at the time the quote was generated.

        • InstanceCount (integer) –

          The number of instances in the Capacity Reservation.

        • ReservationState (string) –

          The current state of the Capacity Reservation.

        • StartDate (datetime) –

          The start date that the Capacity Reservation has before the quoted modification is applied.

        • OriginalStartDate (datetime) –

          The start date that the Capacity Reservation was originally requested with. This value does not change when you push out the start date.

      • ModificationTerms (dict) –

        The terms of the modification, including the configuration that the Capacity Reservation will have if you accept them by using ModifyCapacityReservation.

        • ReservationUpdate (dict) –

          The changes that will be applied to the Capacity Reservation if you accept the modification terms.

          • NewCommitmentEndDate (datetime) –

            The date and time at which the commitment duration will expire after the modification, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

          • NewStartDate (datetime) –

            The start date that the Capacity Reservation will have after the modification, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

          • NewCommitmentDuration (integer) –

            The commitment duration, in seconds, that the Capacity Reservation will have after the modification.

      • Tags (list) –

        The tags assigned to the modification 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.