aws_sdk_opsworks/client/
describe_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 [`DescribeInstances`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_id(impl Into<String>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::stack_id) / [`set_stack_id(Option<String>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::set_stack_id):<br>required: **false**<br><p>A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack.</p><br>
7    ///   - [`layer_id(impl Into<String>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::layer_id) / [`set_layer_id(Option<String>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::set_layer_id):<br>required: **false**<br><p>A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer.</p><br>
8    ///   - [`instance_ids(impl Into<String>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::instance_ids) / [`set_instance_ids(Option<Vec::<String>>)`](crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::set_instance_ids):<br>required: **false**<br><p>An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance.</p><br>
9    /// - On success, responds with [`DescribeInstancesOutput`](crate::operation::describe_instances::DescribeInstancesOutput) with field(s):
10    ///   - [`instances(Option<Vec::<Instance>>)`](crate::operation::describe_instances::DescribeInstancesOutput::instances): <p>An array of <code>Instance</code> objects that describe the instances.</p>
11    /// - On failure, responds with [`SdkError<DescribeInstancesError>`](crate::operation::describe_instances::DescribeInstancesError)
12    pub fn describe_instances(&self) -> crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder {
13        crate::operation::describe_instances::builders::DescribeInstancesFluentBuilder::new(self.handle.clone())
14    }
15}
aws_sdk_opsworks/client/describe_instances.rs

aws_sdk_opsworks/client/
describe_instances.rs
