Network.AWS.SWF.CountClosedWorkflowExecutions

Returns the number of closed 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: AWS API Reference for CountClosedWorkflowExecutions.

Creating a Request

countClosedWorkflowExecutions

Arguments

:: Text

ccweDomain

-> CountClosedWorkflowExecutions

Creates a value of CountClosedWorkflowExecutions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccweExecutionFilter
• ccweCloseStatusFilter
• ccweTypeFilter
• ccweCloseTimeFilter
• ccweTagFilter
• ccweStartTimeFilter
• ccweDomain

data CountClosedWorkflowExecutions

See: countClosedWorkflowExecutions smart constructor.

Instances

Eq CountClosedWorkflowExecutions

Data CountClosedWorkflowExecutions

Read CountClosedWorkflowExecutions

Show CountClosedWorkflowExecutions

Generic CountClosedWorkflowExecutions

ToJSON CountClosedWorkflowExecutions

AWSRequest CountClosedWorkflowExecutions

ToPath CountClosedWorkflowExecutions

ToHeaders CountClosedWorkflowExecutions

ToQuery CountClosedWorkflowExecutions

type Rep CountClosedWorkflowExecutions

type Rs CountClosedWorkflowExecutions = WorkflowExecutionCount

Request Lenses

ccweExecutionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter)

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

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

ccweCloseStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe 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.

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

ccweTypeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter)

If specified, indicates the type of the workflow executions to be counted.

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

ccweCloseTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter)

If specified, only workflow executions that meet the close time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

ccweTagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter)

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

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

ccweStartTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter)

If specified, only workflow executions that meet the start time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

ccweDomain :: Lens' CountClosedWorkflowExecutions Text

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

Destructuring the Response

workflowExecutionCount

Arguments

:: Natural

wecCount

-> WorkflowExecutionCount

Creates a value of WorkflowExecutionCount with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wecTruncated
• wecCount

data WorkflowExecutionCount

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

See: workflowExecutionCount smart constructor.

Instances

Eq WorkflowExecutionCount

Data WorkflowExecutionCount

Read WorkflowExecutionCount

Show WorkflowExecutionCount

Generic WorkflowExecutionCount

FromJSON WorkflowExecutionCount

type Rep WorkflowExecutionCount

Response Lenses

wecTruncated :: Lens' WorkflowExecutionCount (Maybe Bool)

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.

wecCount :: Lens' WorkflowExecutionCount Natural

The number of workflow executions.