Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisVideo.ListStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Creating a Request

data ListStreams Source #

See: newListStreams smart constructor.

Constructors

ListStreams'

Fields

maxResults :: Maybe Natural
The maximum number of streams to return in the response. The default is 10,000.
nextToken :: 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.
streamNameCondition :: 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.

Instances

Instances details

ToJSON ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods toJSON :: ListStreams -> Value # toEncoding :: ListStreams -> Encoding # toJSONList :: [ListStreams] -> Value # toEncodingList :: [ListStreams] -> Encoding #
ToHeaders ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods toHeaders :: ListStreams -> [Header] #
ToPath ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods toPath :: ListStreams -> ByteString #
ToQuery ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods toQuery :: ListStreams -> QueryString #
AWSPager ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods page :: ListStreams -> AWSResponse ListStreams -> Maybe ListStreams #
AWSRequest ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Associated Types type AWSResponse ListStreams # Methods request :: (Service -> Service) -> ListStreams -> Request ListStreams # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreams))) #
Generic ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Associated Types type Rep ListStreams :: Type -> Type # Methods from :: ListStreams -> Rep ListStreams x # to :: Rep ListStreams x -> ListStreams #
Read ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods readsPrec :: Int -> ReadS ListStreams # readList :: ReadS [ListStreams] # readPrec :: ReadPrec ListStreams # readListPrec :: ReadPrec [ListStreams] #
Show ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods showsPrec :: Int -> ListStreams -> ShowS # show :: ListStreams -> String # showList :: [ListStreams] -> ShowS #
NFData ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods rnf :: ListStreams -> () #
Eq ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods (==) :: ListStreams -> ListStreams -> Bool # (/=) :: ListStreams -> ListStreams -> Bool #
Hashable ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods hashWithSalt :: Int -> ListStreams -> Int # hash :: ListStreams -> Int #
type AWSResponse ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams type AWSResponse ListStreams = ListStreamsResponse
type Rep ListStreams Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams type Rep ListStreams = D1 ('MetaData "ListStreams" "Amazonka.KinesisVideo.ListStreams" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamNameCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamNameCondition)))))

newListStreams :: ListStreams Source #

Create a value of ListStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListStreams', listStreams_maxResults - The maximum number of streams to return in the response. The default is 10,000.

ListStreams, listStreams_nextToken - 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.

$sel:streamNameCondition:ListStreams', listStreams_streamNameCondition - Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Request Lenses

listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #

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

listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #

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.

listStreams_streamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition) Source #

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

Destructuring the Response

data ListStreamsResponse Source #

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse'
Fields nextToken :: 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. streamInfoList :: Maybe [StreamInfo] An array of `StreamInfo` objects. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Associated Types type Rep ListStreamsResponse :: Type -> Type # Methods from :: ListStreamsResponse -> Rep ListStreamsResponse x # to :: Rep ListStreamsResponse x -> ListStreamsResponse #
Read ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods readsPrec :: Int -> ReadS ListStreamsResponse # readList :: ReadS [ListStreamsResponse] # readPrec :: ReadPrec ListStreamsResponse # readListPrec :: ReadPrec [ListStreamsResponse] #
Show ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods showsPrec :: Int -> ListStreamsResponse -> ShowS # show :: ListStreamsResponse -> String # showList :: [ListStreamsResponse] -> ShowS #
NFData ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods rnf :: ListStreamsResponse -> () #
Eq ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams Methods (==) :: ListStreamsResponse -> ListStreamsResponse -> Bool # (/=) :: ListStreamsResponse -> ListStreamsResponse -> Bool #
type Rep ListStreamsResponse Source #
Instance details Defined in Amazonka.KinesisVideo.ListStreams type Rep ListStreamsResponse = D1 ('MetaData "ListStreamsResponse" "Amazonka.KinesisVideo.ListStreams" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streamInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StreamInfo])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStreamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStreamsResponse'`
-> ListStreamsResponse

Create a value of ListStreamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListStreams, listStreamsResponse_nextToken - 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.

$sel:streamInfoList:ListStreamsResponse', listStreamsResponse_streamInfoList - An array of StreamInfo objects.

$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.

Response Lenses

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

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.

listStreamsResponse_streamInfoList :: Lens' ListStreamsResponse (Maybe [StreamInfo]) Source #

An array of StreamInfo objects.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #

The response's http status code.