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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Creating a Request

data DescribeStream Source #

See: newDescribeStream smart constructor.

Constructors

DescribeStream'
Fields streamARN :: Maybe Text The Amazon Resource Name (ARN) of the stream. streamName :: Maybe Text The name of the stream.

Instances

Instances details

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

newDescribeStream :: DescribeStream Source #

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

DescribeStream, describeStream_streamARN - The Amazon Resource Name (ARN) of the stream.

DescribeStream, describeStream_streamName - The name of the stream.

Request Lenses

describeStream_streamARN :: Lens' DescribeStream (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream.

describeStream_streamName :: Lens' DescribeStream (Maybe Text) Source #

The name of the stream.

Destructuring the Response

data DescribeStreamResponse Source #

See: newDescribeStreamResponse smart constructor.

Constructors

DescribeStreamResponse'
Fields streamInfo :: Maybe StreamInfo An object that describes the stream. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeStreamResponse Source #

Arguments

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

Create a value of DescribeStreamResponse 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:streamInfo:DescribeStreamResponse', describeStreamResponse_streamInfo - An object that describes the stream.

$sel:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.

Response Lenses

describeStreamResponse_streamInfo :: Lens' DescribeStreamResponse (Maybe StreamInfo) Source #

An object that describes the stream.

describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int Source #

The response's http status code.