aws_sdk_emr/client/list_instances.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 [`ListInstances`](crate::operation::list_instances::builders::ListInstancesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`cluster_id(impl Into<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_cluster_id):<br>required: **true**<br><p>The identifier of the cluster for which to list the instances.</p><br>
8 /// - [`instance_group_id(impl Into<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::instance_group_id) / [`set_instance_group_id(Option<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_instance_group_id):<br>required: **false**<br><p>The identifier of the instance group for which to list the instances.</p><br>
9 /// - [`instance_group_types(InstanceGroupType)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::instance_group_types) / [`set_instance_group_types(Option<Vec::<InstanceGroupType>>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_instance_group_types):<br>required: **false**<br><p>The type of instance group for which to list the instances.</p><br>
10 /// - [`instance_fleet_id(impl Into<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::instance_fleet_id) / [`set_instance_fleet_id(Option<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_instance_fleet_id):<br>required: **false**<br><p>The unique identifier of the instance fleet.</p><br>
11 /// - [`instance_fleet_type(InstanceFleetType)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::instance_fleet_type) / [`set_instance_fleet_type(Option<InstanceFleetType>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_instance_fleet_type):<br>required: **false**<br><p>The node type of the instance fleet. For example MASTER, CORE, or TASK.</p><br>
12 /// - [`instance_states(InstanceState)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::instance_states) / [`set_instance_states(Option<Vec::<InstanceState>>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_instance_states):<br>required: **false**<br><p>A list of instance states that will filter the instances returned with this request.</p><br>
13 /// - [`marker(impl Into<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_marker):<br>required: **false**<br><p>The pagination token that indicates the next set of results to retrieve.</p><br>
14 /// - On success, responds with [`ListInstancesOutput`](crate::operation::list_instances::ListInstancesOutput) with field(s):
15 /// - [`instances(Option<Vec::<Instance>>)`](crate::operation::list_instances::ListInstancesOutput::instances): <p>The list of instances for the cluster and given filters.</p>
16 /// - [`marker(Option<String>)`](crate::operation::list_instances::ListInstancesOutput::marker): <p>The pagination token that indicates the next set of results to retrieve.</p>
17 /// - On failure, responds with [`SdkError<ListInstancesError>`](crate::operation::list_instances::ListInstancesError)
18 pub fn list_instances(&self) -> crate::operation::list_instances::builders::ListInstancesFluentBuilder {
19 crate::operation::list_instances::builders::ListInstancesFluentBuilder::new(self.handle.clone())
20 }
21}