aws_sdk_ec2/client/
describe_scheduled_instance_availability.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeScheduledInstanceAvailability`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::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>
8    ///   - [`filters(Filter)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>availability-zone</code> - The Availability Zone (for example, <code>us-west-2a</code>).</p></li>  <li>   <p><code>instance-type</code> - The instance type (for example, <code>c4.large</code>).</p></li>  <li>   <p><code>platform</code> - The platform (<code>Linux/UNIX</code> or <code>Windows</code>).</p></li> </ul><br>
9    ///   - [`first_slot_start_time_range(SlotDateTimeRangeRequest)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::first_slot_start_time_range) / [`set_first_slot_start_time_range(Option<SlotDateTimeRangeRequest>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_first_slot_start_time_range):<br>required: **true**<br><p>The time period for the first schedule to start.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p><br>
11    ///   - [`max_slot_duration_in_hours(i32)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::max_slot_duration_in_hours) / [`set_max_slot_duration_in_hours(Option<i32>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_max_slot_duration_in_hours):<br>required: **false**<br><p>The maximum available duration, in hours. This value must be greater than <code>MinSlotDurationInHours</code> and less than 1,720.</p><br>
12    ///   - [`min_slot_duration_in_hours(i32)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::min_slot_duration_in_hours) / [`set_min_slot_duration_in_hours(Option<i32>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_min_slot_duration_in_hours):<br>required: **false**<br><p>The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.</p><br>
13    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results.</p><br>
14    ///   - [`recurrence(ScheduledInstanceRecurrenceRequest)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::recurrence) / [`set_recurrence(Option<ScheduledInstanceRecurrenceRequest>)`](crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::set_recurrence):<br>required: **true**<br><p>The schedule recurrence.</p><br>
15    /// - On success, responds with [`DescribeScheduledInstanceAvailabilityOutput`](crate::operation::describe_scheduled_instance_availability::DescribeScheduledInstanceAvailabilityOutput) with field(s):
16    ///   - [`next_token(Option<String>)`](crate::operation::describe_scheduled_instance_availability::DescribeScheduledInstanceAvailabilityOutput::next_token): <p>The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return.</p>
17    ///   - [`scheduled_instance_availability_set(Option<Vec::<ScheduledInstanceAvailability>>)`](crate::operation::describe_scheduled_instance_availability::DescribeScheduledInstanceAvailabilityOutput::scheduled_instance_availability_set): <p>Information about the available Scheduled Instances.</p>
18    /// - On failure, responds with [`SdkError<DescribeScheduledInstanceAvailabilityError>`](crate::operation::describe_scheduled_instance_availability::DescribeScheduledInstanceAvailabilityError)
19    pub fn describe_scheduled_instance_availability(
20        &self,
21    ) -> crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder {
22        crate::operation::describe_scheduled_instance_availability::builders::DescribeScheduledInstanceAvailabilityFluentBuilder::new(
23            self.handle.clone(),
24        )
25    }
26}
aws_sdk_ec2/client/describe_scheduled_instance_availability.rs

aws_sdk_ec2/client/
describe_scheduled_instance_availability.rs
