amazonka-kinesis-analytics-1.4.5: Amazon Kinesis Analytics 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.KinesisAnalytics.ListApplications

Contents

Description

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication .

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Synopsis

Creating a Request

listApplications :: ListApplications #

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

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

  • laLimit - Maximum number of applications to list.
  • laExclusiveStartApplicationName - Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

data ListApplications #

See: listApplications smart constructor.

Instances

Eq ListApplications # 
Data ListApplications # 

Methods

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

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

toConstr :: ListApplications -> Constr #

dataTypeOf :: ListApplications -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListApplications # 
Show ListApplications # 
Generic ListApplications # 
Hashable ListApplications # 
ToJSON ListApplications # 
NFData ListApplications # 

Methods

rnf :: ListApplications -> () #

AWSRequest ListApplications # 
ToQuery ListApplications # 
ToPath ListApplications # 
ToHeaders ListApplications # 
type Rep ListApplications # 
type Rep ListApplications = D1 (MetaData "ListApplications" "Network.AWS.KinesisAnalytics.ListApplications" "amazonka-kinesis-analytics-1.4.5-H83WG5KfDkB7lwaI8ml04Y" False) (C1 (MetaCons "ListApplications'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_laLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_laExclusiveStartApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs ListApplications # 

Request Lenses

laLimit :: Lens' ListApplications (Maybe Natural) #

Maximum number of applications to list.

laExclusiveStartApplicationName :: Lens' ListApplications (Maybe Text) #

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

Destructuring the Response

listApplicationsResponse #

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

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

data ListApplicationsResponse #

See: listApplicationsResponse smart constructor.

Instances

Eq ListApplicationsResponse # 
Data ListApplicationsResponse # 

Methods

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

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

toConstr :: ListApplicationsResponse -> Constr #

dataTypeOf :: ListApplicationsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListApplicationsResponse # 
Show ListApplicationsResponse # 
Generic ListApplicationsResponse # 
NFData ListApplicationsResponse # 
type Rep ListApplicationsResponse # 
type Rep ListApplicationsResponse = D1 (MetaData "ListApplicationsResponse" "Network.AWS.KinesisAnalytics.ListApplications" "amazonka-kinesis-analytics-1.4.5-H83WG5KfDkB7lwaI8ml04Y" False) (C1 (MetaCons "ListApplicationsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_larsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_larsApplicationSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ApplicationSummary])) (S1 (MetaSel (Just Symbol "_larsHasMoreApplications") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

Response Lenses

larsResponseStatus :: Lens' ListApplicationsResponse Int #

  • - | The response status code.

larsHasMoreApplications :: Lens' ListApplicationsResponse Bool #

Returns true if there are more applications to retrieve.