# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon Lightsail Alarms API
  version: 1.0.0
extends: openapi/amazon-lightsail-alarms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/ls/api/2016-11-28/DeleteAlarm/{alarmName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a metric alarm
      effect: destructive
      questions:
      - How do I get rid of an alarm I no longer need?
      - Will deleting an alarm stop its email and SMS notifications?
      instructions:
      - text: Delete the alarm {alarmName}.
        slots:
          alarmName: path.alarmName
      - text: Remove alarm {alarmName} from my Lightsail account.
        slots:
          alarmName: path.alarmName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetAlarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured metric alarms
      effect: read
      questions:
      - Which alarms are set up on my Lightsail resources?
      - Can I see only the alarms watching one particular instance?
      instructions:
      - text: List all my alarms.
      - text: Show the alarms monitoring {monitoredResourceName}.
        slots:
          monitoredResourceName: query.monitoredResourceName
      - text: Get the configuration and state of alarm {alarmName}.
        slots:
          alarmName: query.alarmName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/PutAlarm'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a metric alarm
      effect: write
      questions:
      - How do I get alerted when my instance CPU goes over 80%?
      - Can one alarm notify me by both email and SMS?
      - What happens if the metric has missing data points?
      instructions:
      - text: Create alarm {alarmName} on {monitoredResourceName} when {metricName} is {comparisonOperator} {threshold} for {evaluationPeriods} periods.
        slots:
          alarmName: requestBody.alarmName
          monitoredResourceName: requestBody.monitoredResourceName
          metricName: requestBody.metricName
          comparisonOperator: requestBody.comparisonOperator
          threshold: requestBody.threshold
          evaluationPeriods: requestBody.evaluationPeriods
      - text: Update alarm {alarmName} to notify me via {contactProtocols}.
        slots:
          alarmName: requestBody.alarmName
          contactProtocols: requestBody.contactProtocols
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/TestAlarm/{alarmName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Test an alarm's notifications
      effect: write
      questions:
      - How can I check that an alarm actually sends me a notification?
      - Can I simulate an alarm going into ALARM state without a real spike?
      instructions:
      - text: Test alarm {alarmName} in the {state} state.
        slots:
          alarmName: path.alarmName
          state: query.state
      - text: Fire a test notification for {alarmName} as if it were {state}.
        slots:
          alarmName: path.alarmName
          state: query.state
      method: generated
      generated: '2026-09-26'