Amazonka.Lightsail.TestAlarm

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Creating a Request

data TestAlarm

See: newTestAlarm smart constructor.

Constructors

TestAlarm'

Fields

• alarmName :: Text

  The name of the alarm to test.

• state :: AlarmState

  The alarm state to test.

  An alarm has the following possible states that can be tested:

  • ALARM - The metric is outside of the defined threshold.
  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
  • OK - The metric is within the defined threshold.

Instances

ToJSON TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

toJSON :: TestAlarm -> Value

toEncoding :: TestAlarm -> Encoding

toJSONList :: [TestAlarm] -> Value

toEncodingList :: [TestAlarm] -> Encoding

ToHeaders TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

toHeaders :: TestAlarm -> [Header]

ToPath TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

toPath :: TestAlarm -> ByteString

ToQuery TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

toQuery :: TestAlarm -> QueryString

AWSRequest TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Associated Types

type AWSResponse TestAlarm

Methods

request :: (Service -> Service) -> TestAlarm -> Request TestAlarm

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestAlarm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestAlarm)))

Generic TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Associated Types

type Rep TestAlarm :: Type -> Type

Methods

from :: TestAlarm -> Rep TestAlarm x

to :: Rep TestAlarm x -> TestAlarm

Read TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

readsPrec :: Int -> ReadS TestAlarm

readList :: ReadS [TestAlarm]

readPrec :: ReadPrec TestAlarm

readListPrec :: ReadPrec [TestAlarm]

Show TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

showsPrec :: Int -> TestAlarm -> ShowS

show :: TestAlarm -> String

showList :: [TestAlarm] -> ShowS

NFData TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

rnf :: TestAlarm -> ()

Eq TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

(==) :: TestAlarm -> TestAlarm -> Bool

(/=) :: TestAlarm -> TestAlarm -> Bool

Hashable TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

Methods

hashWithSalt :: Int -> TestAlarm -> Int

hash :: TestAlarm -> Int

type AWSResponse TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

type AWSResponse TestAlarm = TestAlarmResponse

type Rep TestAlarm

Defined in Amazonka.Lightsail.TestAlarm

type Rep TestAlarm = D1 ('MetaData "TestAlarm" "Amazonka.Lightsail.TestAlarm" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "TestAlarm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlarmState)))

newTestAlarm

Arguments

:: Text

$sel:alarmName:TestAlarm'

-> AlarmState

TestAlarm

-> TestAlarm

Create a value of TestAlarm with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarmName:TestAlarm', testAlarm_alarmName - The name of the alarm to test.

TestAlarm, testAlarm_state - The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.
• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
• OK - The metric is within the defined threshold.

Request Lenses

testAlarm_alarmName :: Lens' TestAlarm Text

The name of the alarm to test.

testAlarm_state :: Lens' TestAlarm AlarmState

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.
• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
• OK - The metric is within the defined threshold.

Destructuring the Response

data TestAlarmResponse

See: newTestAlarmResponse smart constructor.

Constructors

TestAlarmResponse'

Fields

• operations :: Maybe [Operation]

  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

Associated Types

type Rep TestAlarmResponse :: Type -> Type

Methods

from :: TestAlarmResponse -> Rep TestAlarmResponse x

to :: Rep TestAlarmResponse x -> TestAlarmResponse

Read TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

Methods

readsPrec :: Int -> ReadS TestAlarmResponse

readList :: ReadS [TestAlarmResponse]

readPrec :: ReadPrec TestAlarmResponse

readListPrec :: ReadPrec [TestAlarmResponse]

Show TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

Methods

showsPrec :: Int -> TestAlarmResponse -> ShowS

show :: TestAlarmResponse -> String

showList :: [TestAlarmResponse] -> ShowS

NFData TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

Methods

rnf :: TestAlarmResponse -> ()

Eq TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

Methods

(==) :: TestAlarmResponse -> TestAlarmResponse -> Bool

(/=) :: TestAlarmResponse -> TestAlarmResponse -> Bool

type Rep TestAlarmResponse

Defined in Amazonka.Lightsail.TestAlarm

type Rep TestAlarmResponse = D1 ('MetaData "TestAlarmResponse" "Amazonka.Lightsail.TestAlarm" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "TestAlarmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestAlarmResponse

Arguments

:: Int

$sel:httpStatus:TestAlarmResponse'

-> TestAlarmResponse

Create a value of TestAlarmResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:operations:TestAlarmResponse', testAlarmResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:TestAlarmResponse', testAlarmResponse_httpStatus - The response's http status code.

Response Lenses

testAlarmResponse_operations :: Lens' TestAlarmResponse (Maybe [Operation])

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

testAlarmResponse_httpStatus :: Lens' TestAlarmResponse Int

The response's http status code.