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.GetSignalingChannelEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Synopsis

Creating a Request

data GetSignalingChannelEndpoint Source #

See: newGetSignalingChannelEndpoint smart constructor.

Constructors

GetSignalingChannelEndpoint'
Fields singleMasterChannelEndpointConfiguration :: Maybe SingleMasterChannelEndpointConfiguration A structure containing the endpoint configuration for the `SINGLE_MASTER` channel type. channelARN :: Text The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Instances

Instances details

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

newGetSignalingChannelEndpoint Source #

Arguments

:: Text	`GetSignalingChannelEndpoint`
-> GetSignalingChannelEndpoint

Create a value of GetSignalingChannelEndpoint 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:singleMasterChannelEndpointConfiguration:GetSignalingChannelEndpoint', getSignalingChannelEndpoint_singleMasterChannelEndpointConfiguration - A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

GetSignalingChannelEndpoint, getSignalingChannelEndpoint_channelARN - The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Request Lenses

getSignalingChannelEndpoint_singleMasterChannelEndpointConfiguration :: Lens' GetSignalingChannelEndpoint (Maybe SingleMasterChannelEndpointConfiguration) Source #

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

getSignalingChannelEndpoint_channelARN :: Lens' GetSignalingChannelEndpoint Text Source #

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Destructuring the Response

data GetSignalingChannelEndpointResponse Source #

See: newGetSignalingChannelEndpointResponse smart constructor.

Constructors

GetSignalingChannelEndpointResponse'
Fields resourceEndpointList :: Maybe [ResourceEndpointListItem] A list of endpoints for the specified signaling channel. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetSignalingChannelEndpointResponse Source #

Arguments

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

Create a value of GetSignalingChannelEndpointResponse 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:resourceEndpointList:GetSignalingChannelEndpointResponse', getSignalingChannelEndpointResponse_resourceEndpointList - A list of endpoints for the specified signaling channel.

$sel:httpStatus:GetSignalingChannelEndpointResponse', getSignalingChannelEndpointResponse_httpStatus - The response's http status code.

Response Lenses

getSignalingChannelEndpointResponse_resourceEndpointList :: Lens' GetSignalingChannelEndpointResponse (Maybe [ResourceEndpointListItem]) Source #

A list of endpoints for the specified signaling channel.

getSignalingChannelEndpointResponse_httpStatus :: Lens' GetSignalingChannelEndpointResponse Int Source #

The response's http status code.