Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken
returned by the previous call.
- listExecutions :: Text -> ListExecutions
- data ListExecutions
- leStatusFilter :: Lens' ListExecutions (Maybe ExecutionStatus)
- leNextToken :: Lens' ListExecutions (Maybe Text)
- leMaxResults :: Lens' ListExecutions (Maybe Natural)
- leStateMachineARN :: Lens' ListExecutions Text
- listExecutionsResponse :: Int -> ListExecutionsResponse
- data ListExecutionsResponse
- lersNextToken :: Lens' ListExecutionsResponse (Maybe Text)
- lersResponseStatus :: Lens' ListExecutionsResponse Int
- lersExecutions :: Lens' ListExecutionsResponse [ExecutionListItem]
Creating a Request
Creates a value of ListExecutions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leStatusFilter
- If specified, only list the executions whose current execution status matches the given filter.leNextToken
- If anextToken
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 innextToken
. Keep all other arguments unchanged. The configuredmaxResults
determines how many results can be returned in a single call.leMaxResults
- The maximum number of results that will be returned per call.nextToken
can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.leStateMachineARN
- The Amazon Resource Name (ARN) of the state machine whose executions will be listed.
data ListExecutions Source #
See: listExecutions
smart constructor.
Request Lenses
leStatusFilter :: Lens' ListExecutions (Maybe ExecutionStatus) Source #
If specified, only list the executions whose current execution status matches the given filter.
leNextToken :: Lens' ListExecutions (Maybe Text) Source #
If a nextToken
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 nextToken
. Keep all other arguments unchanged. The configured maxResults
determines how many results can be returned in a single call.
leMaxResults :: Lens' ListExecutions (Maybe Natural) Source #
The maximum number of results that will be returned per call. nextToken
can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
leStateMachineARN :: Lens' ListExecutions Text Source #
The Amazon Resource Name (ARN) of the state machine whose executions will be listed.
Destructuring the Response
listExecutionsResponse Source #
Creates a value of ListExecutionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lersNextToken
- If anextToken
is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token innextToken
. Keep all other arguments unchanged. The configuredmaxResults
determines how many results can be returned in a single call.lersResponseStatus
- -- | The response status code.lersExecutions
- The list of matching executions.
data ListExecutionsResponse Source #
See: listExecutionsResponse
smart constructor.
Response Lenses
lersNextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #
If a nextToken
is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken
. Keep all other arguments unchanged. The configured maxResults
determines how many results can be returned in a single call.
lersResponseStatus :: Lens' ListExecutionsResponse Int Source #
- - | The response status code.
lersExecutions :: Lens' ListExecutionsResponse [ExecutionListItem] Source #
The list of matching executions.