Copyright	(c) 2013-2017 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.StepFunctions.ListStateMachines

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the existing state machines. 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

listStateMachines :: ListStateMachines Source #

Creates a value of ListStateMachines with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lsmNextToken - 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.
lsmMaxResults - 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.

data ListStateMachines Source #

See: listStateMachines smart constructor.

Instances

Eq ListStateMachines Source #
Methods (==) :: ListStateMachines -> ListStateMachines -> Bool # (/=) :: ListStateMachines -> ListStateMachines -> Bool #
Data ListStateMachines Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListStateMachines -> c ListStateMachines # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListStateMachines # toConstr :: ListStateMachines -> Constr # dataTypeOf :: ListStateMachines -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListStateMachines) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListStateMachines) # gmapT :: (forall b. Data b => b -> b) -> ListStateMachines -> ListStateMachines # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListStateMachines -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListStateMachines -> r # gmapQ :: (forall d. Data d => d -> u) -> ListStateMachines -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListStateMachines -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListStateMachines -> m ListStateMachines # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStateMachines -> m ListStateMachines # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStateMachines -> m ListStateMachines #
Read ListStateMachines Source #
Methods readsPrec :: Int -> ReadS ListStateMachines # readList :: ReadS [ListStateMachines] # readPrec :: ReadPrec ListStateMachines # readListPrec :: ReadPrec [ListStateMachines] #
Show ListStateMachines Source #
Methods showsPrec :: Int -> ListStateMachines -> ShowS # show :: ListStateMachines -> String # showList :: [ListStateMachines] -> ShowS #
Generic ListStateMachines Source #
Associated Types type Rep ListStateMachines :: * -> * # Methods from :: ListStateMachines -> Rep ListStateMachines x # to :: Rep ListStateMachines x -> ListStateMachines #
Hashable ListStateMachines Source #
Methods hashWithSalt :: Int -> ListStateMachines -> Int # hash :: ListStateMachines -> Int #
ToJSON ListStateMachines Source #
Methods toJSON :: ListStateMachines -> Value # toEncoding :: ListStateMachines -> Encoding # toJSONList :: [ListStateMachines] -> Value # toEncodingList :: [ListStateMachines] -> Encoding #
NFData ListStateMachines Source #
Methods rnf :: ListStateMachines -> () #
AWSPager ListStateMachines Source #
Methods page :: ListStateMachines -> Rs ListStateMachines -> Maybe ListStateMachines #
AWSRequest ListStateMachines Source #
Associated Types type Rs ListStateMachines :: * # Methods request :: ListStateMachines -> Request ListStateMachines # response :: MonadResource m => Logger -> Service -> Proxy * ListStateMachines -> ClientResponse -> m (Response ListStateMachines) #
ToQuery ListStateMachines Source #
Methods toQuery :: ListStateMachines -> QueryString #
ToPath ListStateMachines Source #
Methods toPath :: ListStateMachines -> ByteString #
ToHeaders ListStateMachines Source #
Methods toHeaders :: ListStateMachines -> [Header] #
type Rep ListStateMachines Source #
type Rep ListStateMachines = D1 (MetaData "ListStateMachines" "Network.AWS.StepFunctions.ListStateMachines" "amazonka-stepfunctions-1.5.0-72Mahrok8Tr5xIrxR72Cpm" False) (C1 (MetaCons "ListStateMachines'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lsmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lsmMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs ListStateMachines Source #
type Rs ListStateMachines = ListStateMachinesResponse

Request Lenses

lsmNextToken :: Lens' ListStateMachines (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.

lsmMaxResults :: Lens' ListStateMachines (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 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.

Destructuring the Response

listStateMachinesResponse Source #

Arguments

:: Int	`lsmrsResponseStatus`
-> ListStateMachinesResponse

Creates a value of ListStateMachinesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lsmrsNextToken - 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.
lsmrsResponseStatus - -- | The response status code.
lsmrsStateMachines - Undocumented member.

data ListStateMachinesResponse Source #

See: listStateMachinesResponse smart constructor.

Instances

Eq ListStateMachinesResponse Source #
Methods (==) :: ListStateMachinesResponse -> ListStateMachinesResponse -> Bool # (/=) :: ListStateMachinesResponse -> ListStateMachinesResponse -> Bool #
Data ListStateMachinesResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListStateMachinesResponse -> c ListStateMachinesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListStateMachinesResponse # toConstr :: ListStateMachinesResponse -> Constr # dataTypeOf :: ListStateMachinesResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListStateMachinesResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListStateMachinesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListStateMachinesResponse -> ListStateMachinesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListStateMachinesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListStateMachinesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListStateMachinesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListStateMachinesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListStateMachinesResponse -> m ListStateMachinesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStateMachinesResponse -> m ListStateMachinesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStateMachinesResponse -> m ListStateMachinesResponse #
Read ListStateMachinesResponse Source #
Methods readsPrec :: Int -> ReadS ListStateMachinesResponse # readList :: ReadS [ListStateMachinesResponse] # readPrec :: ReadPrec ListStateMachinesResponse # readListPrec :: ReadPrec [ListStateMachinesResponse] #
Show ListStateMachinesResponse Source #
Methods showsPrec :: Int -> ListStateMachinesResponse -> ShowS # show :: ListStateMachinesResponse -> String # showList :: [ListStateMachinesResponse] -> ShowS #
Generic ListStateMachinesResponse Source #
Associated Types type Rep ListStateMachinesResponse :: * -> * # Methods from :: ListStateMachinesResponse -> Rep ListStateMachinesResponse x # to :: Rep ListStateMachinesResponse x -> ListStateMachinesResponse #
NFData ListStateMachinesResponse Source #
Methods rnf :: ListStateMachinesResponse -> () #
type Rep ListStateMachinesResponse Source #
type Rep ListStateMachinesResponse = D1 (MetaData "ListStateMachinesResponse" "Network.AWS.StepFunctions.ListStateMachines" "amazonka-stepfunctions-1.5.0-72Mahrok8Tr5xIrxR72Cpm" False) (C1 (MetaCons "ListStateMachinesResponse'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_lsmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_lsmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lsmrsStateMachines") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [StateMachineListItem])))))

Response Lenses

lsmrsNextToken :: Lens' ListStateMachinesResponse (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.

lsmrsResponseStatus :: Lens' ListStateMachinesResponse Int Source #

- | The response status code.

lsmrsStateMachines :: Lens' ListStateMachinesResponse [StateMachineListItem] Source #

Undocumented member.