Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Snapshots API

16 actions 16 updates phrasing extends openapi/amazon-lightsail-snapshots-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 16

$.info
$.paths['/ls/api/2016-11-28/CopySnapshot'].post
$.paths['/ls/api/2016-11-28/CreateDiskFromSnapshot'].post
$.paths['/ls/api/2016-11-28/CreateDiskSnapshot'].post
$.paths['/ls/api/2016-11-28/CreateInstanceSnapshot'].post
$.paths['/ls/api/2016-11-28/CreateInstancesFromSnapshot'].post
$.paths['/ls/api/2016-11-28/DeleteAutoSnapshot'].post
$.paths['/ls/api/2016-11-28/DeleteDiskSnapshot'].post
$.paths['/ls/api/2016-11-28/DeleteInstanceSnapshot'].post
$.paths['/ls/api/2016-11-28/ExportSnapshot'].post
$.paths['/ls/api/2016-11-28/GetAutoSnapshots'].post
$.paths['/ls/api/2016-11-28/GetDiskSnapshot'].post
$.paths['/ls/api/2016-11-28/GetDiskSnapshots'].post
$.paths['/ls/api/2016-11-28/GetExportSnapshotRecords'].post
$.paths['/ls/api/2016-11-28/GetInstanceSnapshot'].post
$.paths['/ls/api/2016-11-28/GetInstanceSnapshots'].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 Snapshots API
  version: 1.0.0
