Network.AWS.Kinesis.ListStreams

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.

Creating a Request

listStreams :: ListStreams

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:

• lsLimit - The maximum number of streams to list.
• lsExclusiveStartStreamName - The name of the stream to start the list with.

data ListStreams

Represents the input for ListStreams .

See: listStreams smart constructor.

Instances

Eq ListStreams

Methods

(==) :: ListStreams -> ListStreams -> Bool

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

Data ListStreams

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

Methods

readsPrec :: Int -> ReadS ListStreams

readList :: ReadS [ListStreams]

readPrec :: ReadPrec ListStreams

readListPrec :: ReadPrec [ListStreams]

Show ListStreams

Methods

showsPrec :: Int -> ListStreams -> ShowS

show :: ListStreams -> String

showList :: [ListStreams] -> ShowS

Generic ListStreams

Associated Types

type Rep ListStreams :: * -> *

Methods

from :: ListStreams -> Rep ListStreams x

to :: Rep ListStreams x -> ListStreams

Hashable ListStreams

Methods

hashWithSalt :: Int -> ListStreams -> Int

hash :: ListStreams -> Int

ToJSON ListStreams

Methods

toJSON :: ListStreams -> Value

toEncoding :: ListStreams -> Encoding

toJSONList :: [ListStreams] -> Value

toEncodingList :: [ListStreams] -> Encoding

NFData ListStreams

Methods

rnf :: ListStreams -> ()

AWSPager ListStreams

Methods

page :: ListStreams -> Rs ListStreams -> Maybe ListStreams

AWSRequest ListStreams

Associated Types

type Rs ListStreams :: *

Methods

request :: ListStreams -> Request ListStreams

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListStreams -> ClientResponse -> m (Response ListStreams)

ToHeaders ListStreams

Methods

toHeaders :: ListStreams -> [Header]

ToPath ListStreams

Methods

toPath :: ListStreams -> ByteString

ToQuery ListStreams

Methods

toQuery :: ListStreams -> QueryString

type Rep ListStreams

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

type Rs ListStreams = ListStreamsResponse

Request Lenses

lsLimit :: Lens' ListStreams (Maybe Natural)

The maximum number of streams to list.

lsExclusiveStartStreamName :: Lens' ListStreams (Maybe Text)

The name of the stream to start the list with.

Destructuring the Response

listStreamsResponse

Arguments

:: Int

lsrsResponseStatus

-> Bool

lsrsHasMoreStreams

-> ListStreamsResponse

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:

• lsrsResponseStatus - -- | The response status code.
• lsrsStreamNames - The names of the streams that are associated with the AWS account making the ListStreams request.
• lsrsHasMoreStreams - If set to true , there are more streams available to list.

data ListStreamsResponse

Represents the output for ListStreams .

See: listStreamsResponse smart constructor.

Instances

Eq ListStreamsResponse

Methods

(==) :: ListStreamsResponse -> ListStreamsResponse -> Bool

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

Data ListStreamsResponse

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

Methods

readsPrec :: Int -> ReadS ListStreamsResponse

readList :: ReadS [ListStreamsResponse]

readPrec :: ReadPrec ListStreamsResponse

readListPrec :: ReadPrec [ListStreamsResponse]

Show ListStreamsResponse

Methods

showsPrec :: Int -> ListStreamsResponse -> ShowS

show :: ListStreamsResponse -> String

showList :: [ListStreamsResponse] -> ShowS

Generic ListStreamsResponse

Associated Types

type Rep ListStreamsResponse :: * -> *

Methods

from :: ListStreamsResponse -> Rep ListStreamsResponse x

to :: Rep ListStreamsResponse x -> ListStreamsResponse

NFData ListStreamsResponse

Methods

rnf :: ListStreamsResponse -> ()

type Rep ListStreamsResponse

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

• - | The response status code.

lsrsStreamNames :: Lens' ListStreamsResponse [Text]

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

lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool

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