amazonka-kinesis-1.6.0: Amazon Kinesis SDK.

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

Network.AWS.Kinesis.ListStreams

Contents

Description

Lists your Kinesis data streams.

The number of streams may be too large to return from a single call to ListStreams . You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams . The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account.

This operation returns paginated results.

Synopsis

Creating a Request

listStreams :: ListStreams Source #

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

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

data ListStreams Source #

Represents the input for ListStreams .

See: listStreams smart constructor.

Instances

Eq ListStreams Source # 
Data ListStreams Source # 

Methods

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

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

toConstr :: ListStreams -> Constr #

dataTypeOf :: ListStreams -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListStreams Source # 
Show ListStreams Source # 
Generic ListStreams Source # 

Associated Types

type Rep ListStreams :: * -> * #

Hashable ListStreams Source # 
ToJSON ListStreams Source # 
NFData ListStreams Source # 

Methods

rnf :: ListStreams -> () #

AWSPager ListStreams Source # 
AWSRequest ListStreams Source # 
ToHeaders ListStreams Source # 

Methods

toHeaders :: ListStreams -> [Header] #

ToPath ListStreams Source # 
ToQuery ListStreams Source # 
type Rep ListStreams Source # 
type Rep ListStreams = D1 * (MetaData "ListStreams" "Network.AWS.Kinesis.ListStreams" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "ListStreams'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_lsExclusiveStartStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))
type Rs ListStreams Source # 

Request Lenses

lsLimit :: Lens' ListStreams (Maybe Natural) Source #

The maximum number of streams to list.

lsExclusiveStartStreamName :: Lens' ListStreams (Maybe Text) Source #

The name of the stream to start the list with.

Destructuring the Response

listStreamsResponse Source #

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

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

data ListStreamsResponse Source #

Represents the output for ListStreams .

See: listStreamsResponse smart constructor.

Instances

Eq ListStreamsResponse Source # 
Data ListStreamsResponse Source # 

Methods

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

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

toConstr :: ListStreamsResponse -> Constr #

dataTypeOf :: ListStreamsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListStreamsResponse Source # 
Show ListStreamsResponse Source # 
Generic ListStreamsResponse Source # 
NFData ListStreamsResponse Source # 

Methods

rnf :: ListStreamsResponse -> () #

type Rep ListStreamsResponse Source # 
type Rep ListStreamsResponse = D1 * (MetaData "ListStreamsResponse" "Network.AWS.Kinesis.ListStreams" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "ListStreamsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsrsStreamNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])) (S1 * (MetaSel (Just Symbol "_lsrsHasMoreStreams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool)))))

Response Lenses

lsrsResponseStatus :: Lens' ListStreamsResponse Int Source #

  • - | The response status code.

lsrsStreamNames :: Lens' ListStreamsResponse [Text] Source #

The names of the streams that are associated with the AWS account making the ListStreams request.

lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool Source #

If set to true , there are more streams available to list.