describeSignalingChannel method

Future<DescribeSignalingChannelOutput> describeSignalingChannel({ String? channelARN, String? channelName, })

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.

May throw InvalidArgumentException. May throw ClientLimitExceededException. May throw ResourceNotFoundException. May throw AccessDeniedException.

Parameter channelARN : The ARN of the signaling channel that you want to describe.

Parameter channelName : The name of the signaling channel that you want to describe.

Implementation

Future<DescribeSignalingChannelOutput> describeSignalingChannel({
  String? channelARN,
  String? channelName,
}) async {
  _s.validateStringLength(
    'channelARN',
    channelARN,
    1,
    1024,
  );
  _s.validateStringLength(
    'channelName',
    channelName,
    1,
    256,
  );
  final $payload = <String, dynamic>{
    if (channelARN != null) 'ChannelARN': channelARN,
    if (channelName != null) 'ChannelName': channelName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/describeSignalingChannel',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeSignalingChannelOutput.fromJson(response);
}