aws_sdk_opsworks/client/
describe_stacks.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 [`DescribeStacks`](crate::operation::describe_stacks::builders::DescribeStacksFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_ids(impl Into<String>)`](crate::operation::describe_stacks::builders::DescribeStacksFluentBuilder::stack_ids) / [`set_stack_ids(Option<Vec::<String>>)`](crate::operation::describe_stacks::builders::DescribeStacksFluentBuilder::set_stack_ids):<br>required: **false**<br><p>An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, <code>DescribeStacks</code> returns a description of every stack. If the IAM policy that is attached to an IAM user limits the <code>DescribeStacks</code> action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, <code>DescribeStacks</code> returns an <code>AccessDenied</code> error.</p><br>
7    /// - On success, responds with [`DescribeStacksOutput`](crate::operation::describe_stacks::DescribeStacksOutput) with field(s):
8    ///   - [`stacks(Option<Vec::<Stack>>)`](crate::operation::describe_stacks::DescribeStacksOutput::stacks): <p>An array of <code>Stack</code> objects that describe the stacks.</p>
9    /// - On failure, responds with [`SdkError<DescribeStacksError>`](crate::operation::describe_stacks::DescribeStacksError)
10    pub fn describe_stacks(&self) -> crate::operation::describe_stacks::builders::DescribeStacksFluentBuilder {
11        crate::operation::describe_stacks::builders::DescribeStacksFluentBuilder::new(self.handle.clone())
12    }
13}