describeStream method

Future<DescribeStreamResponse> describeStream({
  1. required String streamId,
})

Gets information about a stream.

May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw UnauthorizedException. May throw ServiceUnavailableException. May throw InternalFailureException.

Parameter streamId : The stream ID.

Implementation

Future<DescribeStreamResponse> describeStream({
  required String streamId,
}) async {
  ArgumentError.checkNotNull(streamId, 'streamId');
  _s.validateStringLength(
    'streamId',
    streamId,
    1,
    128,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/streams/${Uri.encodeComponent(streamId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeStreamResponse.fromJson(response);
}