aws_sdk_cloudformation/operation/describe_stacks/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_stacks::_describe_stacks_output::DescribeStacksOutputBuilder;
3
4pub use crate::operation::describe_stacks::_describe_stacks_input::DescribeStacksInputBuilder;
5
6impl crate::operation::describe_stacks::builders::DescribeStacksInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::describe_stacks::DescribeStacksOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_stacks::DescribeStacksError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_stacks();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeStacks`.
24///
25/// <p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p><note>
26/// <p>If the stack doesn't exist, a <code>ValidationError</code> is returned.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeStacksFluentBuilder {
30 handle: ::std::sync::Arc<crate::client::Handle>,
31 inner: crate::operation::describe_stacks::builders::DescribeStacksInputBuilder,
32 config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35 crate::client::customize::internal::CustomizableSend<
36 crate::operation::describe_stacks::DescribeStacksOutput,
37 crate::operation::describe_stacks::DescribeStacksError,
38 > for DescribeStacksFluentBuilder
39{
40 fn send(
41 self,
42 config_override: crate::config::Builder,
43 ) -> crate::client::customize::internal::BoxFuture<
44 crate::client::customize::internal::SendResult<
45 crate::operation::describe_stacks::DescribeStacksOutput,
46 crate::operation::describe_stacks::DescribeStacksError,
47 >,
48 > {
49 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50 }
51}
52impl DescribeStacksFluentBuilder {
53 /// Creates a new `DescribeStacksFluentBuilder`.
54 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55 Self {
56 handle,
57 inner: ::std::default::Default::default(),
58 config_override: ::std::option::Option::None,
59 }
60 }
61 /// Access the DescribeStacks as a reference.
62 pub fn as_input(&self) -> &crate::operation::describe_stacks::builders::DescribeStacksInputBuilder {
63 &self.inner
64 }
65 /// Sends the request and returns the response.
66 ///
67 /// If an error occurs, an `SdkError` will be returned with additional details that
68 /// can be matched against.
69 ///
70 /// By default, any retryable failures will be retried twice. Retry behavior
71 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72 /// set when configuring the client.
73 pub async fn send(
74 self,
75 ) -> ::std::result::Result<
76 crate::operation::describe_stacks::DescribeStacksOutput,
77 ::aws_smithy_runtime_api::client::result::SdkError<
78 crate::operation::describe_stacks::DescribeStacksError,
79 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80 >,
81 > {
82 let input = self
83 .inner
84 .build()
85 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86 let runtime_plugins = crate::operation::describe_stacks::DescribeStacks::operation_runtime_plugins(
87 self.handle.runtime_plugins.clone(),
88 &self.handle.conf,
89 self.config_override,
90 );
91 crate::operation::describe_stacks::DescribeStacks::orchestrate(&runtime_plugins, input).await
92 }
93
94 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95 pub fn customize(
96 self,
97 ) -> crate::client::customize::CustomizableOperation<
98 crate::operation::describe_stacks::DescribeStacksOutput,
99 crate::operation::describe_stacks::DescribeStacksError,
100 Self,
101 > {
102 crate::client::customize::CustomizableOperation::new(self)
103 }
104 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105 self.set_config_override(::std::option::Option::Some(config_override.into()));
106 self
107 }
108
109 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110 self.config_override = config_override;
111 self
112 }
113 /// Create a paginator for this request
114 ///
115 /// Paginators are used by calling [`send().await`](crate::operation::describe_stacks::paginator::DescribeStacksPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116 pub fn into_paginator(self) -> crate::operation::describe_stacks::paginator::DescribeStacksPaginator {
117 crate::operation::describe_stacks::paginator::DescribeStacksPaginator::new(self.handle, self.inner)
118 }
119 /// <note>
120 /// <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account, which can impact performance. This requires <code>ListStacks</code> and <code>DescribeStacks</code> permissions.</p>
121 /// <p>Consider using the <code>ListStacks</code> API if you're not passing a parameter to <code>StackName</code>.</p>
122 /// <p>The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:</p>
123 /// <p>{ "Version": "2012-10-17", "Statement": \[{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }\] }</p>
124 /// </note>
125 /// <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
126 /// <ul>
127 /// <li>
128 /// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
129 /// <li>
130 /// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
131 /// </ul>
132 pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133 self.inner = self.inner.stack_name(input.into());
134 self
135 }
136 /// <note>
137 /// <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account, which can impact performance. This requires <code>ListStacks</code> and <code>DescribeStacks</code> permissions.</p>
138 /// <p>Consider using the <code>ListStacks</code> API if you're not passing a parameter to <code>StackName</code>.</p>
139 /// <p>The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:</p>
140 /// <p>{ "Version": "2012-10-17", "Statement": \[{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }\] }</p>
141 /// </note>
142 /// <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
143 /// <ul>
144 /// <li>
145 /// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
146 /// <li>
147 /// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
148 /// </ul>
149 pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150 self.inner = self.inner.set_stack_name(input);
151 self
152 }
153 /// <note>
154 /// <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account, which can impact performance. This requires <code>ListStacks</code> and <code>DescribeStacks</code> permissions.</p>
155 /// <p>Consider using the <code>ListStacks</code> API if you're not passing a parameter to <code>StackName</code>.</p>
156 /// <p>The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:</p>
157 /// <p>{ "Version": "2012-10-17", "Statement": \[{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }\] }</p>
158 /// </note>
159 /// <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
160 /// <ul>
161 /// <li>
162 /// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
163 /// <li>
164 /// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
165 /// </ul>
166 pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> {
167 self.inner.get_stack_name()
168 }
169 /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
170 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171 self.inner = self.inner.next_token(input.into());
172 self
173 }
174 /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
175 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176 self.inner = self.inner.set_next_token(input);
177 self
178 }
179 /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
180 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
181 self.inner.get_next_token()
182 }
183}