COUNTOPENWORKFLOWEXECUTIONS()`¶

About 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.

Method Signature¶

METHODS /AWS1/IF_SWF~COUNTOPENWORKFLOWEXECUTIONS
  IMPORTING
    !IV_DOMAIN TYPE /AWS1/SWFDOMAINNAME OPTIONAL
    !IO_STARTTIMEFILTER TYPE REF TO /AWS1/CL_SWFEXECTIMEFILTER OPTIONAL
    !IO_TYPEFILTER TYPE REF TO /AWS1/CL_SWFWORKFLOWTYPEFILTER OPTIONAL
    !IO_TAGFILTER TYPE REF TO /AWS1/CL_SWFTAGFILTER OPTIONAL
    !IO_EXECUTIONFILTER TYPE REF TO /AWS1/CL_SWFWORKFLOWEXECFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_swfworkflowexeccount
  RAISING
    /AWS1/CX_SWFOPNOTPERMITTEDFA00
    /AWS1/CX_SWFUNKNOWNRESRCFAULT
    /AWS1/CX_SWFCLIENTEXC
    /AWS1/CX_SWFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domain` `TYPE /AWS1/SWFDOMAINNAME` `/AWS1/SWFDOMAINNAME`¶

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

`io_starttimefilter` `TYPE REF TO /AWS1/CL_SWFEXECTIMEFILTER` `/AWS1/CL_SWFEXECTIMEFILTER`¶

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

Optional arguments:¶

`io_typefilter` `TYPE REF TO /AWS1/CL_SWFWORKFLOWTYPEFILTER` `/AWS1/CL_SWFWORKFLOWTYPEFILTER`¶

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.

`io_tagfilter` `TYPE REF TO /AWS1/CL_SWFTAGFILTER` `/AWS1/CL_SWFTAGFILTER`¶

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.

`io_executionfilter` `TYPE REF TO /AWS1/CL_SWFWORKFLOWEXECFILTER` `/AWS1/CL_SWFWORKFLOWEXECFILTER`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_swfworkflowexeccount` `/AWS1/CL_SWFWORKFLOWEXECCOUNT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->countopenworkflowexecutions(
  io_executionfilter = new /aws1/cl_swfworkflowexecfilter( |string| )
  io_starttimefilter = new /aws1/cl_swfexectimefilter(
    iv_latestdate = '20150101000000.0000000'
    iv_oldestdate = '20150101000000.0000000'
  )
  io_tagfilter = new /aws1/cl_swftagfilter( |string| )
  io_typefilter = new /aws1/cl_swfworkflowtypefilter(
    iv_name = |string|
    iv_version = |string|
  )
  iv_domain = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_count = lo_result->get_count( ).
  lv_truncated = lo_result->get_truncated( ).
ENDIF.

/AWS1/IF_SWF=>COUNTOPENWORKFLOWEXECUTIONS()¶