Module Values.RegisterStreamConsumerOutputSource

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 add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer. With On-demand Advantage streams, you can register up to 50 consumers per stream to use Enhanced Fan-out. With On-demand Standard and Provisioned streams, you can register up to 20 consumers per stream to use Enhanced Fan-out. A given consumer can only be registered with one stream at a time. For an example of how to use this operation, 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.

Sourcetype nonrec t = {
  1. consumer : Consumer.t option;
    (*

    An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

    *)
}
Sourcetype nonrec error = [
  1. | `InvalidArgumentException of InvalidArgumentException.t
  2. | `LimitExceededException of LimitExceededException.t
  3. | `ResourceInUseException of ResourceInUseException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?consumer:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InvalidArgumentException of InvalidArgumentException.t | `LimitExceededException of LimitExceededException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InvalidArgumentException of InvalidArgumentException.t | `LimitExceededException of LimitExceededException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of ConsumerName.t | `Timestamp of Timestamp.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t