Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IVS.ListStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

This operation returns paginated results.

Creating a Request

data ListStreams Source #

See: newListStreams smart constructor.

Constructors

ListStreams'
Fields nextToken :: Maybe Text The first stream to retrieve. This is used for pagination; see the `nextToken` response field. maxResults :: Maybe Natural Maximum number of streams to return. Default: 50.

Instances

Instances details

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

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:nextToken:ListStreams', listStreams_nextToken - The first stream to retrieve. This is used for pagination; see the nextToken response field.

$sel:maxResults:ListStreams', listStreams_maxResults - Maximum number of streams to return. Default: 50.

Request Lenses

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

The first stream to retrieve. This is used for pagination; see the nextToken response field.

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

Maximum number of streams to return. Default: 50.

Destructuring the Response

data ListStreamsResponse Source #

See: newListStreamsResponse smart constructor.

Constructors

ListStreamsResponse'
Fields nextToken :: Maybe Text If there are more streams than `maxResults`, use `nextToken` in the request to get the next set. httpStatus :: Int The response's http status code. streams :: [StreamSummary] List of streams.

Instances

Instances details

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

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:

$sel:nextToken:ListStreams', listStreamsResponse_nextToken - If there are more streams than maxResults, use nextToken in the request to get the next set.

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

$sel:streams:ListStreamsResponse', listStreamsResponse_streams - List of streams.

Response Lenses

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

If there are more streams than maxResults, use nextToken in the request to get the next set.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #

The response's http status code.

listStreamsResponse_streams :: Lens' ListStreamsResponse [StreamSummary] Source #

List of streams.