extends: openapi/amazon-lightsail-snapshots-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: 15
- target: $.paths['/ls/api/2016-11-28/CopySnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a snapshot, even to another region
      effect: write
      questions:
      - How do I copy an instance snapshot to another AWS region?
      - Can I turn an automatic snapshot into a manual one?
      - Can I copy from the latest restorable automatic snapshot?
      instructions:
      - text: Copy snapshot {sourceSnapshotName} from {sourceRegion} as {targetSnapshotName}.
        slots:
          sourceSnapshotName: requestBody.sourceSnapshotName
          sourceRegion: requestBody.sourceRegion
          targetSnapshotName: requestBody.targetSnapshotName
      - text: Copy the automatic snapshot of {sourceResourceName} from {restoreDate} in {sourceRegion} to {targetSnapshotName}.
        slots:
          sourceResourceName: requestBody.sourceResourceName
          restoreDate: requestBody.restoreDate
          sourceRegion: requestBody.sourceRegion
          targetSnapshotName: requestBody.targetSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateDiskFromSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a disk from a disk snapshot
      effect: write
      questions:
      - How do I restore a block storage disk from a snapshot?
      - Can I make the restored disk bigger than the original?
      instructions:
      - text: Create disk {diskName} of {sizeInGb} GB in {availabilityZone} from snapshot {diskSnapshotName}.
        slots:
          diskName: requestBody.diskName
          sizeInGb: requestBody.sizeInGb
          availabilityZone: requestBody.availabilityZone
          diskSnapshotName: requestBody.diskSnapshotName
      - text: Restore {sourceDiskName}'s automatic snapshot from {restoreDate} into new disk {diskName} ({sizeInGb} GB, {availabilityZone}).
        slots:
          sourceDiskName: requestBody.sourceDiskName
          restoreDate: requestBody.restoreDate
          diskName: requestBody.diskName
          sizeInGb: requestBody.sizeInGb
          availabilityZone: requestBody.availabilityZone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateDiskSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a snapshot of a block storage disk
      effect: write
      questions:
      - How do I back up a block storage disk?
      - Can I snapshot an instance's system disk without snapshotting the whole instance?
      instructions:
      - text: Create snapshot {diskSnapshotName} of disk {diskName}.
        slots:
          diskSnapshotName: requestBody.diskSnapshotName
          diskName: requestBody.diskName
      - text: Snapshot the system disk of instance {instanceName} as {diskSnapshotName}.
        slots:
          instanceName: requestBody.instanceName
          diskSnapshotName: requestBody.diskSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateInstanceSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a snapshot of an instance
      effect: write
      questions:
      - How do I back up my whole Lightsail server before an upgrade?
      - Can I tag an instance snapshot when I create it?
      instructions:
      - text: Snapshot instance {instanceName} as {instanceSnapshotName}.
        slots:
          instanceName: requestBody.instanceName
          instanceSnapshotName: requestBody.instanceSnapshotName
      - text: Create instance snapshot {instanceSnapshotName} of {instanceName} tagged {tags}.
        slots:
          instanceSnapshotName: requestBody.instanceSnapshotName
          instanceName: requestBody.instanceName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateInstancesFromSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch instances from an instance snapshot
      effect: write
      questions:
      - How do I restore a server from a snapshot onto a bigger plan?
      - Can I clone an instance several times from its snapshot?
      - Can I restore from an automatic snapshot by date?
      instructions:
      - text: Create {instanceNames} from snapshot {instanceSnapshotName} in {availabilityZone} on bundle {bundleId}.
        slots:
          instanceNames: requestBody.instanceNames
          instanceSnapshotName: requestBody.instanceSnapshotName
          availabilityZone: requestBody.availabilityZone
          bundleId: requestBody.bundleId
      - text: Restore {sourceInstanceName}'s auto snapshot from {restoreDate} as {instanceNames} in {availabilityZone}, bundle {bundleId}.
        slots:
          sourceInstanceName: requestBody.sourceInstanceName
          restoreDate: requestBody.restoreDate
          instanceNames: requestBody.instanceNames
          availabilityZone: requestBody.availabilityZone
          bundleId: requestBody.bundleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteAutoSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an automatic snapshot by date
      effect: destructive
      questions:
      - How do I delete one day's automatic snapshot of an instance?
      - Can I remove an automatic disk snapshot I don't need?
      instructions:
      - text: Delete the automatic snapshot of {resourceName} from {date}.
        slots:
          resourceName: requestBody.resourceName
          date: requestBody.date
      - text: Remove {resourceName}'s auto snapshot dated {date}.
        slots:
          resourceName: requestBody.resourceName
          date: requestBody.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteDiskSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a manual disk snapshot
      effect: destructive
      questions:
      - How do I delete an old block storage disk snapshot?
      - Does deleting a disk snapshot affect the disk itself?
      instructions:
      - text: Delete disk snapshot {diskSnapshotName}.
        slots:
          diskSnapshotName: requestBody.diskSnapshotName
      - text: Remove the disk backup {diskSnapshotName}.
        slots:
          diskSnapshotName: requestBody.diskSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteInstanceSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a manual instance snapshot
      effect: destructive
      questions:
      - How do I delete an instance snapshot to stop paying for it?
      - Can I remove a server snapshot I took last month?
      instructions:
      - text: Delete instance snapshot {instanceSnapshotName}.
        slots:
          instanceSnapshotName: requestBody.instanceSnapshotName
      - text: Remove the server snapshot {instanceSnapshotName}.
        slots:
          instanceSnapshotName: requestBody.instanceSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/ExportSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a snapshot to Amazon EC2
      effect: write
      questions:
      - How do I move a Lightsail instance to EC2?
      - Can I export a disk snapshot to become an EBS volume?
      instructions:
      - text: Export snapshot {sourceSnapshotName} to EC2.
        slots:
          sourceSnapshotName: requestBody.sourceSnapshotName
      - text: Send {sourceSnapshotName} over to Amazon EC2 as an AMI or EBS snapshot.
        slots:
          sourceSnapshotName: requestBody.sourceSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetAutoSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List automatic snapshots of an instance or disk
      effect: read
      questions:
      - Which automatic daily snapshots exist for my instance?
      - What dates can I restore a disk to from auto snapshots?
      instructions:
      - text: List automatic snapshots for {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      - text: Show the restorable auto snapshot dates of {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDiskSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one disk snapshot
      effect: read
      questions:
      - Is my disk snapshot finished and how big is it?
      - Which disk did a particular snapshot come from?
      instructions:
      - text: Get disk snapshot {diskSnapshotName}.
        slots:
          diskSnapshotName: requestBody.diskSnapshotName
      - text: Show the progress and source disk of {diskSnapshotName}.
        slots:
          diskSnapshotName: requestBody.diskSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDiskSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List all disk snapshots
      effect: read
      questions:
      - What block storage disk snapshots do I have?
      - Can I page through all my disk snapshots in this region?
      instructions:
      - text: List all my disk snapshots.
      - text: Get the next page of disk snapshots using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetExportSnapshotRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: List snapshot export-to-EC2 records
      effect: read
      questions:
      - Did my snapshot export to EC2 succeed?
      - Where can I see all the snapshots I've exported?
      instructions:
      - text: List my export snapshot records.
      - text: Get more export records from page {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetInstanceSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one instance snapshot
      effect: read
      questions:
      - Is a particular instance snapshot ready to use?
      - Which blueprint and bundle was an instance snapshot taken from?
      instructions:
      - text: Get instance snapshot {instanceSnapshotName}.
        slots:
          instanceSnapshotName: requestBody.instanceSnapshotName
      - text: Show the state and source of {instanceSnapshotName}.
        slots:
          instanceSnapshotName: requestBody.instanceSnapshotName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetInstanceSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List all instance snapshots
      effect: read
      questions:
      - What instance snapshots do I have?
      - Can I page through every server snapshot in my account?
      instructions:
      - text: List all my instance snapshots.
      - text: Get the next page of instance snapshots using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'