aws-sdk-ec2 1.231.0

AWS SDK for Amazon Elastic Compute Cloud
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CancelCapacityReservation`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`capacity_reservation_id(impl Into<String>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::capacity_reservation_id) / [`set_capacity_reservation_id(Option<String>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::set_capacity_reservation_id):<br>required: **true**<br><p>The ID of the Capacity Reservation to be cancelled.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
    ///   - [`apply_cancellation_charges(ApplyCancellationCharges)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::apply_cancellation_charges) / [`set_apply_cancellation_charges(Option<ApplyCancellationCharges>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::set_apply_cancellation_charges):<br>required: **false**<br><p>Specifies the cancellation charge type to apply when cancelling a future-dated Capacity Reservation during its commitment duration. Possible values include <code>commitment-wind-down</code>, which continues billing for the remaining commitment duration without delivering capacity.</p><br>
    ///   - [`quote_id(impl Into<String>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::quote_id) / [`set_quote_id(Option<String>)`](crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::set_quote_id):<br>required: **false**<br><p>The ID of the cancellation quote to use for the cancellation. You can generate a cancellation quote by using the <code>CreateCapacityReservationCancellationQuote</code> action. The cancellation quote must be in an <code>active</code> state.</p><br>
    /// - On success, responds with [`CancelCapacityReservationOutput`](crate::operation::cancel_capacity_reservation::CancelCapacityReservationOutput) with field(s):
    ///   - [`r#return(Option<bool>)`](crate::operation::cancel_capacity_reservation::CancelCapacityReservationOutput::return): <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>
    /// - On failure, responds with [`SdkError<CancelCapacityReservationError>`](crate::operation::cancel_capacity_reservation::CancelCapacityReservationError)
    pub fn cancel_capacity_reservation(&self) -> crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder {
        crate::operation::cancel_capacity_reservation::builders::CancelCapacityReservationFluentBuilder::new(self.handle.clone())
    }
}