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.IVS.ListStreamSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Synopsis

data ListStreamSessions = ListStreamSessions' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- channelArn :: Text
}
newListStreamSessions :: Text -> ListStreamSessions
listStreamSessions_maxResults :: Lens' ListStreamSessions (Maybe Natural)
listStreamSessions_nextToken :: Lens' ListStreamSessions (Maybe Text)
listStreamSessions_channelArn :: Lens' ListStreamSessions Text
data ListStreamSessionsResponse = ListStreamSessionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- streamSessions :: [StreamSessionSummary]
}
newListStreamSessionsResponse :: Int -> ListStreamSessionsResponse
listStreamSessionsResponse_nextToken :: Lens' ListStreamSessionsResponse (Maybe Text)
listStreamSessionsResponse_httpStatus :: Lens' ListStreamSessionsResponse Int
listStreamSessionsResponse_streamSessions :: Lens' ListStreamSessionsResponse [StreamSessionSummary]

Creating a Request

data ListStreamSessions Source #

See: newListStreamSessions smart constructor.

Constructors

ListStreamSessions'
Fields maxResults :: Maybe Natural Maximum number of streams to return. Default: 100. nextToken :: Maybe Text The first stream to retrieve. This is used for pagination; see the `nextToken` response field. channelArn :: Text Channel ARN used to filter the list.

Instances

Instances details

ToJSON ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods toJSON :: ListStreamSessions -> Value # toEncoding :: ListStreamSessions -> Encoding # toJSONList :: [ListStreamSessions] -> Value # toEncodingList :: [ListStreamSessions] -> Encoding #
ToHeaders ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods toHeaders :: ListStreamSessions -> [Header] #
ToPath ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods toPath :: ListStreamSessions -> ByteString #
ToQuery ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods toQuery :: ListStreamSessions -> QueryString #
AWSRequest ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Associated Types type AWSResponse ListStreamSessions # Methods request :: (Service -> Service) -> ListStreamSessions -> Request ListStreamSessions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStreamSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStreamSessions))) #
Generic ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Associated Types type Rep ListStreamSessions :: Type -> Type # Methods from :: ListStreamSessions -> Rep ListStreamSessions x # to :: Rep ListStreamSessions x -> ListStreamSessions #
Read ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods readsPrec :: Int -> ReadS ListStreamSessions # readList :: ReadS [ListStreamSessions] # readPrec :: ReadPrec ListStreamSessions # readListPrec :: ReadPrec [ListStreamSessions] #
Show ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods showsPrec :: Int -> ListStreamSessions -> ShowS # show :: ListStreamSessions -> String # showList :: [ListStreamSessions] -> ShowS #
NFData ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods rnf :: ListStreamSessions -> () #
Eq ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods (==) :: ListStreamSessions -> ListStreamSessions -> Bool # (/=) :: ListStreamSessions -> ListStreamSessions -> Bool #
Hashable ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions Methods hashWithSalt :: Int -> ListStreamSessions -> Int # hash :: ListStreamSessions -> Int #
type AWSResponse ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions type AWSResponse ListStreamSessions = ListStreamSessionsResponse
type Rep ListStreamSessions Source #
Instance details Defined in Amazonka.IVS.ListStreamSessions type Rep ListStreamSessions = D1 ('MetaData "ListStreamSessions" "Amazonka.IVS.ListStreamSessions" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ListStreamSessions'" '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 "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListStreamSessions Source #

Arguments

:: Text	`ListStreamSessions`
-> ListStreamSessions

Create a value of ListStreamSessions 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:ListStreamSessions', listStreamSessions_maxResults - Maximum number of streams to return. Default: 100.

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

ListStreamSessions, listStreamSessions_channelArn - Channel ARN used to filter the list.

Request Lenses

listStreamSessions_maxResults :: Lens' ListStreamSessions (Maybe Natural) Source #

Maximum number of streams to return. Default: 100.

listStreamSessions_nextToken :: Lens' ListStreamSessions (Maybe Text) Source #

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

listStreamSessions_channelArn :: Lens' ListStreamSessions Text Source #

Channel ARN used to filter the list.

Destructuring the Response

data ListStreamSessionsResponse Source #

See: newListStreamSessionsResponse smart constructor.

Constructors

ListStreamSessionsResponse'
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. streamSessions :: [StreamSessionSummary] List of stream sessions.

Instances

Instances details

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

newListStreamSessionsResponse Source #

Arguments

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

Create a value of ListStreamSessionsResponse 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:

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

$sel:httpStatus:ListStreamSessionsResponse', listStreamSessionsResponse_httpStatus - The response's http status code.

$sel:streamSessions:ListStreamSessionsResponse', listStreamSessionsResponse_streamSessions - List of stream sessions.

Response Lenses

listStreamSessionsResponse_nextToken :: Lens' ListStreamSessionsResponse (Maybe Text) Source #

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

listStreamSessionsResponse_httpStatus :: Lens' ListStreamSessionsResponse Int Source #

The response's http status code.

listStreamSessionsResponse_streamSessions :: Lens' ListStreamSessionsResponse [StreamSessionSummary] Source #

List of stream sessions.