Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Relational Databases API

23 actions 23 updates phrasing extends openapi/amazon-lightsail-relational-databases-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon Lightsail's API. It is a proposal applied on top of the contract, not a document Amazon Lightsail publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 23 · first 16 shown; the file carries all of them

$.info
$.paths['/ls/api/2016-11-28/CreateRelationalDatabase'].post
$.paths['/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot'].post
$.paths['/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot'].post
$.paths['/ls/api/2016-11-28/DeleteRelationalDatabase'].post
$.paths['/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabase'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseBlueprints'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseBundles'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseEvents'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseLogEvents'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseLogStreams'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseMetricData'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseParameters'].post
$.paths['/ls/api/2016-11-28/GetRelationalDatabaseSnapshot'].post

OpenAPI Overlay

Raw ↑
# 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 Relational Databases API
  version: 1.0.0
extends: openapi/amazon-lightsail-relational-databases-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: 22
- target: $.paths['/ls/api/2016-11-28/CreateRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a managed database
      effect: write
      questions:
      - How do I spin up a managed MySQL or PostgreSQL database in Lightsail?
      - Can I choose the backup and maintenance windows when creating a database?
      - Can a new database be publicly accessible from the internet?
      instructions:
      - text: Create database {relationalDatabaseName} with engine {relationalDatabaseBlueprintId} on plan {relationalDatabaseBundleId}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          relationalDatabaseBlueprintId: requestBody.relationalDatabaseBlueprintId
          relationalDatabaseBundleId: requestBody.relationalDatabaseBundleId
      - text: Create a new managed database {relationalDatabaseName} in {availabilityZone} with public access {publiclyAccessible}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          availabilityZone: requestBody.availabilityZone
          publiclyAccessible: requestBody.publiclyAccessible
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a database from a snapshot or point in time
      effect: write
      questions:
      - How do I restore a database from one of its snapshots?
      - Can I restore a database to a specific point in time?
      instructions:
      - text: Create database {relationalDatabaseName} from snapshot {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      - text: Restore {sourceRelationalDatabaseName} as it was at {restoreTime} into new database {relationalDatabaseName}.
        slots:
          sourceRelationalDatabaseName: requestBody.sourceRelationalDatabaseName
          restoreTime: requestBody.restoreTime
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a snapshot of a database
      effect: write
      questions:
      - How can I back up my managed database right now?
      - Can I use a database snapshot to create a new database later?
      instructions:
      - text: Snapshot database {relationalDatabaseName} as {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      - text: Create database snapshot {relationalDatabaseSnapshotName} of {relationalDatabaseName}.
        slots:
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a managed database
      effect: destructive
      questions:
      - How do I delete a database but keep a final snapshot?
      - Can I skip the final snapshot when deleting a database?
      instructions:
      - text: Delete database {relationalDatabaseName}, saving final snapshot {finalRelationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          finalRelationalDatabaseSnapshotName: requestBody.finalRelationalDatabaseSnapshotName
      - text: Delete {relationalDatabaseName} with skip final snapshot set to {skipFinalSnapshot}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          skipFinalSnapshot: requestBody.skipFinalSnapshot
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a database snapshot
      effect: destructive
      questions:
      - How do I remove an old database snapshot?
      - Will deleting a database snapshot affect the running database?
      instructions:
      - text: Delete database snapshot {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      - text: Remove the DB backup {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one database's details
      effect: read
      questions:
      - What's the endpoint and port of my managed database?
      - Is a specific database available or still being created?
      instructions:
      - text: Get database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Show the endpoint, engine and state of {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseBlueprints'].post
  update:
    x-apievangelist-phrasing:
      intent: List database engines and versions
      effect: read
      questions:
      - Which MySQL and PostgreSQL versions can I create?
      - What database blueprints are available?
      instructions:
      - text: List the database blueprints.
      - text: Get more database engine versions from page {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseBundles'].post
  update:
    x-apievangelist-phrasing:
      intent: List database plans
      effect: read
      questions:
      - What database sizes and monthly prices are offered?
      - Are high-availability database plans available?
      instructions:
      - text: List the database bundles.
      - text: List database plans including inactive ones ({includeInactive}).
        slots:
          includeInactive: requestBody.includeInactive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: List recent events for a database
      effect: read
      questions:
      - What happened to my database in the last few hours — backups, reboots, failovers?
      - Can I look back further than one day of database events?
      instructions:
      - text: List events for database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Show {relationalDatabaseName} events from the last {durationInMinutes} minutes.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          durationInMinutes: requestBody.durationInMinutes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseLogEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Read a database log stream
      effect: read
      questions:
      - How do I read the error log of my managed database?
      - Can I pull slow query log entries between two times?
      instructions:
      - text: Get {logStreamName} log events for {relationalDatabaseName}.
        slots:
          logStreamName: requestBody.logStreamName
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Show {relationalDatabaseName} {logStreamName} entries from {startTime} to {endTime}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          logStreamName: requestBody.logStreamName
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseLogStreams'].post
  update:
    x-apievangelist-phrasing:
      intent: List a database's log streams
      effect: read
      questions:
      - Which log streams (error, general, slow query) does my database have?
      - What log names can I read for a given database?
      instructions:
      - text: List log streams for database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Show the available log names on {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a database's master user password
      effect: read
      questions:
      - I forgot my database admin password — can I retrieve it?
      - Can I see the pending or previous master password after a rotation?
      instructions:
      - text: Get the master user password for {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Show the {passwordVersion} master password of {relationalDatabaseName}.
        slots:
          passwordVersion: requestBody.passwordVersion
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseMetricData'].post
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a database
      effect: read
      questions:
      - How high is my database's CPU utilization?
      - Can I chart database connections or free storage over time?
      instructions:
      - text: Get {metricName} for database {relationalDatabaseName} from {startTime} to {endTime} every {period}s as {statistics} in {unit}.
        slots:
          metricName: requestBody.metricName
          relationalDatabaseName: requestBody.relationalDatabaseName
          startTime: requestBody.startTime
          endTime: requestBody.endTime
          period: requestBody.period
          statistics: requestBody.statistics
          unit: requestBody.unit
      - text: Show database {relationalDatabaseName} {metricName} since {startTime}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          metricName: requestBody.metricName
          startTime: requestBody.startTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseParameters'].post
  update:
    x-apievangelist-phrasing:
      intent: List a database's engine parameters
      effect: read
      questions:
      - What engine settings like max_connections is my database using?
      - Which database parameters can be changed and do they need a reboot?
      instructions:
      - text: List engine parameters for {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Get more parameters of {relationalDatabaseName} from page {pageToken}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one database snapshot's details
      effect: read
      questions:
      - Is my database snapshot complete?
      - Which engine version was a particular database snapshot taken from?
      instructions:
      - text: Get database snapshot {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      - text: Show the state and size of DB snapshot {relationalDatabaseSnapshotName}.
        slots:
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabaseSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List all database snapshots
      effect: read
      questions:
      - What database snapshots do I have?
      - Can I page through every managed database backup?
      instructions:
      - text: List all my database snapshots.
      - text: Get the next page of database snapshots using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetRelationalDatabases'].post
  update:
    x-apievangelist-phrasing:
      intent: List all managed databases
      effect: read
      questions:
      - Which managed databases am I running?
      - Is there a way to page through all my Lightsail databases?
      instructions:
      - text: List all my managed databases.
      - text: Get the next page of databases using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/RebootRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Reboot a database
      effect: write
      questions:
      - How do I restart my managed database to apply parameter changes?
      - Will rebooting a database cause downtime?
      instructions:
      - text: Reboot database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Restart {relationalDatabaseName} now.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/StartRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a stopped database
      effect: write
      questions:
      - How do I bring a stopped database back online?
      - Can I start a database I stopped to save money?
      instructions:
      - text: Start database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Power on the stopped database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/StopRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running database
      effect: write
      questions:
      - Can I stop a database temporarily when I'm not using it?
      - Is it possible to snapshot a database as I stop it?
      instructions:
      - text: Stop database {relationalDatabaseName}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Stop {relationalDatabaseName} and take snapshot {relationalDatabaseSnapshotName} first.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          relationalDatabaseSnapshotName: requestBody.relationalDatabaseSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateRelationalDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Change database settings or rotate its password
      effect: write
      questions:
      - How do I rotate the master password of my database?
      - Can I change the backup window or turn off public access on a database?
      - Can the change be applied immediately instead of in the maintenance window?
      instructions:
      - text: Rotate the master password of {relationalDatabaseName} ({rotateMasterUserPassword}).
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          rotateMasterUserPassword: requestBody.rotateMasterUserPassword
      - text: Set {relationalDatabaseName} public access to {publiclyAccessible} and apply immediately ({applyImmediately}).
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          publiclyAccessible: requestBody.publiclyAccessible
          applyImmediately: requestBody.applyImmediately
      - text: Move the backup window of {relationalDatabaseName} to {preferredBackupWindow}.
        slots:
          relationalDatabaseName: requestBody.relationalDatabaseName
          preferredBackupWindow: requestBody.preferredBackupWindow
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateRelationalDatabaseParameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Change database engine parameters
      effect: write
      questions:
      - How do I raise max_connections on my managed database?
      - Can I change several engine parameters in one request?
      instructions:
      - text: Update parameters {parameters} on {relationalDatabaseName}.
        slots:
          parameters: requestBody.parameters
          relationalDatabaseName: requestBody.relationalDatabaseName
      - text: Apply engine parameter changes {parameters} to database {relationalDatabaseName}.
        slots:
          parameters: requestBody.parameters
          relationalDatabaseName: requestBody.relationalDatabaseName
      method: generated
      generated: '2026-09-26'