| 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.GetDataEndpoint
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 .
- getDataEndpoint :: APIName -> GetDataEndpoint
- data GetDataEndpoint
- gdeStreamARN :: Lens' GetDataEndpoint (Maybe Text)
- gdeStreamName :: Lens' GetDataEndpoint (Maybe Text)
- gdeAPIName :: Lens' GetDataEndpoint APIName
- getDataEndpointResponse :: Int -> GetDataEndpointResponse
- data GetDataEndpointResponse
- gdersDataEndpoint :: Lens' GetDataEndpointResponse (Maybe Text)
- gdersResponseStatus :: Lens' GetDataEndpointResponse Int
Creating a Request
Arguments
| :: APIName | |
| -> GetDataEndpoint |
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 aStreamNamein the request.gdeStreamName- The name of the stream that you want to get the endpoint for. You must specify either this parameter or aStreamARNin the request.gdeAPIName- The name of the API action for which to get an endpoint.
data GetDataEndpoint Source #
See: getDataEndpoint smart constructor.
Instances
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 #
Arguments
| :: Int | |
| -> GetDataEndpointResponse |
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.
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.
gdersResponseStatus :: Lens' GetDataEndpointResponse Int Source #
- - | The response status code.