Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisVideo.GetDataEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data GetDataEndpoint Source #

See: newGetDataEndpoint smart constructor.

Constructors

GetDataEndpoint'

Fields

streamARN :: Maybe Text
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.
streamName :: Maybe Text
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.
aPIName :: APIName
The name of the API action for which to get an endpoint.

Instances

Instances details

ToJSON GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods toJSON :: GetDataEndpoint -> Value # toEncoding :: GetDataEndpoint -> Encoding # toJSONList :: [GetDataEndpoint] -> Value # toEncodingList :: [GetDataEndpoint] -> Encoding #
ToHeaders GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods toHeaders :: GetDataEndpoint -> [Header] #
ToPath GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods toPath :: GetDataEndpoint -> ByteString #
ToQuery GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods toQuery :: GetDataEndpoint -> QueryString #
AWSRequest GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Associated Types type AWSResponse GetDataEndpoint # Methods request :: (Service -> Service) -> GetDataEndpoint -> Request GetDataEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDataEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDataEndpoint))) #
Generic GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Associated Types type Rep GetDataEndpoint :: Type -> Type # Methods from :: GetDataEndpoint -> Rep GetDataEndpoint x # to :: Rep GetDataEndpoint x -> GetDataEndpoint #
Read GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods readsPrec :: Int -> ReadS GetDataEndpoint # readList :: ReadS [GetDataEndpoint] # readPrec :: ReadPrec GetDataEndpoint # readListPrec :: ReadPrec [GetDataEndpoint] #
Show GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods showsPrec :: Int -> GetDataEndpoint -> ShowS # show :: GetDataEndpoint -> String # showList :: [GetDataEndpoint] -> ShowS #
NFData GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods rnf :: GetDataEndpoint -> () #
Eq GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods (==) :: GetDataEndpoint -> GetDataEndpoint -> Bool # (/=) :: GetDataEndpoint -> GetDataEndpoint -> Bool #
Hashable GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods hashWithSalt :: Int -> GetDataEndpoint -> Int # hash :: GetDataEndpoint -> Int #
type AWSResponse GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint type AWSResponse GetDataEndpoint = GetDataEndpointResponse
type Rep GetDataEndpoint Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint type Rep GetDataEndpoint = D1 ('MetaData "GetDataEndpoint" "Amazonka.KinesisVideo.GetDataEndpoint" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "GetDataEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "aPIName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 APIName))))

newGetDataEndpoint Source #

Arguments

:: APIName	`$sel:aPIName:GetDataEndpoint'`
-> 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:

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.

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 dataEndpoint :: Maybe Text The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Associated Types type Rep GetDataEndpointResponse :: Type -> Type # Methods from :: GetDataEndpointResponse -> Rep GetDataEndpointResponse x # to :: Rep GetDataEndpointResponse x -> GetDataEndpointResponse #
Read GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods readsPrec :: Int -> ReadS GetDataEndpointResponse # readList :: ReadS [GetDataEndpointResponse] # readPrec :: ReadPrec GetDataEndpointResponse # readListPrec :: ReadPrec [GetDataEndpointResponse] #
Show GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods showsPrec :: Int -> GetDataEndpointResponse -> ShowS # show :: GetDataEndpointResponse -> String # showList :: [GetDataEndpointResponse] -> ShowS #
NFData GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods rnf :: GetDataEndpointResponse -> () #
Eq GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint Methods (==) :: GetDataEndpointResponse -> GetDataEndpointResponse -> Bool # (/=) :: GetDataEndpointResponse -> GetDataEndpointResponse -> Bool #
type Rep GetDataEndpointResponse Source #
Instance details Defined in Amazonka.KinesisVideo.GetDataEndpoint type Rep GetDataEndpointResponse = D1 ('MetaData "GetDataEndpointResponse" "Amazonka.KinesisVideo.GetDataEndpoint" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "GetDataEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetDataEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDataEndpointResponse'`
-> GetDataEndpointResponse

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.