countClosedWorkflowExecutions method
- required String domain,
- CloseStatusFilter? closeStatusFilter,
- ExecutionTimeFilter? closeTimeFilter,
- WorkflowExecutionFilter? executionFilter,
- ExecutionTimeFilter? startTimeFilter,
- TagFilter? tagFilter,
- WorkflowTypeFilter? typeFilter,
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. 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 isswf:tagFilter.tag
. -
typeFilter.name
: String constraint. The key isswf:typeFilter.name
. -
typeFilter.version
: String constraint. The key isswf:typeFilter.version
.
-
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.
May throw UnknownResourceFault. May throw OperationNotPermittedFault.
Parameter domain
:
The name of the domain containing the workflow executions to count.
Parameter closeStatusFilter
:
If specified, only workflow executions that match this close status are
counted. This filter has an affect only if executionStatus
is
specified as CLOSED
.
Parameter closeTimeFilter
:
If specified, only workflow executions that meet the close time criteria
of the filter are counted.
Parameter executionFilter
:
If specified, only workflow executions matching the
WorkflowId
in the filter are counted.
Parameter startTimeFilter
:
If specified, only workflow executions that meet the start time criteria
of the filter are counted.
Parameter tagFilter
:
If specified, only executions that have a tag that matches the filter are
counted.
Parameter typeFilter
:
If specified, indicates the type of the workflow executions to be counted.
Implementation
Future<WorkflowExecutionCount> countClosedWorkflowExecutions({
required String domain,
CloseStatusFilter? closeStatusFilter,
ExecutionTimeFilter? closeTimeFilter,
WorkflowExecutionFilter? executionFilter,
ExecutionTimeFilter? startTimeFilter,
TagFilter? tagFilter,
WorkflowTypeFilter? typeFilter,
}) async {
ArgumentError.checkNotNull(domain, 'domain');
_s.validateStringLength(
'domain',
domain,
1,
256,
isRequired: true,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.0',
'X-Amz-Target': 'SimpleWorkflowService.CountClosedWorkflowExecutions'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'domain': domain,
if (closeStatusFilter != null) 'closeStatusFilter': closeStatusFilter,
if (closeTimeFilter != null) 'closeTimeFilter': closeTimeFilter,
if (executionFilter != null) 'executionFilter': executionFilter,
if (startTimeFilter != null) 'startTimeFilter': startTimeFilter,
if (tagFilter != null) 'tagFilter': tagFilter,
if (typeFilter != null) 'typeFilter': typeFilter,
},
);
return WorkflowExecutionCount.fromJson(jsonResponse.body);
}