Module Values.DescribeAlarmsOutputSource

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action. To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

Sourcetype describeAlarmsResult = {
  1. compositeAlarms : CompositeAlarms.t option;
    (*

    The information about any composite alarms returned by the operation.

    *)
  2. metricAlarms : MetricAlarms.t option;
    (*

    The information about any metric alarms returned by the operation.

    *)
  3. nextToken : NextToken.t option;
    (*

    The token that marks the start of the next batch of returned results.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. describeAlarmsResult : describeAlarmsResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `InvalidNextToken of InvalidNextToken.t
  2. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?compositeAlarms:??? -> ?metricAlarms:??? -> ?nextToken:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InvalidNextToken of InvalidNextToken.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InvalidNextToken of InvalidNextToken.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 * [> `List of [> `Structure of (string * [> `Boolean of ActionsEnabled.t | `Double of Threshold.t | `Enum of string | `Integer of SuppressorPeriod.t | `List of [> `String of ResourceName.t | `Structure of (string * [> `Boolean of ReturnData.t | `Integer of Period.t | `String of DimensionName.t | `Structure of (string * [> `Enum of string | `Integer of Period.t | `String of Stat.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of DimensionName.t ]) list ] list | `String of Namespace.t ]) list ]) list ]) list ] list | `String of AlarmArn.t | `Structure of (string * [> `Structure of (string * [> `Integer of PendingPeriod.t | `String of Query.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ] list | `String of NextToken.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