libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SWF.CountOpenWorkflowExecutions

Description

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.

Synopsis

Creating a Request

data CountOpenWorkflowExecutions Source #

See: newCountOpenWorkflowExecutions smart constructor.

Constructors

CountOpenWorkflowExecutions' 

Fields

  • executionFilter :: Maybe WorkflowExecutionFilter

    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.

  • typeFilter :: Maybe WorkflowTypeFilter

    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.

  • tagFilter :: Maybe 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.

  • domain :: Text

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

  • startTimeFilter :: ExecutionTimeFilter

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

Instances

Instances details
Eq CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

(==) :: CountOpenWorkflowExecutions -> CountOpenWorkflowExecutions -> Bool #

(/=) :: CountOpenWorkflowExecutions -> CountOpenWorkflowExecutions -> Bool #

Read CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

readsPrec :: Int -> ReadS CountOpenWorkflowExecutions #

readList :: ReadS [CountOpenWorkflowExecutions] #

readPrec :: ReadPrec CountOpenWorkflowExecutions #

readListPrec :: ReadPrec [CountOpenWorkflowExecutions] #

Show CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

showsPrec :: Int -> CountOpenWorkflowExecutions -> ShowS #

show :: CountOpenWorkflowExecutions -> String #

showList :: [CountOpenWorkflowExecutions] -> ShowS #

Generic CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Associated Types

type Rep CountOpenWorkflowExecutions :: Type -> Type #

Methods

from :: CountOpenWorkflowExecutions -> Rep CountOpenWorkflowExecutions x #

to :: Rep CountOpenWorkflowExecutions x -> CountOpenWorkflowExecutions #

NFData CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

rnf :: CountOpenWorkflowExecutions -> () #

Hashable CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

hashWithSalt :: Int -> CountOpenWorkflowExecutions -> Int #

hash :: CountOpenWorkflowExecutions -> Int #

ToJSON CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

toJSON :: CountOpenWorkflowExecutions -> Value #

toEncoding :: CountOpenWorkflowExecutions -> Encoding #

toJSONList :: [CountOpenWorkflowExecutions] -> Value #

toEncodingList :: [CountOpenWorkflowExecutions] -> Encoding #

AWSRequest CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Associated Types

type AWSResponse CountOpenWorkflowExecutions #

Methods

request :: CountOpenWorkflowExecutions -> Request CountOpenWorkflowExecutions #

response :: MonadResource m => Logger -> Service -> Proxy CountOpenWorkflowExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CountOpenWorkflowExecutions))) #

ToHeaders CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

toHeaders :: CountOpenWorkflowExecutions -> [Header] #

ToPath CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

toPath :: CountOpenWorkflowExecutions -> ByteString #

ToQuery CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

Methods

toQuery :: CountOpenWorkflowExecutions -> QueryString #

type Rep CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

type Rep CountOpenWorkflowExecutions = D1 ('MetaData "CountOpenWorkflowExecutions" "Amazonka.SWF.CountOpenWorkflowExecutions" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "CountOpenWorkflowExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter)) :*: S1 ('MetaSel ('Just "typeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter))) :*: (S1 ('MetaSel ('Just "tagFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagFilter)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionTimeFilter)))))
type AWSResponse CountOpenWorkflowExecutions Source # 
Instance details

Defined in Amazonka.SWF.CountOpenWorkflowExecutions

type AWSResponse CountOpenWorkflowExecutions = WorkflowExecutionCount

newCountOpenWorkflowExecutions Source #

Arguments

:: Text

$sel:domain:CountOpenWorkflowExecutions'

-> ExecutionTimeFilter

$sel:startTimeFilter:CountOpenWorkflowExecutions'

-> CountOpenWorkflowExecutions 

Create a value of CountOpenWorkflowExecutions 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:CountOpenWorkflowExecutions', countOpenWorkflowExecutions_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.

$sel:typeFilter:CountOpenWorkflowExecutions', countOpenWorkflowExecutions_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.

$sel:tagFilter:CountOpenWorkflowExecutions', countOpenWorkflowExecutions_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.

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

$sel:startTimeFilter:CountOpenWorkflowExecutions', countOpenWorkflowExecutions_startTimeFilter - Specifies the start time criteria that workflow executions must meet in order to be counted.

Request Lenses

countOpenWorkflowExecutions_executionFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

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.

countOpenWorkflowExecutions_typeFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

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.

countOpenWorkflowExecutions_tagFilter :: Lens' CountOpenWorkflowExecutions (Maybe TagFilter) Source #

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.

countOpenWorkflowExecutions_domain :: Lens' CountOpenWorkflowExecutions Text Source #

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

countOpenWorkflowExecutions_startTimeFilter :: Lens' CountOpenWorkflowExecutions ExecutionTimeFilter Source #

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

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.