Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kinesis.ListStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

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

data ListStreams = ListStreams' {
- exclusiveStartStreamName :: Maybe Text
- limit :: Maybe Natural
- nextToken :: Maybe Text
}
newListStreams :: ListStreams
listStreams_exclusiveStartStreamName :: Lens' ListStreams (Maybe Text)
listStreams_limit :: Lens' ListStreams (Maybe Natural)
listStreams_nextToken :: Lens' ListStreams (Maybe Text)
data ListStreamsResponse = ListStreamsResponse' {
- nextToken :: Maybe Text
- streamSummaries :: Maybe [StreamSummary]
- httpStatus :: Int
- streamNames :: [Text]
- hasMoreStreams :: Bool
}
newListStreamsResponse :: Int -> Bool -> ListStreamsResponse
listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text)
listStreamsResponse_streamSummaries :: Lens' ListStreamsResponse (Maybe [StreamSummary])
listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int
listStreamsResponse_streamNames :: Lens' ListStreamsResponse [Text]
listStreamsResponse_hasMoreStreams :: Lens' ListStreamsResponse Bool

Creating a Request

data ListStreams Source #

Represents the input for ListStreams.

See: newListStreams smart constructor.

Constructors

ListStreams'
Fields exclusiveStartStreamName :: Maybe Text The name of the stream to start the list with. limit :: Maybe Natural The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned. nextToken :: Maybe Text

Instances

Instances details

ToJSON ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toJSON :: ListStreams -> Value # toEncoding :: ListStreams -> Encoding # toJSONList :: [ListStreams] -> Value # toEncodingList :: [ListStreams] -> Encoding #
ToHeaders ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toHeaders :: ListStreams -> [Header] #
ToPath ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toPath :: ListStreams -> ByteString #
ToQuery ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods toQuery :: ListStreams -> QueryString #
AWSPager ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods page :: ListStreams -> AWSResponse ListStreams -> Maybe ListStreams #
AWSRequest ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type AWSResponse ListStreams # Methods request :: (Service -> Service) -> ListStreams -> Request ListStreams # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreams))) #
Generic ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type Rep ListStreams :: Type -> Type # Methods from :: ListStreams -> Rep ListStreams x # to :: Rep ListStreams x -> ListStreams #
Read ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods readsPrec :: Int -> ReadS ListStreams # readList :: ReadS [ListStreams] # readPrec :: ReadPrec ListStreams # readListPrec :: ReadPrec [ListStreams] #
Show ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods showsPrec :: Int -> ListStreams -> ShowS # show :: ListStreams -> String # showList :: [ListStreams] -> ShowS #
NFData ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods rnf :: ListStreams -> () #
Eq ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods (==) :: ListStreams -> ListStreams -> Bool # (/=) :: ListStreams -> ListStreams -> Bool #
Hashable ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods hashWithSalt :: Int -> ListStreams -> Int # hash :: ListStreams -> Int #
type AWSResponse ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type AWSResponse ListStreams = ListStreamsResponse
type Rep ListStreams Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.Kinesis.ListStreams" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListStreams :: ListStreams Source #

Create a value of ListStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusiveStartStreamName:ListStreams', listStreams_exclusiveStartStreamName - The name of the stream to start the list with.

$sel:limit:ListStreams', listStreams_limit - The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

ListStreams, listStreams_nextToken -

Request Lenses

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

The name of the stream to start the list with.

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

The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

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

Destructuring the Response

data ListStreamsResponse Source #

Represents the output for ListStreams.

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse'
Fields nextToken :: Maybe Text streamSummaries :: Maybe [StreamSummary] httpStatus :: Int The response's http status code. streamNames :: [Text] The names of the streams that are associated with the Amazon Web Services account making the `ListStreams` request. hasMoreStreams :: Bool If set to `true`, there are more streams available to list.

Instances

Instances details

Generic ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Associated Types type Rep ListStreamsResponse :: Type -> Type # Methods from :: ListStreamsResponse -> Rep ListStreamsResponse x # to :: Rep ListStreamsResponse x -> ListStreamsResponse #
Read ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods readsPrec :: Int -> ReadS ListStreamsResponse # readList :: ReadS [ListStreamsResponse] # readPrec :: ReadPrec ListStreamsResponse # readListPrec :: ReadPrec [ListStreamsResponse] #
Show ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods showsPrec :: Int -> ListStreamsResponse -> ShowS # show :: ListStreamsResponse -> String # showList :: [ListStreamsResponse] -> ShowS #
NFData ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods rnf :: ListStreamsResponse -> () #
Eq ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams Methods (==) :: ListStreamsResponse -> ListStreamsResponse -> Bool # (/=) :: ListStreamsResponse -> ListStreamsResponse -> Bool #
type Rep ListStreamsResponse Source #
Instance details Defined in Amazonka.Kinesis.ListStreams type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.Kinesis.ListStreams" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StreamSummary]))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "streamNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "hasMoreStreams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newListStreamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStreamsResponse'`
-> Bool	`$sel:hasMoreStreams:ListStreamsResponse'`
-> ListStreamsResponse

Create a value of ListStreamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListStreams, listStreamsResponse_nextToken -

$sel:streamSummaries:ListStreamsResponse', listStreamsResponse_streamSummaries -

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

$sel:streamNames:ListStreamsResponse', listStreamsResponse_streamNames - The names of the streams that are associated with the Amazon Web Services account making the ListStreams request.

$sel:hasMoreStreams:ListStreamsResponse', listStreamsResponse_hasMoreStreams - If set to true, there are more streams available to list.

Response Lenses

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

listStreamsResponse_streamSummaries :: Lens' ListStreamsResponse (Maybe [StreamSummary]) Source #

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #

The response's http status code.

listStreamsResponse_streamNames :: Lens' ListStreamsResponse [Text] Source #

The names of the streams that are associated with the Amazon Web Services account making the ListStreams request.

listStreamsResponse_hasMoreStreams :: Lens' ListStreamsResponse Bool Source #

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