Skip to contents

Retrieves the history for the specified alarm

Source: R/cloudwatch_operations.R
cloudwatch_describe_alarm_history.Rd

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

See https://www.paws-r-sdk.com/docs/cloudwatch_describe_alarm_history/ for full documentation.

Usage

cloudwatch_describe_alarm_history(
  AlarmName = NULL,
  AlarmContributorId = NULL,
  AlarmTypes = NULL,
  HistoryItemType = NULL,
  StartDate = NULL,
  EndDate = NULL,
  MaxRecords = NULL,
  NextToken = NULL,
  ScanBy = NULL
)

Arguments

AlarmName

The name of the alarm.

AlarmContributorId

The unique identifier of a specific alarm contributor to filter the alarm history results.

AlarmTypes

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

HistoryItemType

The type of alarm histories to retrieve.

StartDate

The starting date to retrieve alarm history.

EndDate

The ending date to retrieve alarm history.

MaxRecords

The maximum number of alarm history records to retrieve.

NextToken

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

ScanBy

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.