amazonka-kinesis-video-1.6.0: Amazon Kinesis Video Streams SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KinesisVideo.GetDataEndpoint

Contents

Description

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

In the request, specify the stream either by StreamName or StreamARN .

Synopsis

Creating a Request

getDataEndpoint Source #

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

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

  • gdeStreamARN - The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.
  • gdeStreamName - The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.
  • gdeAPIName - The name of the API action for which to get an endpoint.

data GetDataEndpoint Source #

See: getDataEndpoint smart constructor.

Instances

Eq GetDataEndpoint Source # 
Data GetDataEndpoint Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDataEndpoint -> c GetDataEndpoint #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDataEndpoint #

toConstr :: GetDataEndpoint -> Constr #

dataTypeOf :: GetDataEndpoint -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDataEndpoint) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDataEndpoint) #

gmapT :: (forall b. Data b => b -> b) -> GetDataEndpoint -> GetDataEndpoint #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDataEndpoint -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDataEndpoint -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetDataEndpoint -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDataEndpoint -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDataEndpoint -> m GetDataEndpoint #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDataEndpoint -> m GetDataEndpoint #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDataEndpoint -> m GetDataEndpoint #

Read GetDataEndpoint Source # 
Show GetDataEndpoint Source # 
Generic GetDataEndpoint Source # 
Hashable GetDataEndpoint Source # 
ToJSON GetDataEndpoint Source # 
NFData GetDataEndpoint Source # 

Methods

rnf :: GetDataEndpoint -> () #

AWSRequest GetDataEndpoint Source # 
ToHeaders GetDataEndpoint Source # 
ToPath GetDataEndpoint Source # 
ToQuery GetDataEndpoint Source # 
type Rep GetDataEndpoint Source # 
type Rep GetDataEndpoint = D1 * (MetaData "GetDataEndpoint" "Network.AWS.KinesisVideo.GetDataEndpoint" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "GetDataEndpoint'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdeStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdeStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdeAPIName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * APIName)))))
type Rs GetDataEndpoint Source # 

Request Lenses

gdeStreamARN :: Lens' GetDataEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

gdeStreamName :: Lens' GetDataEndpoint (Maybe Text) Source #

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

gdeAPIName :: Lens' GetDataEndpoint APIName Source #

The name of the API action for which to get an endpoint.

Destructuring the Response

getDataEndpointResponse Source #

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

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

  • gdersDataEndpoint - The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.
  • gdersResponseStatus - -- | The response status code.

data GetDataEndpointResponse Source #

See: getDataEndpointResponse smart constructor.

Instances

Eq GetDataEndpointResponse Source # 
Data GetDataEndpointResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDataEndpointResponse -> c GetDataEndpointResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDataEndpointResponse #

toConstr :: GetDataEndpointResponse -> Constr #

dataTypeOf :: GetDataEndpointResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDataEndpointResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDataEndpointResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetDataEndpointResponse -> GetDataEndpointResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDataEndpointResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDataEndpointResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetDataEndpointResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDataEndpointResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDataEndpointResponse -> m GetDataEndpointResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDataEndpointResponse -> m GetDataEndpointResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDataEndpointResponse -> m GetDataEndpointResponse #

Read GetDataEndpointResponse Source # 
Show GetDataEndpointResponse Source # 
Generic GetDataEndpointResponse Source # 
NFData GetDataEndpointResponse Source # 

Methods

rnf :: GetDataEndpointResponse -> () #

type Rep GetDataEndpointResponse Source # 
type Rep GetDataEndpointResponse = D1 * (MetaData "GetDataEndpointResponse" "Network.AWS.KinesisVideo.GetDataEndpoint" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "GetDataEndpointResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdersDataEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

gdersDataEndpoint :: Lens' GetDataEndpointResponse (Maybe Text) Source #

The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.