paws.management (version 0.1.0)

cloudwatch_describe_alarms: Retrieves the specified alarms

Description

Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Usage

cloudwatch_describe_alarms(AlarmNames, AlarmNamePrefix, StateValue,
  ActionPrefix, MaxRecords, NextToken)

Arguments

AlarmNames

The names of the alarms.

AlarmNamePrefix

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

StateValue

The state value to be used in matching alarms.

ActionPrefix

The action name prefix.

MaxRecords

The maximum number of alarm descriptions to retrieve.

NextToken

The token returned by a previous call to indicate that there is more data available.

Request syntax

svc$describe_alarms(
  AlarmNames = list(
    "string"
  ),
  AlarmNamePrefix = "string",
  StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA",
  ActionPrefix = "string",
  MaxRecords = 123,
  NextToken = "string"
)