{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.KinesisVideo.DescribeStream -- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns the most current information about the specified stream. You must specify either the @StreamName@ or the @StreamARN@ . -- -- module Network.AWS.KinesisVideo.DescribeStream ( -- * Creating a Request describeStream , DescribeStream -- * Request Lenses , dStreamARN , dStreamName -- * Destructuring the Response , describeStreamResponse , DescribeStreamResponse -- * Response Lenses , drsStreamInfo , drsResponseStatus ) where import Network.AWS.KinesisVideo.Types import Network.AWS.KinesisVideo.Types.Product import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | /See:/ 'describeStream' smart constructor. data DescribeStream = DescribeStream' { _dStreamARN :: !(Maybe Text) , _dStreamName :: !(Maybe Text) } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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. describeStream :: DescribeStream describeStream = DescribeStream' {_dStreamARN = Nothing, _dStreamName = Nothing} -- | The Amazon Resource Name (ARN) of the stream. dStreamARN :: Lens' DescribeStream (Maybe Text) dStreamARN = lens _dStreamARN (\ s a -> s{_dStreamARN = a}) -- | The name of the stream. dStreamName :: Lens' DescribeStream (Maybe Text) dStreamName = lens _dStreamName (\ s a -> s{_dStreamName = a}) instance AWSRequest DescribeStream where type Rs DescribeStream = DescribeStreamResponse request = postJSON kinesisVideo response = receiveJSON (\ s h x -> DescribeStreamResponse' <$> (x .?> "StreamInfo") <*> (pure (fromEnum s))) instance Hashable DescribeStream where instance NFData DescribeStream where instance ToHeaders DescribeStream where toHeaders = const mempty instance ToJSON DescribeStream where toJSON DescribeStream'{..} = object (catMaybes [("StreamARN" .=) <$> _dStreamARN, ("StreamName" .=) <$> _dStreamName]) instance ToPath DescribeStream where toPath = const "/describeStream" instance ToQuery DescribeStream where toQuery = const mempty -- | /See:/ 'describeStreamResponse' smart constructor. data DescribeStreamResponse = DescribeStreamResponse' { _drsStreamInfo :: !(Maybe StreamInfo) , _drsResponseStatus :: !Int } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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. describeStreamResponse :: Int -- ^ 'drsResponseStatus' -> DescribeStreamResponse describeStreamResponse pResponseStatus_ = DescribeStreamResponse' {_drsStreamInfo = Nothing, _drsResponseStatus = pResponseStatus_} -- | An object that describes the stream. drsStreamInfo :: Lens' DescribeStreamResponse (Maybe StreamInfo) drsStreamInfo = lens _drsStreamInfo (\ s a -> s{_drsStreamInfo = a}) -- | -- | The response status code. drsResponseStatus :: Lens' DescribeStreamResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}) instance NFData DescribeStreamResponse where