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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass GetAlarmsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm.

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

Returns:

  • (String)


5101
5102
5103
5104
5105
5106
5107
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5101

class GetAlarmsRequest < Struct.new(
  :alarm_name,
  :page_token,
  :monitored_resource_name)
  SENSITIVE = []
  include Aws::Structure
end

#monitored_resource_nameString

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)


5101
5102
5103
5104
5105
5106
5107
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5101

class GetAlarmsRequest < Struct.new(
  :alarm_name,
  :page_token,
  :monitored_resource_name)
  SENSITIVE = []
  include Aws::Structure
end

#page_tokenString

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)


5101
5102
5103
5104
5105
5106
5107
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5101

class GetAlarmsRequest < Struct.new(
  :alarm_name,
  :page_token,
  :monitored_resource_name)
  SENSITIVE = []
  include Aws::Structure
end