amazonka-dynamodb-streams-1.4.5: Amazon DynamoDB Streams SDK.

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

Network.AWS.DynamoDBStreams.ListStreams

Contents

Description

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

Synopsis

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:

  • lsExclusiveStartStreamARN - The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.
  • lsLimit - The maximum number of streams to return. The upper limit is 100.
  • lsTableName - If this parameter is provided, then only the streams associated with this table name are returned.

data ListStreams #

Represents the input of a ListStreams operation.

See: listStreams smart constructor.

Instances

Eq ListStreams # 
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 # 
Show ListStreams # 
Generic ListStreams # 

Associated Types

type Rep ListStreams :: * -> * #

Hashable ListStreams # 
ToJSON ListStreams # 
NFData ListStreams # 

Methods

rnf :: ListStreams -> () #

AWSRequest ListStreams # 
ToQuery ListStreams # 
ToPath ListStreams # 
ToHeaders ListStreams # 

Methods

toHeaders :: ListStreams -> [Header] #

type Rep ListStreams # 
type Rep ListStreams = D1 (MetaData "ListStreams" "Network.AWS.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-1.4.5-1JUgl1lmZkS649OJ57ZQdS" False) (C1 (MetaCons "ListStreams'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lsExclusiveStartStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lsTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs ListStreams # 

Request Lenses

lsExclusiveStartStreamARN :: Lens' ListStreams (Maybe Text) #

The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

lsLimit :: Lens' ListStreams (Maybe Natural) #

The maximum number of streams to return. The upper limit is 100.

lsTableName :: Lens' ListStreams (Maybe Text) #

If this parameter is provided, then only the streams associated with this table name are returned.

Destructuring the Response

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:

  • lsrsLastEvaluatedStreamARN - The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.
  • lsrsStreams - A list of stream descriptors associated with the current account and endpoint.
  • lsrsResponseStatus - -- | The response status code.

data ListStreamsResponse #

Represents the output of a ListStreams operation.

See: listStreamsResponse smart constructor.

Instances

Eq ListStreamsResponse # 
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 # 
Show ListStreamsResponse # 
Generic ListStreamsResponse # 
NFData ListStreamsResponse # 

Methods

rnf :: ListStreamsResponse -> () #

type Rep ListStreamsResponse # 
type Rep ListStreamsResponse = D1 (MetaData "ListStreamsResponse" "Network.AWS.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-1.4.5-1JUgl1lmZkS649OJ57ZQdS" False) (C1 (MetaCons "ListStreamsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lsrsLastEvaluatedStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lsrsStreams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Stream]))) (S1 (MetaSel (Just Symbol "_lsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lsrsLastEvaluatedStreamARN :: Lens' ListStreamsResponse (Maybe Text) #

The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

lsrsStreams :: Lens' ListStreamsResponse [Stream] #

A list of stream descriptors associated with the current account and endpoint.

lsrsResponseStatus :: Lens' ListStreamsResponse Int #

  • - | The response status code.