aws_sdk_ec2/client/

modify_capacity_reservation.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyCapacityReservation`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`capacity_reservation_id(impl Into<String>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::capacity_reservation_id) / [`set_capacity_reservation_id(Option<String>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_capacity_reservation_id):<br>required: **true**<br><p>The ID of the Capacity Reservation.</p><br>
    ///   - [`instance_count(i32)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::instance_count) / [`set_instance_count(Option<i32>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_instance_count):<br>required: **false**<br><p>The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than <code>1000</code> in a single request.</p><br>
    ///   - [`end_date(DateTime)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::end_date) / [`set_end_date(Option<DateTime>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_end_date):<br>required: **false**<br><p>The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to <code>expired</code> when it reaches its end date and time.</p> <p>The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.</p> <p>You must provide an <code>EndDate</code> value if <code>EndDateType</code> is <code>limited</code>. Omit <code>EndDate</code> if <code>EndDateType</code> is <code>unlimited</code>.</p><br>
    ///   - [`end_date_type(EndDateType)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::end_date_type) / [`set_end_date_type(Option<EndDateType>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_end_date_type):<br>required: **false**<br><p>Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul>  <li>   <p><code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an <code>EndDate</code> value if <code>EndDateType</code> is <code>unlimited</code>.</p></li>  <li>   <p><code>limited</code> - The Capacity Reservation expires automatically at a specified date and time. You must provide an <code>EndDate</code> value if <code>EndDateType</code> is <code>limited</code>.</p></li> </ul><br>
    ///   - [`accept(bool)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::accept) / [`set_accept(Option<bool>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_accept):<br>required: **false**<br><p>Reserved. Capacity Reservations you have created are accepted by default.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::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>
    ///   - [`additional_info(impl Into<String>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::additional_info) / [`set_additional_info(Option<String>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_additional_info):<br>required: **false**<br><p>Reserved for future use.</p><br>
    ///   - [`instance_match_criteria(InstanceMatchCriteria)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::instance_match_criteria) / [`set_instance_match_criteria(Option<InstanceMatchCriteria>)`](crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::set_instance_match_criteria):<br>required: **false**<br><p>The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from <code>targeted</code> to <code>open</code>, any running instances that match the attributes of the Capacity Reservation, have the <code>CapacityReservationPreference</code> set to <code>open</code>, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.</p> <p>To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).</p><br>
    /// - On success, responds with [`ModifyCapacityReservationOutput`](crate::operation::modify_capacity_reservation::ModifyCapacityReservationOutput) with field(s):
    ///   - [`r#return(Option<bool>)`](crate::operation::modify_capacity_reservation::ModifyCapacityReservationOutput::return): <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>
    /// - On failure, responds with [`SdkError<ModifyCapacityReservationError>`](crate::operation::modify_capacity_reservation::ModifyCapacityReservationError)
    pub fn modify_capacity_reservation(&self) -> crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder {
        crate::operation::modify_capacity_reservation::builders::ModifyCapacityReservationFluentBuilder::new(self.handle.clone())
    }
}