registerStreamConsumer method

Future<RegisterStreamConsumerOutput> registerStreamConsumer({
  1. required String consumerName,
  2. required String streamARN,
})

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.

For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.

The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.

May throw InvalidArgumentException. May throw LimitExceededException. May throw ResourceInUseException. May throw ResourceNotFoundException.

Parameter consumerName : For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Parameter streamARN : The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Implementation

Future<RegisterStreamConsumerOutput> registerStreamConsumer({
  required String consumerName,
  required String streamARN,
}) async {
  ArgumentError.checkNotNull(consumerName, 'consumerName');
  _s.validateStringLength(
    'consumerName',
    consumerName,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(streamARN, 'streamARN');
  _s.validateStringLength(
    'streamARN',
    streamARN,
    1,
    2048,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Kinesis_20131202.RegisterStreamConsumer'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ConsumerName': consumerName,
      'StreamARN': streamARN,
    },
  );

  return RegisterStreamConsumerOutput.fromJson(jsonResponse.body);
}