You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::GetAlarmsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetAlarmsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  alarm_name: "ResourceName",
  page_token: "string",
  monitored_resource_name: "ResourceName",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_name ⇒ String

The name of the alarm.

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

Returns:

  • (String) —

    The name of the alarm.

#monitored_resource_name ⇒ String

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.

Returns:

  • (String) —

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

#page_token ⇒ 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.

Returns:

  • (String) —

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