amazonka-stepfunctions-1.4.5: Amazon Step Functions SDK.

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

Network.AWS.StepFunctions.ListExecutions

Contents

Description

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.

Synopsis

Creating a Request

listExecutions #

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

See: listExecutions smart constructor.

Instances

Eq ListExecutions # 
Data ListExecutions # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListExecutions -> c ListExecutions #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListExecutions #

toConstr :: ListExecutions -> Constr #

dataTypeOf :: ListExecutions -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListExecutions) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListExecutions) #

gmapT :: (forall b. Data b => b -> b) -> ListExecutions -> ListExecutions #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListExecutions -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListExecutions -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListExecutions -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListExecutions -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListExecutions -> m ListExecutions #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListExecutions -> m ListExecutions #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListExecutions -> m ListExecutions #

Read ListExecutions # 
Show ListExecutions # 
Generic ListExecutions # 

Associated Types

type Rep ListExecutions :: * -> * #

Hashable ListExecutions # 
ToJSON ListExecutions # 
NFData ListExecutions # 

Methods

rnf :: ListExecutions -> () #

AWSRequest ListExecutions # 
ToQuery ListExecutions # 
ToPath ListExecutions # 
ToHeaders ListExecutions # 
type Rep ListExecutions # 
type Rep ListExecutions = D1 (MetaData "ListExecutions" "Network.AWS.StepFunctions.ListExecutions" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" False) (C1 (MetaCons "ListExecutions'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_leStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionStatus))) (S1 (MetaSel (Just Symbol "_leNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_leMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_leStateMachineARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListExecutions # 

Request Lenses

leStatusFilter :: Lens' ListExecutions (Maybe ExecutionStatus) #

If specified, only list the executions whose current execution status matches the given filter.

leNextToken :: Lens' ListExecutions (Maybe Text) #

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) #

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 #

The Amazon Resource Name (ARN) of the state machine whose executions will be listed.

Destructuring the Response

listExecutionsResponse #

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 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 - -- | The response status code.
  • lersExecutions - The list of matching executions.

data ListExecutionsResponse #

See: listExecutionsResponse smart constructor.

Instances

Eq ListExecutionsResponse # 
Data ListExecutionsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListExecutionsResponse -> c ListExecutionsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListExecutionsResponse #

toConstr :: ListExecutionsResponse -> Constr #

dataTypeOf :: ListExecutionsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListExecutionsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListExecutionsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListExecutionsResponse -> ListExecutionsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListExecutionsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListExecutionsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListExecutionsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListExecutionsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListExecutionsResponse -> m ListExecutionsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListExecutionsResponse -> m ListExecutionsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListExecutionsResponse -> m ListExecutionsResponse #

Read ListExecutionsResponse # 
Show ListExecutionsResponse # 
Generic ListExecutionsResponse # 
NFData ListExecutionsResponse # 

Methods

rnf :: ListExecutionsResponse -> () #

type Rep ListExecutionsResponse # 
type Rep ListExecutionsResponse = D1 (MetaData "ListExecutionsResponse" "Network.AWS.StepFunctions.ListExecutions" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" False) (C1 (MetaCons "ListExecutionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lersExecutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ExecutionListItem])))))

Response Lenses

lersNextToken :: Lens' ListExecutionsResponse (Maybe Text) #

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 #

  • - | The response status code.

lersExecutions :: Lens' ListExecutionsResponse [ExecutionListItem] #

The list of matching executions.