AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CountOpenWorkflowExecutions operation. 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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleWorkflow.AmazonSimpleWorkflowRequest
      Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest

Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z

Syntax

C#
public class CountOpenWorkflowExecutionsRequest : AmazonSimpleWorkflowRequest
         IAmazonWebServiceRequest

The CountOpenWorkflowExecutionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Domain System.String

Gets and sets the property Domain.

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

Public Property ExecutionFilter Amazon.SimpleWorkflow.Model.WorkflowExecutionFilter

Gets and sets the property ExecutionFilter.

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.

Public Property StartTimeFilter Amazon.SimpleWorkflow.Model.ExecutionTimeFilter

Gets and sets the property StartTimeFilter.

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

Public Property TagFilter Amazon.SimpleWorkflow.Model.TagFilter

Gets and sets the property TagFilter.

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.

Public Property TypeFilter Amazon.SimpleWorkflow.Model.WorkflowTypeFilter

Gets and sets the property TypeFilter.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5