Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SWF.CountClosedWorkflowExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data CountClosedWorkflowExecutions Source #

See: newCountClosedWorkflowExecutions smart constructor.

Constructors

CountClosedWorkflowExecutions'

Fields

executionFilter :: 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.
closeStatusFilter :: 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.
typeFilter :: 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.
closeTimeFilter :: 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.
tagFilter :: 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.
startTimeFilter :: 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.
domain :: Text
The name of the domain containing the workflow executions to count.

Instances

Instances details

Eq CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods (==) :: CountClosedWorkflowExecutions -> CountClosedWorkflowExecutions -> Bool # (/=) :: CountClosedWorkflowExecutions -> CountClosedWorkflowExecutions -> Bool #
Read CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods readsPrec :: Int -> ReadS CountClosedWorkflowExecutions # readList :: ReadS [CountClosedWorkflowExecutions] # readPrec :: ReadPrec CountClosedWorkflowExecutions # readListPrec :: ReadPrec [CountClosedWorkflowExecutions] #
Show CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods showsPrec :: Int -> CountClosedWorkflowExecutions -> ShowS # show :: CountClosedWorkflowExecutions -> String # showList :: [CountClosedWorkflowExecutions] -> ShowS #
Generic CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Associated Types type Rep CountClosedWorkflowExecutions :: Type -> Type # Methods from :: CountClosedWorkflowExecutions -> Rep CountClosedWorkflowExecutions x # to :: Rep CountClosedWorkflowExecutions x -> CountClosedWorkflowExecutions #
NFData CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods rnf :: CountClosedWorkflowExecutions -> () #
Hashable CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods hashWithSalt :: Int -> CountClosedWorkflowExecutions -> Int # hash :: CountClosedWorkflowExecutions -> Int #
ToJSON CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods toJSON :: CountClosedWorkflowExecutions -> Value # toEncoding :: CountClosedWorkflowExecutions -> Encoding # toJSONList :: [CountClosedWorkflowExecutions] -> Value # toEncodingList :: [CountClosedWorkflowExecutions] -> Encoding #
AWSRequest CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Associated Types type AWSResponse CountClosedWorkflowExecutions # Methods request :: CountClosedWorkflowExecutions -> Request CountClosedWorkflowExecutions # response :: MonadResource m => Logger -> Service -> Proxy CountClosedWorkflowExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CountClosedWorkflowExecutions))) #
ToHeaders CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods toHeaders :: CountClosedWorkflowExecutions -> [Header] #
ToPath CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods toPath :: CountClosedWorkflowExecutions -> ByteString #
ToQuery CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions Methods toQuery :: CountClosedWorkflowExecutions -> QueryString #
type Rep CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions type Rep CountClosedWorkflowExecutions = D1 ('MetaData "CountClosedWorkflowExecutions" "Amazonka.SWF.CountClosedWorkflowExecutions" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "CountClosedWorkflowExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter)) :: (S1 ('MetaSel ('Just "closeStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloseStatusFilter)) :: S1 ('MetaSel ('Just "typeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter)))) :: ((S1 ('MetaSel ('Just "closeTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter)) :: S1 ('MetaSel ('Just "tagFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagFilter))) :: (S1 ('MetaSel ('Just "startTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter)) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CountClosedWorkflowExecutions Source #
Instance details Defined in Amazonka.SWF.CountClosedWorkflowExecutions type AWSResponse CountClosedWorkflowExecutions = WorkflowExecutionCount

newCountClosedWorkflowExecutions Source #

Arguments

:: Text	`$sel:domain:CountClosedWorkflowExecutions'`
-> CountClosedWorkflowExecutions

Create a value of CountClosedWorkflowExecutions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:executionFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_executionFilter - 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.

$sel:closeStatusFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_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.

$sel:typeFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_typeFilter - 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.

$sel:closeTimeFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_closeTimeFilter - 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.

$sel:tagFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_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.

$sel:startTimeFilter:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_startTimeFilter - 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.

$sel:domain:CountClosedWorkflowExecutions', countClosedWorkflowExecutions_domain - The name of the domain containing the workflow executions to count.

Request Lenses

countClosedWorkflowExecutions_executionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

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.

countClosedWorkflowExecutions_closeStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe CloseStatusFilter) Source #

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.

countClosedWorkflowExecutions_typeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

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.

countClosedWorkflowExecutions_closeTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

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.

countClosedWorkflowExecutions_tagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter) Source #

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.

countClosedWorkflowExecutions_startTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

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.

countClosedWorkflowExecutions_domain :: Lens' CountClosedWorkflowExecutions Text Source #

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

Destructuring the Response

data WorkflowExecutionCount Source #

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

See: newWorkflowExecutionCount smart constructor.

Constructors

WorkflowExecutionCount'
Fields truncated :: 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. count :: Natural The number of workflow executions.

Instances

Instances details

Eq WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods (==) :: WorkflowExecutionCount -> WorkflowExecutionCount -> Bool # (/=) :: WorkflowExecutionCount -> WorkflowExecutionCount -> Bool #
Read WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods readsPrec :: Int -> ReadS WorkflowExecutionCount # readList :: ReadS [WorkflowExecutionCount] # readPrec :: ReadPrec WorkflowExecutionCount # readListPrec :: ReadPrec [WorkflowExecutionCount] #
Show WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods showsPrec :: Int -> WorkflowExecutionCount -> ShowS # show :: WorkflowExecutionCount -> String # showList :: [WorkflowExecutionCount] -> ShowS #
Generic WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Associated Types type Rep WorkflowExecutionCount :: Type -> Type # Methods from :: WorkflowExecutionCount -> Rep WorkflowExecutionCount x # to :: Rep WorkflowExecutionCount x -> WorkflowExecutionCount #
NFData WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods rnf :: WorkflowExecutionCount -> () #
Hashable WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods hashWithSalt :: Int -> WorkflowExecutionCount -> Int # hash :: WorkflowExecutionCount -> Int #
FromJSON WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount Methods parseJSON :: Value -> Parser WorkflowExecutionCount # parseJSONList :: Value -> Parser [WorkflowExecutionCount] #
type Rep WorkflowExecutionCount Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionCount type Rep WorkflowExecutionCount = D1 ('MetaData "WorkflowExecutionCount" "Amazonka.SWF.Types.WorkflowExecutionCount" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "WorkflowExecutionCount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newWorkflowExecutionCount Source #

Arguments

:: Natural	`$sel:count:WorkflowExecutionCount'`
-> WorkflowExecutionCount

Create a value of WorkflowExecutionCount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:truncated:WorkflowExecutionCount', workflowExecutionCount_truncated - 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.

$sel:count:WorkflowExecutionCount', workflowExecutionCount_count - The number of workflow executions.

Response Lenses

workflowExecutionCount_truncated :: Lens' WorkflowExecutionCount (Maybe Bool) Source #

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.

workflowExecutionCount_count :: Lens' WorkflowExecutionCount Natural Source #

The number of workflow executions.