Skip to content

DescribeAlarmHistoryInput

Source code in docs_src/capo_cloudwatch/types/describe_alarm_history_input.py
class DescribeAlarmHistoryInput(TypedDict, closed=True):
    alarm_name: NotRequired["capo_cloudwatch.types.alarm_name.AlarmName"]
    """<p>The name of the alarm.</p>"""
    alarm_contributor_id: NotRequired[
        "capo_cloudwatch.types.contributor_id.ContributorId"
    ]
    """<p>The unique identifier of a specific alarm contributor to filter the alarm history results.</p>"""
    alarm_types: NotRequired["capo_cloudwatch.types.alarm_types.AlarmTypes"]
    """<p>Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned.</p>"""
    history_item_type: NotRequired[
        "capo_cloudwatch.types.history_item_type.HistoryItemType"
    ]
    """<p>The type of alarm histories to retrieve.</p>"""
    start_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The starting date to retrieve alarm history.</p>"""
    end_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The ending date to retrieve alarm history.</p>"""
    max_records: NotRequired["capo_cloudwatch.types.max_records.MaxRecords"]
    """<p>The maximum number of alarm history records to retrieve.</p>"""
    next_token: NotRequired["capo_cloudwatch.types.next_token.NextToken"]
    """<p>The token returned by a previous call to indicate that there is more data available.</p>"""
    scan_by: NotRequired["capo_cloudwatch.types.scan_by.ScanBy"]
    """<p>Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.</p>"""

alarm_contributor_id instance-attribute

alarm_contributor_id: NotRequired[ContributorId]

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

alarm_name instance-attribute

alarm_name: NotRequired[AlarmName]

The name of the alarm.

alarm_types instance-attribute

alarm_types: NotRequired[AlarmTypes]

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

end_date instance-attribute

end_date: NotRequired[Timestamp]

The ending date to retrieve alarm history.

history_item_type instance-attribute

history_item_type: NotRequired[HistoryItemType]

The type of alarm histories to retrieve.

max_records instance-attribute

max_records: NotRequired[MaxRecords]

The maximum number of alarm history records to retrieve.

next_token instance-attribute

next_token: NotRequired[NextToken]

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

scan_by instance-attribute

scan_by: NotRequired[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.

start_date instance-attribute

start_date: NotRequired[Timestamp]

The starting date to retrieve alarm history.