Amazonka.SWF.ListClosedWorkflowExecutions

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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.

This operation returns paginated results.

Creating a Request

data ListClosedWorkflowExecutions

See: newListClosedWorkflowExecutions smart constructor.

Constructors

ListClosedWorkflowExecutions'

Fields

• closeStatusFilter :: Maybe CloseStatusFilter

  If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

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

• closeTimeFilter :: Maybe ExecutionTimeFilter

  If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

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

• executionFilter :: Maybe WorkflowExecutionFilter

  If specified, only workflow executions matching the workflow ID specified in the filter are returned.

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

• maximumPageSize :: Maybe Natural

  The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

• nextPageToken :: Maybe Text

  If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

  The configured maximumPageSize determines how many results can be returned in a single call.

• reverseOrder :: Maybe Bool

  When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

• startTimeFilter :: Maybe ExecutionTimeFilter

  If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

  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 the matching tag are listed.

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

• typeFilter :: Maybe WorkflowTypeFilter

  If specified, only executions of the type specified in the filter are returned.

  closeStatusFilter, 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 that contains the workflow executions to list.

Instances

ToJSON ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

toJSON :: ListClosedWorkflowExecutions -> Value

toEncoding :: ListClosedWorkflowExecutions -> Encoding

toJSONList :: [ListClosedWorkflowExecutions] -> Value

toEncodingList :: [ListClosedWorkflowExecutions] -> Encoding

ToHeaders ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

toHeaders :: ListClosedWorkflowExecutions -> [Header]

ToPath ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

toPath :: ListClosedWorkflowExecutions -> ByteString

ToQuery ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

toQuery :: ListClosedWorkflowExecutions -> QueryString

AWSPager ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

page :: ListClosedWorkflowExecutions -> AWSResponse ListClosedWorkflowExecutions -> Maybe ListClosedWorkflowExecutions

AWSRequest ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Associated Types

type AWSResponse ListClosedWorkflowExecutions

Methods

request :: (Service -> Service) -> ListClosedWorkflowExecutions -> Request ListClosedWorkflowExecutions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListClosedWorkflowExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClosedWorkflowExecutions)))

Generic ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Associated Types

type Rep ListClosedWorkflowExecutions :: Type -> Type

Methods

from :: ListClosedWorkflowExecutions -> Rep ListClosedWorkflowExecutions x

to :: Rep ListClosedWorkflowExecutions x -> ListClosedWorkflowExecutions

Read ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

readsPrec :: Int -> ReadS ListClosedWorkflowExecutions

readList :: ReadS [ListClosedWorkflowExecutions]

readPrec :: ReadPrec ListClosedWorkflowExecutions

readListPrec :: ReadPrec [ListClosedWorkflowExecutions]

Show ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

showsPrec :: Int -> ListClosedWorkflowExecutions -> ShowS

show :: ListClosedWorkflowExecutions -> String

showList :: [ListClosedWorkflowExecutions] -> ShowS

NFData ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

rnf :: ListClosedWorkflowExecutions -> ()

Eq ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

(==) :: ListClosedWorkflowExecutions -> ListClosedWorkflowExecutions -> Bool

(/=) :: ListClosedWorkflowExecutions -> ListClosedWorkflowExecutions -> Bool

Hashable ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

Methods

hashWithSalt :: Int -> ListClosedWorkflowExecutions -> Int

hash :: ListClosedWorkflowExecutions -> Int

type AWSResponse ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

type AWSResponse ListClosedWorkflowExecutions = WorkflowExecutionInfos

type Rep ListClosedWorkflowExecutions

Defined in Amazonka.SWF.ListClosedWorkflowExecutions

