aws_sdk_swf/operation/count_closed_workflow_executions/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::count_closed_workflow_executions::_count_closed_workflow_executions_output::CountClosedWorkflowExecutionsOutputBuilder;
3
4pub use crate::operation::count_closed_workflow_executions::_count_closed_workflow_executions_input::CountClosedWorkflowExecutionsInputBuilder;
5
6impl crate::operation::count_closed_workflow_executions::builders::CountClosedWorkflowExecutionsInputBuilder {
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::count_closed_workflow_executions::CountClosedWorkflowExecutionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.count_closed_workflow_executions();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CountClosedWorkflowExecutions`.
24///
25/// <p>Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.</p><note>
26/// <p>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</p>
27/// </note>
28/// <p><b>Access Control</b></p>
29/// <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>
30/// <ul>
31/// <li>
32/// <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p></li>
33/// <li>
34/// <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p></li>
35/// <li>
36/// <p>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.</p>
37/// <ul>
38/// <li>
39/// <p><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</p></li>
40/// <li>
41/// <p><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</p></li>
42/// <li>
43/// <p><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</p></li>
44/// </ul></li>
45/// </ul>
46/// <p>If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
47#[derive(::std::clone::Clone, ::std::fmt::Debug)]
48pub struct CountClosedWorkflowExecutionsFluentBuilder {
49 handle: ::std::sync::Arc<crate::client::Handle>,
50 inner: crate::operation::count_closed_workflow_executions::builders::CountClosedWorkflowExecutionsInputBuilder,
51 config_override: ::std::option::Option<crate::config::Builder>,
52}
53impl
54 crate::client::customize::internal::CustomizableSend<
55 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsOutput,
56 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsError,
57 > for CountClosedWorkflowExecutionsFluentBuilder
58{
59 fn send(
60 self,
61 config_override: crate::config::Builder,
62 ) -> crate::client::customize::internal::BoxFuture<
63 crate::client::customize::internal::SendResult<
64 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsOutput,
65 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsError,
66 >,
67 > {
68 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
69 }
70}
71impl CountClosedWorkflowExecutionsFluentBuilder {
72 /// Creates a new `CountClosedWorkflowExecutionsFluentBuilder`.
73 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
74 Self {
75 handle,
76 inner: ::std::default::Default::default(),
77 config_override: ::std::option::Option::None,
78 }
79 }
80 /// Access the CountClosedWorkflowExecutions as a reference.
81 pub fn as_input(&self) -> &crate::operation::count_closed_workflow_executions::builders::CountClosedWorkflowExecutionsInputBuilder {
82 &self.inner
83 }
84 /// Sends the request and returns the response.
85 ///
86 /// If an error occurs, an `SdkError` will be returned with additional details that
87 /// can be matched against.
88 ///
89 /// By default, any retryable failures will be retried twice. Retry behavior
90 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
91 /// set when configuring the client.
92 pub async fn send(
93 self,
94 ) -> ::std::result::Result<
95 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsOutput,
96 ::aws_smithy_runtime_api::client::result::SdkError<
97 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsError,
98 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
99 >,
100 > {
101 let input = self
102 .inner
103 .build()
104 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
105 let runtime_plugins = crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutions::operation_runtime_plugins(
106 self.handle.runtime_plugins.clone(),
107 &self.handle.conf,
108 self.config_override,
109 );
110 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutions::orchestrate(&runtime_plugins, input).await
111 }
112
113 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
114 pub fn customize(
115 self,
116 ) -> crate::client::customize::CustomizableOperation<
117 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsOutput,
118 crate::operation::count_closed_workflow_executions::CountClosedWorkflowExecutionsError,
119 Self,
120 > {
121 crate::client::customize::CustomizableOperation::new(self)
122 }
123 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
124 self.set_config_override(::std::option::Option::Some(config_override.into()));
125 self
126 }
127
128 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
129 self.config_override = config_override;
130 self
131 }
132 /// <p>The name of the domain containing the workflow executions to count.</p>
133 pub fn domain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134 self.inner = self.inner.domain(input.into());
135 self
136 }
137 /// <p>The name of the domain containing the workflow executions to count.</p>
138 pub fn set_domain(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.inner = self.inner.set_domain(input);
140 self
141 }
142 /// <p>The name of the domain containing the workflow executions to count.</p>
143 pub fn get_domain(&self) -> &::std::option::Option<::std::string::String> {
144 self.inner.get_domain()
145 }
146 /// <p>If specified, only workflow executions that meet the start time criteria of the filter are counted.</p><note>
147 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
148 /// </note>
149 pub fn start_time_filter(mut self, input: crate::types::ExecutionTimeFilter) -> Self {
150 self.inner = self.inner.start_time_filter(input);
151 self
152 }
153 /// <p>If specified, only workflow executions that meet the start time criteria of the filter are counted.</p><note>
154 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
155 /// </note>
156 pub fn set_start_time_filter(mut self, input: ::std::option::Option<crate::types::ExecutionTimeFilter>) -> Self {
157 self.inner = self.inner.set_start_time_filter(input);
158 self
159 }
160 /// <p>If specified, only workflow executions that meet the start time criteria of the filter are counted.</p><note>
161 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
162 /// </note>
163 pub fn get_start_time_filter(&self) -> &::std::option::Option<crate::types::ExecutionTimeFilter> {
164 self.inner.get_start_time_filter()
165 }
166 /// <p>If specified, only workflow executions that meet the close time criteria of the filter are counted.</p><note>
167 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
168 /// </note>
169 pub fn close_time_filter(mut self, input: crate::types::ExecutionTimeFilter) -> Self {
170 self.inner = self.inner.close_time_filter(input);
171 self
172 }
173 /// <p>If specified, only workflow executions that meet the close time criteria of the filter are counted.</p><note>
174 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
175 /// </note>
176 pub fn set_close_time_filter(mut self, input: ::std::option::Option<crate::types::ExecutionTimeFilter>) -> Self {
177 self.inner = self.inner.set_close_time_filter(input);
178 self
179 }
180 /// <p>If specified, only workflow executions that meet the close time criteria of the filter are counted.</p><note>
181 /// <p><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p>
182 /// </note>
183 pub fn get_close_time_filter(&self) -> &::std::option::Option<crate::types::ExecutionTimeFilter> {
184 self.inner.get_close_time_filter()
185 }
186 /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
187 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
188 /// </note>
189 pub fn execution_filter(mut self, input: crate::types::WorkflowExecutionFilter) -> Self {
190 self.inner = self.inner.execution_filter(input);
191 self
192 }
193 /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
194 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
195 /// </note>
196 pub fn set_execution_filter(mut self, input: ::std::option::Option<crate::types::WorkflowExecutionFilter>) -> Self {
197 self.inner = self.inner.set_execution_filter(input);
198 self
199 }
200 /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
201 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
202 /// </note>
203 pub fn get_execution_filter(&self) -> &::std::option::Option<crate::types::WorkflowExecutionFilter> {
204 self.inner.get_execution_filter()
205 }
206 /// <p>If specified, indicates the type of the workflow executions to be counted.</p><note>
207 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
208 /// </note>
209 pub fn type_filter(mut self, input: crate::types::WorkflowTypeFilter) -> Self {
210 self.inner = self.inner.type_filter(input);
211 self
212 }
213 /// <p>If specified, indicates the type of the workflow executions to be counted.</p><note>
214 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
215 /// </note>
216 pub fn set_type_filter(mut self, input: ::std::option::Option<crate::types::WorkflowTypeFilter>) -> Self {
217 self.inner = self.inner.set_type_filter(input);
218 self
219 }
220 /// <p>If specified, indicates the type of the workflow executions to be counted.</p><note>
221 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
222 /// </note>
223 pub fn get_type_filter(&self) -> &::std::option::Option<crate::types::WorkflowTypeFilter> {
224 self.inner.get_type_filter()
225 }
226 /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
227 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
228 /// </note>
229 pub fn tag_filter(mut self, input: crate::types::TagFilter) -> Self {
230 self.inner = self.inner.tag_filter(input);
231 self
232 }
233 /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
234 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
235 /// </note>
236 pub fn set_tag_filter(mut self, input: ::std::option::Option<crate::types::TagFilter>) -> Self {
237 self.inner = self.inner.set_tag_filter(input);
238 self
239 }
240 /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
241 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
242 /// </note>
243 pub fn get_tag_filter(&self) -> &::std::option::Option<crate::types::TagFilter> {
244 self.inner.get_tag_filter()
245 }
246 /// <p>If specified, only workflow executions that match this close status are counted. This filter has an affect only if <code>executionStatus</code> is specified as <code>CLOSED</code>.</p><note>
247 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
248 /// </note>
249 pub fn close_status_filter(mut self, input: crate::types::CloseStatusFilter) -> Self {
250 self.inner = self.inner.close_status_filter(input);
251 self
252 }
253 /// <p>If specified, only workflow executions that match this close status are counted. This filter has an affect only if <code>executionStatus</code> is specified as <code>CLOSED</code>.</p><note>
254 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
255 /// </note>
256 pub fn set_close_status_filter(mut self, input: ::std::option::Option<crate::types::CloseStatusFilter>) -> Self {
257 self.inner = self.inner.set_close_status_filter(input);
258 self
259 }
260 /// <p>If specified, only workflow executions that match this close status are counted. This filter has an affect only if <code>executionStatus</code> is specified as <code>CLOSED</code>.</p><note>
261 /// <p><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p>
262 /// </note>
263 pub fn get_close_status_filter(&self) -> &::std::option::Option<crate::types::CloseStatusFilter> {
264 self.inner.get_close_status_filter()
265 }
266}