Skip to content

create_capacity_reservation_cancellation_quote

create_capacity_reservation_cancellation_quote(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_id: Optional[CapacityReservationId] = None,
    client_token: Optional[String] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
    dry_run: Optional[Boolean] = None,
) -> CreateCapacityReservationCancellationQuoteResult

Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours.

Parameters:

  • capacity_reservation_id (Optional[CapacityReservationId], default: None ) –

    The ID of the Capacity Reservation.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to apply to the cancellation quote.

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

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def create_capacity_reservation_cancellation_quote(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_reservation_id: Optional[
        "capo_ec2.types.capacity_reservation_id.CapacityReservationId"
    ] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.create_capacity_reservation_cancellation_quote_result.CreateCapacityReservationCancellationQuoteResult":
    """<p>Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the <code>CancelCapacityReservation</code> action. Cancellation quotes are valid for 24 hours.</p>

    Args:
        capacity_reservation_id: <p>The ID of the Capacity Reservation.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensure Idempotency</a>.</p>
        tag_specifications: <p>The tags to apply to the cancellation quote.</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>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_capacity_reservation_cancellation_quote_request.CreateCapacityReservationCancellationQuoteRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_capacity_reservation_cancellation_quote_result.CreateCapacityReservationCancellationQuoteResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_capacity_reservation_cancellation_quote

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateCapacityReservationCancellationQuote"),
    )
    input_: capo_ec2.types.create_capacity_reservation_cancellation_quote_request.CreateCapacityReservationCancellationQuoteRequest = {}
    if capacity_reservation_id is not None:
        input_["capacity_reservation_id"] = capacity_reservation_id
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if dry_run is not None:
        input_["dry_run"] = dry_run

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