type Rep ListClosedWorkflowExecutions = D1 ('MetaData "ListClosedWorkflowExecutions" "Amazonka.SWF.ListClosedWorkflowExecutions" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ListClosedWorkflowExecutions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "closeStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloseStatusFilter)) :*: S1 ('MetaSel ('Just "closeTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter))) :*: (S1 ('MetaSel ('Just "executionFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter)) :*: (S1 ('MetaSel ('Just "maximumPageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "reverseOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "startTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter))) :*: (S1 ('MetaSel ('Just "tagFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagFilter)) :*: (S1 ('MetaSel ('Just "typeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter)) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newListClosedWorkflowExecutions

Arguments

:: Text

$sel:domain:ListClosedWorkflowExecutions'

-> ListClosedWorkflowExecutions

Create a value of ListClosedWorkflowExecutions 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:closeStatusFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_closeStatusFilter - If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

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

$sel:closeTimeFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_closeTimeFilter - If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

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

$sel:executionFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_executionFilter - If specified, only workflow executions matching the workflow ID specified in the filter are returned.

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

$sel:maximumPageSize:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_maximumPageSize - The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

ListClosedWorkflowExecutions, listClosedWorkflowExecutions_nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

$sel:reverseOrder:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_reverseOrder - When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

$sel:startTimeFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_startTimeFilter - If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

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

$sel:tagFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_tagFilter - If specified, only executions that have the matching tag are listed.

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

$sel:typeFilter:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_typeFilter - If specified, only executions of the type specified in the filter are returned.

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

$sel:domain:ListClosedWorkflowExecutions', listClosedWorkflowExecutions_domain - The name of the domain that contains the workflow executions to list.

Request Lenses

listClosedWorkflowExecutions_closeStatusFilter :: Lens' ListClosedWorkflowExecutions (Maybe CloseStatusFilter)

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

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

listClosedWorkflowExecutions_closeTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter)

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

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

listClosedWorkflowExecutions_executionFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowExecutionFilter)

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

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

listClosedWorkflowExecutions_maximumPageSize :: Lens' ListClosedWorkflowExecutions (Maybe Natural)

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listClosedWorkflowExecutions_nextPageToken :: Lens' ListClosedWorkflowExecutions (Maybe Text)

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listClosedWorkflowExecutions_reverseOrder :: Lens' ListClosedWorkflowExecutions (Maybe Bool)

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

listClosedWorkflowExecutions_startTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter)

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

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

listClosedWorkflowExecutions_tagFilter :: Lens' ListClosedWorkflowExecutions (Maybe TagFilter)

If specified, only executions that have the matching tag are listed.

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

listClosedWorkflowExecutions_typeFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowTypeFilter)

If specified, only executions of the type specified in the filter are returned.

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

listClosedWorkflowExecutions_domain :: Lens' ListClosedWorkflowExecutions Text

The name of the domain that contains the workflow executions to list.

Destructuring the Response

data WorkflowExecutionInfos

Contains a paginated list of information about workflow executions.

See: newWorkflowExecutionInfos smart constructor.

Constructors

WorkflowExecutionInfos'

Fields

• nextPageToken :: Maybe Text

  If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

  The configured maximumPageSize determines how many results can be returned in a single call.

• executionInfos :: [WorkflowExecutionInfo]

  The list of workflow information structures.

Instances

FromJSON WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

parseJSON :: Value -> Parser WorkflowExecutionInfos

parseJSONList :: Value -> Parser [WorkflowExecutionInfos]

Generic WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Associated Types

type Rep WorkflowExecutionInfos :: Type -> Type

Methods

from :: WorkflowExecutionInfos -> Rep WorkflowExecutionInfos x

to :: Rep WorkflowExecutionInfos x -> WorkflowExecutionInfos

Read WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

readsPrec :: Int -> ReadS WorkflowExecutionInfos

readList :: ReadS [WorkflowExecutionInfos]

readPrec :: ReadPrec WorkflowExecutionInfos

readListPrec :: ReadPrec [WorkflowExecutionInfos]

Show WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

showsPrec :: Int -> WorkflowExecutionInfos -> ShowS

show :: WorkflowExecutionInfos -> String

showList :: [WorkflowExecutionInfos] -> ShowS

NFData WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

rnf :: WorkflowExecutionInfos -> ()

Eq WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

(==) :: WorkflowExecutionInfos -> WorkflowExecutionInfos -> Bool

(/=) :: WorkflowExecutionInfos -> WorkflowExecutionInfos -> Bool

Hashable WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

Methods

hashWithSalt :: Int -> WorkflowExecutionInfos -> Int

hash :: WorkflowExecutionInfos -> Int

type Rep WorkflowExecutionInfos

Defined in Amazonka.SWF.Types.WorkflowExecutionInfos

type Rep WorkflowExecutionInfos = D1 ('MetaData "WorkflowExecutionInfos" "Amazonka.SWF.Types.WorkflowExecutionInfos" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "WorkflowExecutionInfos'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkflowExecutionInfo])))

newWorkflowExecutionInfos :: WorkflowExecutionInfos

Create a value of WorkflowExecutionInfos 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:nextPageToken:WorkflowExecutionInfos', workflowExecutionInfos_nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

$sel:executionInfos:WorkflowExecutionInfos', workflowExecutionInfos_executionInfos - The list of workflow information structures.

Response Lenses

workflowExecutionInfos_nextPageToken :: Lens' WorkflowExecutionInfos (Maybe Text)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

workflowExecutionInfos_executionInfos :: Lens' WorkflowExecutionInfos [WorkflowExecutionInfo]

The list of workflow information structures.