aws_sdk_swf/operation/count_open_workflow_executions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::count_open_workflow_executions::_count_open_workflow_executions_output::CountOpenWorkflowExecutionsOutputBuilder;
3
4pub use crate::operation::count_open_workflow_executions::_count_open_workflow_executions_input::CountOpenWorkflowExecutionsInputBuilder;
5
6impl crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsInputBuilder {
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_open_workflow_executions::CountOpenWorkflowExecutionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.count_open_workflow_executions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CountOpenWorkflowExecutions`.
24///
25/// <p>Returns the number of open 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 CountOpenWorkflowExecutionsFluentBuilder {
49    handle: ::std::sync::Arc<crate::client::Handle>,
50    inner: crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsInputBuilder,
51    config_override: ::std::option::Option<crate::config::Builder>,
52}
53impl
54    crate::client::customize::internal::CustomizableSend<
55        crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsOutput,
56        crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError,
57    > for CountOpenWorkflowExecutionsFluentBuilder
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_open_workflow_executions::CountOpenWorkflowExecutionsOutput,
65            crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError,
66        >,
67    > {
68        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
69    }
70}
71impl CountOpenWorkflowExecutionsFluentBuilder {
72    /// Creates a new `CountOpenWorkflowExecutionsFluentBuilder`.
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 CountOpenWorkflowExecutions as a reference.
81    pub fn as_input(&self) -> &crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsInputBuilder {
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_open_workflow_executions::CountOpenWorkflowExecutionsOutput,
96        ::aws_smithy_runtime_api::client::result::SdkError<
97            crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError,
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_open_workflow_executions::CountOpenWorkflowExecutions::operation_runtime_plugins(
106            self.handle.runtime_plugins.clone(),
107            &self.handle.conf,
108            self.config_override,
109        );
110        crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutions::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_open_workflow_executions::CountOpenWorkflowExecutionsOutput,
118        crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError,
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>Specifies the start time criteria that workflow executions must meet in order to be counted.</p>
147    pub fn start_time_filter(mut self, input: crate::types::ExecutionTimeFilter) -> Self {
148        self.inner = self.inner.start_time_filter(input);
149        self
150    }
151    /// <p>Specifies the start time criteria that workflow executions must meet in order to be counted.</p>
152    pub fn set_start_time_filter(mut self, input: ::std::option::Option<crate::types::ExecutionTimeFilter>) -> Self {
153        self.inner = self.inner.set_start_time_filter(input);
154        self
155    }
156    /// <p>Specifies the start time criteria that workflow executions must meet in order to be counted.</p>
157    pub fn get_start_time_filter(&self) -> &::std::option::Option<crate::types::ExecutionTimeFilter> {
158        self.inner.get_start_time_filter()
159    }
160    /// <p>Specifies the type of the workflow executions to be counted.</p><note>
161    /// <p><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>
162    /// </note>
163    pub fn type_filter(mut self, input: crate::types::WorkflowTypeFilter) -> Self {
164        self.inner = self.inner.type_filter(input);
165        self
166    }
167    /// <p>Specifies the type of the workflow executions to be counted.</p><note>
168    /// <p><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>
169    /// </note>
170    pub fn set_type_filter(mut self, input: ::std::option::Option<crate::types::WorkflowTypeFilter>) -> Self {
171        self.inner = self.inner.set_type_filter(input);
172        self
173    }
174    /// <p>Specifies the type of the workflow executions to be counted.</p><note>
175    /// <p><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>
176    /// </note>
177    pub fn get_type_filter(&self) -> &::std::option::Option<crate::types::WorkflowTypeFilter> {
178        self.inner.get_type_filter()
179    }
180    /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
181    /// <p><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>
182    /// </note>
183    pub fn tag_filter(mut self, input: crate::types::TagFilter) -> Self {
184        self.inner = self.inner.tag_filter(input);
185        self
186    }
187    /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
188    /// <p><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>
189    /// </note>
190    pub fn set_tag_filter(mut self, input: ::std::option::Option<crate::types::TagFilter>) -> Self {
191        self.inner = self.inner.set_tag_filter(input);
192        self
193    }
194    /// <p>If specified, only executions that have a tag that matches the filter are counted.</p><note>
195    /// <p><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>
196    /// </note>
197    pub fn get_tag_filter(&self) -> &::std::option::Option<crate::types::TagFilter> {
198        self.inner.get_tag_filter()
199    }
200    /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
201    /// <p><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 execution_filter(mut self, input: crate::types::WorkflowExecutionFilter) -> Self {
204        self.inner = self.inner.execution_filter(input);
205        self
206    }
207    /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
208    /// <p><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>
209    /// </note>
210    pub fn set_execution_filter(mut self, input: ::std::option::Option<crate::types::WorkflowExecutionFilter>) -> Self {
211        self.inner = self.inner.set_execution_filter(input);
212        self
213    }
214    /// <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>
215    /// <p><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>
216    /// </note>
217    pub fn get_execution_filter(&self) -> &::std::option::Option<crate::types::WorkflowExecutionFilter> {
218        self.inner.get_execution_filter()
219    }
220}