aws-kinesis-0.1.2: Bindings for Amazon Kinesis

CopyrightCopyright (c) 2013-2014 PivotCloud, Inc.
LicenseApache License, Version 2.0
MaintainerLars Kuhtz <lars@alephcloud.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Aws.Kinesis.Commands.ListStreams

Description

API Version: 2013-12-02

This operation returns an array of the names of all the streams that are associated with the AWS account making the ListStreams request. A given AWS account can have many streams active at one time.

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.

http://docs.aws.amazon.com/kinesis/2013-12-02/APIReference/API_ListStreams.html

Documentation

data ListStreams Source

Constructors

ListStreams 

Fields

listStreamsExclusiveStartStreamName :: !(Maybe StreamName)

The name of the stream to start the list with.

listStreamsLimit :: !(Maybe Int)

The maximum number of streams to list.

Instances

Eq ListStreams 
Ord ListStreams 
Read ListStreams 
Show ListStreams 
ToJSON ListStreams 
SignQuery ListStreams 
Typeable * ListStreams 
Transaction ListStreams ListStreamsResponse 
IteratedTransaction ListStreams ListStreamsResponse

This instance assumes that ListStreams returns at least one stream if available, i.e. if listStreamsResHasMoreStreams == True.

Otherwise, in case no stream is returned but listStreamsResHasMoreStreams == True the implementation in this instance returns Nothing, thus ignoring the value of listStreamsResHasMoreStreams. The alternatives would be to either throw an exception or to start over with a reqeust for the first set of streams which could result in a non-terminating behavior.

The request parameter listStreamsLimit is interpreted as limit for each single request and not for the overall transaction.

type ServiceConfiguration ListStreams = KinesisConfiguration 

data ListStreamsResponse Source

Constructors

ListStreamsResponse 

Fields

listStreamsResHasMoreStreams :: !Bool

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

listStreamsResStreamNames :: ![StreamName]

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

Instances

Eq ListStreamsResponse 
Ord ListStreamsResponse 
Read ListStreamsResponse 
Show ListStreamsResponse 
FromJSON ListStreamsResponse 
AsMemoryResponse ListStreamsResponse 
Typeable * ListStreamsResponse 
ResponseConsumer r ListStreamsResponse 
ListResponse ListStreamsResponse StreamName 
Transaction ListStreams ListStreamsResponse 
IteratedTransaction ListStreams ListStreamsResponse

This instance assumes that ListStreams returns at least one stream if available, i.e. if listStreamsResHasMoreStreams == True.

Otherwise, in case no stream is returned but listStreamsResHasMoreStreams == True the implementation in this instance returns Nothing, thus ignoring the value of listStreamsResHasMoreStreams. The alternatives would be to either throw an exception or to start over with a reqeust for the first set of streams which could result in a non-terminating behavior.

The request parameter listStreamsLimit is interpreted as limit for each single request and not for the overall transaction.

type ResponseMetadata ListStreamsResponse = KinesisMetadata 
type MemoryResponse ListStreamsResponse = ListStreamsResponse 

data ListStreamsExceptions Source

Constructors

ListStreamsLimitExceededException

Code 400

Instances