deleteSignalingChannel method

Future<void> deleteSignalingChannel({ required String channelARN, String? currentVersion, })

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.

May throw InvalidArgumentException. May throw ClientLimitExceededException. May throw ResourceNotFoundException. May throw AccessDeniedException. May throw VersionMismatchException. May throw ResourceInUseException.

Parameter channelARN : The Amazon Resource Name (ARN) of the signaling channel that you want to delete.

Parameter currentVersion : The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels API operations.

Implementation

Future<void> deleteSignalingChannel({
  required String channelARN,
  String? currentVersion,
}) async {
  ArgumentError.checkNotNull(channelARN, 'channelARN');
  _s.validateStringLength(
    'channelARN',
    channelARN,
    1,
    1024,
    isRequired: true,
  );
  _s.validateStringLength(
    'currentVersion',
    currentVersion,
    1,
    64,
  );
  final $payload = <String, dynamic>{
    'ChannelARN': channelARN,
    if (currentVersion != null) 'CurrentVersion': currentVersion,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/deleteSignalingChannel',
    exceptionFnMap: _exceptionFns,
  );
}