listTagsForStream method

Future<ListTagsForStreamOutput> listTagsForStream({ String? nextToken, String? streamARN, String? streamName, })

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

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

Parameter nextToken : If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

Parameter streamARN : The Amazon Resource Name (ARN) of the stream that you want to list tags for.

Parameter streamName : The name of the stream that you want to list tags for.

Implementation

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