| 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.DescribeSignalingChannel
Description
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
Synopsis
- data DescribeSignalingChannel = DescribeSignalingChannel' {
- channelARN :: Maybe Text
- channelName :: Maybe Text
- newDescribeSignalingChannel :: DescribeSignalingChannel
- describeSignalingChannel_channelARN :: Lens' DescribeSignalingChannel (Maybe Text)
- describeSignalingChannel_channelName :: Lens' DescribeSignalingChannel (Maybe Text)
- data DescribeSignalingChannelResponse = DescribeSignalingChannelResponse' {}
- newDescribeSignalingChannelResponse :: Int -> DescribeSignalingChannelResponse
- describeSignalingChannelResponse_channelInfo :: Lens' DescribeSignalingChannelResponse (Maybe ChannelInfo)
- describeSignalingChannelResponse_httpStatus :: Lens' DescribeSignalingChannelResponse Int
Creating a Request
data DescribeSignalingChannel Source #
See: newDescribeSignalingChannel smart constructor.
Constructors
| DescribeSignalingChannel' | |
Fields
| |
Instances
newDescribeSignalingChannel :: DescribeSignalingChannel Source #
Create a value of DescribeSignalingChannel 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:channelARN:DescribeSignalingChannel', describeSignalingChannel_channelARN - The ARN of the signaling channel that you want to describe.
$sel:channelName:DescribeSignalingChannel', describeSignalingChannel_channelName - The name of the signaling channel that you want to describe.
Request Lenses
describeSignalingChannel_channelARN :: Lens' DescribeSignalingChannel (Maybe Text) Source #
The ARN of the signaling channel that you want to describe.
describeSignalingChannel_channelName :: Lens' DescribeSignalingChannel (Maybe Text) Source #
The name of the signaling channel that you want to describe.
Destructuring the Response
data DescribeSignalingChannelResponse Source #
See: newDescribeSignalingChannelResponse smart constructor.
Constructors
| DescribeSignalingChannelResponse' | |
Fields
| |
Instances
newDescribeSignalingChannelResponse Source #
Create a value of DescribeSignalingChannelResponse 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:channelInfo:DescribeSignalingChannelResponse', describeSignalingChannelResponse_channelInfo - A structure that encapsulates the specified signaling channel's
metadata and properties.
$sel:httpStatus:DescribeSignalingChannelResponse', describeSignalingChannelResponse_httpStatus - The response's http status code.
Response Lenses
describeSignalingChannelResponse_channelInfo :: Lens' DescribeSignalingChannelResponse (Maybe ChannelInfo) Source #
A structure that encapsulates the specified signaling channel's metadata and properties.
describeSignalingChannelResponse_httpStatus :: Lens' DescribeSignalingChannelResponse Int Source #
The response's http status code.