aws_sdk_swf/client/
count_open_workflow_executions.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 [`CountOpenWorkflowExecutions`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain(impl Into<String>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain containing the workflow executions to count.</p><br>
7    ///   - [`start_time_filter(ExecutionTimeFilter)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::start_time_filter) / [`set_start_time_filter(Option<ExecutionTimeFilter>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::set_start_time_filter):<br>required: **true**<br><p>Specifies the start time criteria that workflow executions must meet in order to be counted.</p><br>
8    ///   - [`type_filter(WorkflowTypeFilter)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::type_filter) / [`set_type_filter(Option<WorkflowTypeFilter>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::set_type_filter):<br>required: **false**<br><p>Specifies the type of the workflow executions to be counted.</p><note>  <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> </note><br>
9    ///   - [`tag_filter(TagFilter)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::tag_filter) / [`set_tag_filter(Option<TagFilter>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::set_tag_filter):<br>required: **false**<br><p>If specified, only executions that have a tag that matches the filter are counted.</p><note>  <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> </note><br>
10    ///   - [`execution_filter(WorkflowExecutionFilter)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::execution_filter) / [`set_execution_filter(Option<WorkflowExecutionFilter>)`](crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::set_execution_filter):<br>required: **false**<br><p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p><note>  <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> </note><br>
11    /// - On success, responds with [`CountOpenWorkflowExecutionsOutput`](crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsOutput) with field(s):
12    ///   - [`count(i32)`](crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsOutput::count): <p>The number of workflow executions.</p>
13    ///   - [`truncated(bool)`](crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsOutput::truncated): <p>If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.</p>
14    /// - On failure, responds with [`SdkError<CountOpenWorkflowExecutionsError>`](crate::operation::count_open_workflow_executions::CountOpenWorkflowExecutionsError)
15    pub fn count_open_workflow_executions(
16        &self,
17    ) -> crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder {
18        crate::operation::count_open_workflow_executions::builders::CountOpenWorkflowExecutionsFluentBuilder::new(self.handle.clone())
19    }
20}