Network.AWS.StepFunctions.ListExecutions

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.

This operation returns paginated results.

Creating a Request

listExecutions

Arguments

:: Text

leStateMachineARN

-> 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 100. A value of 0 means to use the default. 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

Methods

(==) :: ListExecutions -> ListExecutions -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ListExecutions

readList :: ReadS [ListExecutions]

readPrec :: ReadPrec ListExecutions

readListPrec :: ReadPrec [ListExecutions]

Show ListExecutions

Methods

showsPrec :: Int -> ListExecutions -> ShowS

show :: ListExecutions -> String

showList :: [ListExecutions] -> ShowS

Generic ListExecutions

Associated Types

type Rep ListExecutions :: * -> *

Methods

from :: ListExecutions -> Rep ListExecutions x

to :: Rep ListExecutions x -> ListExecutions

Hashable ListExecutions

Methods

hashWithSalt :: Int -> ListExecutions -> Int

hash :: ListExecutions -> Int

ToJSON ListExecutions

Methods

toJSON :: ListExecutions -> Value

toEncoding :: ListExecutions -> Encoding

toJSONList :: [ListExecutions] -> Value

toEncodingList :: [ListExecutions] -> Encoding

NFData ListExecutions

Methods

rnf :: ListExecutions -> ()

AWSPager ListExecutions

Methods

page :: ListExecutions -> Rs ListExecutions -> Maybe ListExecutions

AWSRequest ListExecutions

Associated Types

type Rs ListExecutions :: *

Methods

request :: ListExecutions -> Request ListExecutions

response :: MonadResource m => Logger -> Service -> Proxy * ListExecutions -> ClientResponse -> m (Response ListExecutions)

ToQuery ListExecutions

Methods

toQuery :: ListExecutions -> QueryString

ToPath ListExecutions

Methods

toPath :: ListExecutions -> ByteString

ToHeaders ListExecutions

Methods

toHeaders :: ListExecutions -> [Header]

type Rep ListExecutions

type Rep ListExecutions = D1 (MetaData "ListExecutions" "Network.AWS.StepFunctions.ListExecutions" "amazonka-stepfunctions-1.5.0-72Mahrok8Tr5xIrxR72Cpm" 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

type Rs ListExecutions = ListExecutionsResponse

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 100. A value of 0 means to use the default. 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

Arguments

:: Int

lersResponseStatus

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

Methods

(==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ListExecutionsResponse

readList :: ReadS [ListExecutionsResponse]

readPrec :: ReadPrec ListExecutionsResponse

readListPrec :: ReadPrec [ListExecutionsResponse]

Show ListExecutionsResponse

Methods

showsPrec :: Int -> ListExecutionsResponse -> ShowS

show :: ListExecutionsResponse -> String

showList :: [ListExecutionsResponse] -> ShowS

Generic ListExecutionsResponse

Associated Types

type Rep ListExecutionsResponse :: * -> *

Methods

from :: ListExecutionsResponse -> Rep ListExecutionsResponse x

to :: Rep ListExecutionsResponse x -> ListExecutionsResponse

NFData ListExecutionsResponse

Methods

rnf :: ListExecutionsResponse -> ()

type Rep ListExecutionsResponse

type Rep ListExecutionsResponse = D1 (MetaData "ListExecutionsResponse" "Network.AWS.StepFunctions.ListExecutions" "amazonka-stepfunctions-1.5.0-72Mahrok8Tr5xIrxR72Cpm" False) (C1 (MetaCons "ListExecutionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.