Skip to content

describe_capacity_reservation_cancellation_quotes

describe_capacity_reservation_cancellation_quotes(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_cancellation_quote_ids: Optional[
        CapacityReservationCancellationQuoteIdSet
    ] = None,
    max_results: Optional[
        DescribeCapacityReservationCancellationQuotesRequestMaxResults
    ] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
) -> DescribeCapacityReservationCancellationQuotesResult

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

Parameters:

  • capacity_reservation_cancellation_quote_ids (Optional[CapacityReservationCancellationQuoteIdSet], default: None ) –

    The IDs of the cancellation quotes to describe.

  • max_results (Optional[DescribeCapacityReservationCancellationQuotesRequestMaxResults], default: None ) –

    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.

  • next_token (Optional[String], default: None ) –

    The token to use to retrieve the next page of results.

  • dry_run (Optional[Boolean], default: None ) –

    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 (Optional[FilterList], default: None ) –

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

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_capacity_reservation_cancellation_quotes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_cancellation_quote_ids: Optional[
        "capo_ec2.types.capacity_reservation_cancellation_quote_id_set.CapacityReservationCancellationQuoteIdSet"
    ] = None,
    max_results: Optional[
        "capo_ec2.types.describe_capacity_reservation_cancellation_quotes_request_max_results.DescribeCapacityReservationCancellationQuotesRequestMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_capacity_reservation_cancellation_quotes_result.DescribeCapacityReservationCancellationQuotesResult":
    """<p>Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the <code>CreateCapacityReservationCancellationQuote</code> action.</p>

    Args:
        capacity_reservation_cancellation_quote_ids: <p>The IDs of the cancellation quotes to describe.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        filters: <p>One or more filters. Filter names and values are case-sensitive.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_capacity_reservation_cancellation_quotes_request.DescribeCapacityReservationCancellationQuotesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_capacity_reservation_cancellation_quotes_result.DescribeCapacityReservationCancellationQuotesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_capacity_reservation_cancellation_quotes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_capacity_reservation_cancellation_quotes.describe_capacity_reservation_cancellation_quotes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeCapacityReservationCancellationQuotes"),
    )
    input_: capo_ec2.types.describe_capacity_reservation_cancellation_quotes_request.DescribeCapacityReservationCancellationQuotesRequest = {}
    if capacity_reservation_cancellation_quote_ids is not None:
        input_["capacity_reservation_cancellation_quote_ids"] = (
            capacity_reservation_cancellation_quote_ids
        )
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output