Network.AWS.KinesisVideo.ListStreams

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition .

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:

• lsNextToken - If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.
• lsStreamNameCondition - Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
• lsMaxResults - The maximum number of streams to return in the response. The default is 10,000.

data ListStreams

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

ToJSON ListStreams

Methods

toJSON :: ListStreams -> Value

toEncoding :: ListStreams -> Encoding

toJSONList :: [ListStreams] -> Value

toEncodingList :: [ListStreams] -> Encoding

NFData ListStreams

Methods

rnf :: ListStreams -> ()

AWSRequest ListStreams

Associated Types

type Rs ListStreams :: *

Methods

request :: ListStreams -> Request ListStreams

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

ToHeaders ListStreams

Methods

toHeaders :: ListStreams -> [Header]

ToPath ListStreams

Methods

toPath :: ListStreams -> ByteString

ToQuery ListStreams

Methods

toQuery :: ListStreams -> QueryString

type Rep ListStreams

type Rep ListStreams = D1 * (MetaData "ListStreams" "Network.AWS.KinesisVideo.ListStreams" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "ListStreams'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsStreamNameCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StreamNameCondition))) (S1 * (MetaSel (Just Symbol "_lsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs ListStreams

type Rs ListStreams = ListStreamsResponse

Request Lenses

lsNextToken :: Lens' ListStreams (Maybe Text)

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

lsStreamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition)

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

lsMaxResults :: Lens' ListStreams (Maybe Natural)

The maximum number of streams to return in the response. The default is 10,000.

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:

• lsrsStreamInfoList - An array of StreamInfo objects.
• lsrsNextToken - If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.
• lsrsResponseStatus - -- | The response status code.

data ListStreamsResponse

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.KinesisVideo.ListStreams" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "ListStreamsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsrsStreamInfoList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [StreamInfo]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lsrsStreamInfoList :: Lens' ListStreamsResponse [StreamInfo]

An array of StreamInfo objects.

lsrsNextToken :: Lens' ListStreamsResponse (Maybe Text)

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

lsrsResponseStatus :: Lens' ListStreamsResponse Int

• - | The response status code.