1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeScheduledInstances`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::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>
    ///   - [`filters(Filter)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::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>
    ///   - [`max_results(i32)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::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 100. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results.</p><br>
    ///   - [`scheduled_instance_ids(impl Into<String>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::scheduled_instance_ids) / [`set_scheduled_instance_ids(Option<Vec::<String>>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::set_scheduled_instance_ids):<br>required: **false**<br><p>The Scheduled Instance IDs.</p><br>
    ///   - [`slot_start_time_range(SlotStartTimeRangeRequest)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::slot_start_time_range) / [`set_slot_start_time_range(Option<SlotStartTimeRangeRequest>)`](crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::set_slot_start_time_range):<br>required: **false**<br><p>The time period for the first schedule to start.</p><br>
    /// - On success, responds with [`DescribeScheduledInstancesOutput`](crate::operation::describe_scheduled_instances::DescribeScheduledInstancesOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_scheduled_instances::DescribeScheduledInstancesOutput::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>
    ///   - [`scheduled_instance_set(Option<Vec::<ScheduledInstance>>)`](crate::operation::describe_scheduled_instances::DescribeScheduledInstancesOutput::scheduled_instance_set): <p>Information about the Scheduled Instances.</p>
    /// - On failure, responds with [`SdkError<DescribeScheduledInstancesError>`](crate::operation::describe_scheduled_instances::DescribeScheduledInstancesError)
    pub fn describe_scheduled_instances(&self) -> crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder {
        crate::operation::describe_scheduled_instances::builders::DescribeScheduledInstancesFluentBuilder::new(self.handle.clone())
    }
}