describeStream method

Future<DescribeStreamOutput> describeStream({
  1. String? streamARN,
  2. String? streamName,
})

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

May throw InvalidArgumentException. May throw ResourceNotFoundException. May throw ClientLimitExceededException. May throw NotAuthorizedException.

Parameter streamARN : The Amazon Resource Name (ARN) of the stream.

Parameter streamName : The name of the stream.

Implementation

Future<DescribeStreamOutput> describeStream({
  String? streamARN,
  String? streamName,
}) async {
  _s.validateStringLength(
    'streamARN',
    streamARN,
    1,
    1024,
  );
  _s.validateStringLength(
    'streamName',
    streamName,
    1,
    256,
  );
  final $payload = <String, dynamic>{
    if (streamARN != null) 'StreamARN': streamARN,
    if (streamName != null) 'StreamName': streamName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/describeStream',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeStreamOutput.fromJson(response);
}