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.GetStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the active (live) stream on a specified channel.

Synopsis

data GetStream = GetStream' {
- channelArn :: Text
}
newGetStream :: Text -> GetStream
getStream_channelArn :: Lens' GetStream Text
data GetStreamResponse = GetStreamResponse' {
- stream :: Maybe Stream
- httpStatus :: Int
}
newGetStreamResponse :: Int -> GetStreamResponse
getStreamResponse_stream :: Lens' GetStreamResponse (Maybe Stream)
getStreamResponse_httpStatus :: Lens' GetStreamResponse Int

Creating a Request

data GetStream Source #

See: newGetStream smart constructor.

Constructors

GetStream'
Fields channelArn :: Text Channel ARN for stream to be accessed.

Instances

Instances details

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

newGetStream Source #

Arguments

:: Text	`GetStream`
-> GetStream

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

GetStream, getStream_channelArn - Channel ARN for stream to be accessed.

Request Lenses

getStream_channelArn :: Lens' GetStream Text Source #

Channel ARN for stream to be accessed.

Destructuring the Response

data GetStreamResponse Source #

See: newGetStreamResponse smart constructor.

Constructors

GetStreamResponse'
Fields stream :: Maybe Stream httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetStreamResponse Source #

Arguments

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

Create a value of GetStreamResponse 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:stream:GetStreamResponse', getStreamResponse_stream -

$sel:httpStatus:GetStreamResponse', getStreamResponse_httpStatus - The response's http status code.

Response Lenses

getStreamResponse_stream :: Lens' GetStreamResponse (Maybe Stream) Source #

getStreamResponse_httpStatus :: Lens' GetStreamResponse Int Source #

The response's http status code.