Network.AWS.Kinesis.ListStreams

Lists your 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, Amazon Kinesis 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 5 transactions per second per account.

See: AWS API Reference for ListStreams.

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
• lsExclusiveStartStreamName

data ListStreams

Represents the input for ListStreams.

See: listStreams smart constructor.

Instances

Eq ListStreams

Data ListStreams

Read ListStreams

Show ListStreams

Generic ListStreams

ToJSON ListStreams

AWSPager ListStreams

AWSRequest ListStreams

ToPath ListStreams

ToHeaders ListStreams

ToQuery ListStreams

Typeable * ListStreams

type Rep 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

lsrsStatus

-> 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:

• lsrsStatus
• lsrsStreamNames
• lsrsHasMoreStreams

data ListStreamsResponse

Represents the output for ListStreams.

See: listStreamsResponse smart constructor.

Instances

Eq ListStreamsResponse

Data ListStreamsResponse

Read ListStreamsResponse

Show ListStreamsResponse

Generic ListStreamsResponse

Typeable * ListStreamsResponse

type Rep ListStreamsResponse

Response Lenses

lsrsStatus :: 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.