Network.AWS.DynamoDBStreams.ListStreams

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.

You can call ListStreams at a maximum rate of 5 times per second.

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
• lsLimit
• lsTableName

data ListStreams

Represents the input of a ListStreams operation.

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

NFData ListStreams

Methods

rnf :: ListStreams -> ()

AWSRequest ListStreams

Associated Types

type Rs ListStreams :: *

Methods

request :: ListStreams -> Request ListStreams

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

ToPath ListStreams

Methods

toPath :: ListStreams -> ByteString

ToHeaders ListStreams

Methods

toHeaders :: ListStreams -> [Header]

ToQuery ListStreams

Methods

toQuery :: ListStreams -> QueryString

ToJSON ListStreams

Methods

toJSON :: ListStreams -> Value

toEncoding :: ListStreams -> Encoding

type Rep ListStreams

type Rep ListStreams = D1 (MetaData "ListStreams" "Network.AWS.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-1.4.4-1rTW06t44jtKhT6USzdDPR" 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

type Rs ListStreams = ListStreamsResponse

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

Arguments

:: Int

lsrsResponseStatus

-> 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
• lsrsStreams
• lsrsResponseStatus

data ListStreamsResponse

Represents the output of a ListStreams operation.

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.DynamoDBStreams.ListStreams" "amazonka-dynamodb-streams-1.4.4-1rTW06t44jtKhT6USzdDPR" 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.