Module Values.DescribeStreamConsumerOutputSource

To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. This operation has a limit of 20 transactions per second per stream. When making a cross-account call with DescribeStreamConsumer, make sure to provide the ARN of the consumer.

Sourcetype nonrec t = {
  1. consumerDescription : ConsumerDescription.t option;
    (*

    An object that represents the details of the consumer.

    *)
}
Sourcetype nonrec error = [
  1. | `InvalidArgumentException of InvalidArgumentException.t
  2. | `LimitExceededException of LimitExceededException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval make : ?consumerDescription:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InvalidArgumentException of InvalidArgumentException.t | `LimitExceededException of LimitExceededException.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 | `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