| Copyright | (c) 2013-2021 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 |
Amazonka.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).
The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by StreamName or
StreamARN.
Synopsis
- data GetDataEndpoint = GetDataEndpoint' {}
- newGetDataEndpoint :: APIName -> GetDataEndpoint
- getDataEndpoint_streamARN :: Lens' GetDataEndpoint (Maybe Text)
- getDataEndpoint_streamName :: Lens' GetDataEndpoint (Maybe Text)
- getDataEndpoint_aPIName :: Lens' GetDataEndpoint APIName
- data GetDataEndpointResponse = GetDataEndpointResponse' {
- dataEndpoint :: Maybe Text
- httpStatus :: Int
- newGetDataEndpointResponse :: Int -> GetDataEndpointResponse
- getDataEndpointResponse_dataEndpoint :: Lens' GetDataEndpointResponse (Maybe Text)
- getDataEndpointResponse_httpStatus :: Lens' GetDataEndpointResponse Int
Creating a Request
data GetDataEndpoint Source #
See: newGetDataEndpoint smart constructor.
Constructors
| GetDataEndpoint' | |
Fields
| |
Instances
Arguments
| :: APIName | |
| -> GetDataEndpoint |
Create a value of GetDataEndpoint 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:streamARN:GetDataEndpoint', getDataEndpoint_streamARN - 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.
$sel:streamName:GetDataEndpoint', getDataEndpoint_streamName - 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.
$sel:aPIName:GetDataEndpoint', getDataEndpoint_aPIName - The name of the API action for which to get an endpoint.
Request Lenses
getDataEndpoint_streamARN :: 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.
getDataEndpoint_streamName :: 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.
getDataEndpoint_aPIName :: Lens' GetDataEndpoint APIName Source #
The name of the API action for which to get an endpoint.
Destructuring the Response
data GetDataEndpointResponse Source #
See: newGetDataEndpointResponse smart constructor.
Constructors
| GetDataEndpointResponse' | |
Fields
| |
Instances
newGetDataEndpointResponse Source #
Create a value of GetDataEndpointResponse 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:dataEndpoint:GetDataEndpointResponse', getDataEndpointResponse_dataEndpoint - The endpoint value. To read data from the stream or to write data to it,
specify this endpoint in your application.
$sel:httpStatus:GetDataEndpointResponse', getDataEndpointResponse_httpStatus - The response's http status code.
Response Lenses
getDataEndpointResponse_dataEndpoint :: 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.
getDataEndpointResponse_httpStatus :: Lens' GetDataEndpointResponse Int Source #
The response's http status code.