Skip to content

GetAlarmsRequest

Source code in docs_src/capo_lightsail/types/get_alarms_request.py 
12
13
14
15
16
17
18
19
20
class GetAlarmsRequest(TypedDict, closed=True):
    alarm_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the alarm.</p> <p>Specify an alarm name to return information about a specific alarm.</p>"""
    page_token: NotRequired["capo_lightsail.types.string.string"]
    """<p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetAlarms</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p>"""
    monitored_resource_name: NotRequired[
        "capo_lightsail.types.resource_name.ResourceName"
    ]
    """<p>The name of the Lightsail resource being monitored by the alarm.</p> <p>Specify a monitored resource name to return information about all alarms for a specific resource.</p>"""

alarm_name instance-attribute 

alarm_name: NotRequired[ResourceName]

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

monitored_resource_name instance-attribute 

monitored_resource_name: NotRequired[ResourceName]

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

page_token instance-attribute 

page_token: NotRequired[string]

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.