Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.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

describeStream :: DescribeStream Source #

Creates a value of DescribeStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dStreamARN - The Amazon Resource Name (ARN) of the stream.
dStreamName - The name of the stream.

data DescribeStream Source #

See: describeStream smart constructor.

Instances

Eq DescribeStream Source #
Methods (==) :: DescribeStream -> DescribeStream -> Bool # (/=) :: DescribeStream -> DescribeStream -> Bool #
Data DescribeStream Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStream -> c DescribeStream # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStream # toConstr :: DescribeStream -> Constr # dataTypeOf :: DescribeStream -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStream) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStream) # gmapT :: (forall b. Data b => b -> b) -> DescribeStream -> DescribeStream # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStream -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStream -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeStream -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStream -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStream -> m DescribeStream # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStream -> m DescribeStream # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStream -> m DescribeStream #
Read DescribeStream Source #
Methods readsPrec :: Int -> ReadS DescribeStream # readList :: ReadS [DescribeStream] # readPrec :: ReadPrec DescribeStream # readListPrec :: ReadPrec [DescribeStream] #
Show DescribeStream Source #
Methods showsPrec :: Int -> DescribeStream -> ShowS # show :: DescribeStream -> String # showList :: [DescribeStream] -> ShowS #
Generic DescribeStream Source #
Associated Types type Rep DescribeStream :: * -> * # Methods from :: DescribeStream -> Rep DescribeStream x # to :: Rep DescribeStream x -> DescribeStream #
Hashable DescribeStream Source #
Methods hashWithSalt :: Int -> DescribeStream -> Int # hash :: DescribeStream -> Int #
ToJSON DescribeStream Source #
Methods toJSON :: DescribeStream -> Value # toEncoding :: DescribeStream -> Encoding # toJSONList :: [DescribeStream] -> Value # toEncodingList :: [DescribeStream] -> Encoding #
NFData DescribeStream Source #
Methods rnf :: DescribeStream -> () #
AWSRequest DescribeStream Source #
Associated Types type Rs DescribeStream :: * # Methods request :: DescribeStream -> Request DescribeStream # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeStream -> ClientResponse -> m (Response DescribeStream) #
ToHeaders DescribeStream Source #
Methods toHeaders :: DescribeStream -> [Header] #
ToPath DescribeStream Source #
Methods toPath :: DescribeStream -> ByteString #
ToQuery DescribeStream Source #
Methods toQuery :: DescribeStream -> QueryString #
type Rep DescribeStream Source #
type Rep DescribeStream = D1 * (MetaData "DescribeStream" "Network.AWS.KinesisVideo.DescribeStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "DescribeStream'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_dStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))
type Rs DescribeStream Source #
type Rs DescribeStream = DescribeStreamResponse

Request Lenses

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

The Amazon Resource Name (ARN) of the stream.

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

The name of the stream.

Destructuring the Response

describeStreamResponse Source #

Arguments

:: Int	`drsResponseStatus`
-> DescribeStreamResponse

Creates a value of DescribeStreamResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drsStreamInfo - An object that describes the stream.
drsResponseStatus - -- | The response status code.

data DescribeStreamResponse Source #

See: describeStreamResponse smart constructor.

Instances

Eq DescribeStreamResponse Source #
Methods (==) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool # (/=) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool #
Data DescribeStreamResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStreamResponse -> c DescribeStreamResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStreamResponse # toConstr :: DescribeStreamResponse -> Constr # dataTypeOf :: DescribeStreamResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStreamResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStreamResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeStreamResponse -> DescribeStreamResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeStreamResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStreamResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamResponse -> m DescribeStreamResponse #
Read DescribeStreamResponse Source #
Methods readsPrec :: Int -> ReadS DescribeStreamResponse # readList :: ReadS [DescribeStreamResponse] # readPrec :: ReadPrec DescribeStreamResponse # readListPrec :: ReadPrec [DescribeStreamResponse] #
Show DescribeStreamResponse Source #
Methods showsPrec :: Int -> DescribeStreamResponse -> ShowS # show :: DescribeStreamResponse -> String # showList :: [DescribeStreamResponse] -> ShowS #
Generic DescribeStreamResponse Source #
Associated Types type Rep DescribeStreamResponse :: * -> * # Methods from :: DescribeStreamResponse -> Rep DescribeStreamResponse x # to :: Rep DescribeStreamResponse x -> DescribeStreamResponse #
NFData DescribeStreamResponse Source #
Methods rnf :: DescribeStreamResponse -> () #
type Rep DescribeStreamResponse Source #
type Rep DescribeStreamResponse = D1 * (MetaData "DescribeStreamResponse" "Network.AWS.KinesisVideo.DescribeStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "DescribeStreamResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_drsStreamInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StreamInfo))) (S1 * (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

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

An object that describes the stream.

drsResponseStatus :: Lens' DescribeStreamResponse Int Source #

- | The response status code.