Struct aws_sdk_swf::client::fluent_builders::CountOpenWorkflowExecutions

pub struct CountOpenWorkflowExecutions<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CountOpenWorkflowExecutions.

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

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 cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Implementations

impl<C, M, R> CountOpenWorkflowExecutions<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CountOpenWorkflowExecutionsOutput, SdkError<CountOpenWorkflowExecutionsError>> where
    R::Policy: SmithyRetryPolicy<CountOpenWorkflowExecutionsInputOperationOutputAlias, CountOpenWorkflowExecutionsOutput, CountOpenWorkflowExecutionsError, CountOpenWorkflowExecutionsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn domain(self, inp: impl Into<String>) -> Self

The name of the domain containing the workflow executions to count.

pub fn set_domain(self, input: Option<String>) -> Self

The name of the domain containing the workflow executions to count.

pub fn start_time_filter(self, inp: ExecutionTimeFilter) -> Self

Specifies the start time criteria that workflow executions must meet in order to be counted.

pub fn set_start_time_filter(self, input: Option<ExecutionTimeFilter>) -> Self

Specifies the start time criteria that workflow executions must meet in order to be counted.

pub fn type_filter(self, inp: WorkflowTypeFilter) -> Self

Specifies the type of the workflow executions to be counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn set_type_filter(self, input: Option<WorkflowTypeFilter>) -> Self

Specifies the type of the workflow executions to be counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn tag_filter(self, inp: TagFilter) -> Self

If specified, only executions that have a tag that matches the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn set_tag_filter(self, input: Option<TagFilter>) -> Self

If specified, only executions that have a tag that matches the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn execution_filter(self, inp: WorkflowExecutionFilter) -> Self

If specified, only workflow executions matching the WorkflowId in the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn set_execution_filter(
    self,
    input: Option<WorkflowExecutionFilter>
) -> Self

If specified, only workflow executions matching the WorkflowId in the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CountOpenWorkflowExecutions<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.