Module Values.DescribeStreamSummaryOutputSource

Provides a summarized description of the specified Kinesis data stream without the shard list. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. DescribeStreamSummary has a limit of 20 transactions per second per account.

Sourcetype nonrec t = {
  1. streamDescriptionSummary : StreamDescriptionSummary.t option;
    (*

    A StreamDescriptionSummary containing information about the stream.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InvalidArgumentException of InvalidArgumentException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?streamDescriptionSummary:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.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 -> [> `AccessDeniedException of AccessDeniedException.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 | `Integer of RetentionPeriodHours.t | `List of [> `Structure of (string * [> `List of [> `Enum of string ] list ]) list ] list | `String of StreamName.t | `Structure of (string * [> `Enum of string | `Integer of NaturalIntegerObject.t ]) list | `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