describeStream method

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

Gets information about a stream.

Requires permission to access the DescribeStream action.

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

Parameter streamId : The stream ID.

Implementation

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