Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Account API

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

$.info
$.paths['/ls/api/2016-11-28/CreateCloudFormationStack'].post
$.paths['/ls/api/2016-11-28/DeleteKnownHostKeys'].post
$.paths['/ls/api/2016-11-28/DisableAddOn'].post
$.paths['/ls/api/2016-11-28/EnableAddOn'].post
$.paths['/ls/api/2016-11-28/GetActiveNames'].post
$.paths['/ls/api/2016-11-28/GetCloudFormationStackRecords'].post
$.paths['/ls/api/2016-11-28/GetProfile'].get
$.paths['/ls/api/2016-11-28/IsVpcPeered'].post
$.paths['/ls/api/2016-11-28/PeerVpc'].post
$.paths['/ls/api/2016-11-28/SetIpAddressType'].post
$.paths['/ls/api/2016-11-28/UnpeerVpc'].post
$.paths['/ls/api/2016-11-28/create-gui-session-access-details'].post
$.paths['/ls/api/2016-11-28/start-gui-session'].post
$.paths['/ls/api/2016-11-28/stop-gui-session'].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 Account API
  version: 1.0.0
extends: openapi/amazon-lightsail-account-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: 14
- target: $.paths['/ls/api/2016-11-28/CreateCloudFormationStack'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an EC2 instance from an exported snapshot
      effect: write
      questions:
      - How do I turn an exported Lightsail snapshot into a full EC2 instance?
      - Can a CloudFormation stack launch EC2 from a snapshot I exported to EC2?
      instructions:
      - text: Create a CloudFormation stack that launches EC2 instances from {instances}.
        slots:
          instances: requestBody.instances
      - text: Spin up an EC2 instance from my exported Lightsail snapshot using {instances}.
        slots:
          instances: requestBody.instances
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteKnownHostKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset browser SSH/RDP known host keys
      effect: destructive
      questions:
      - The browser SSH client says the host key changed — how can I clear the saved key?
      - Can I delete the known host key the browser-based RDP client stored for my instance?
      instructions:
      - text: Delete the known host keys the browser SSH client saved for {instanceName}.
        slots:
          instanceName: requestBody.instanceName
      - text: Clear the cached host key certificate for {instanceName} so the browser client trusts it again.
        slots:
          instanceName: requestBody.instanceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DisableAddOn'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off an add-on such as automatic snapshots
      effect: write
      questions:
      - How do I switch off automatic snapshots on an instance or disk?
      - Can I disable an add-on without deleting the resource it's on?
      instructions:
      - text: Disable the {addOnType} add-on on {resourceName}.
        slots:
          addOnType: requestBody.addOnType
          resourceName: requestBody.resourceName
      - text: Stop automatic snapshots for {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/EnableAddOn'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or change an add-on on a resource
      effect: write
      questions:
      - How can I turn on automatic daily snapshots for my Lightsail instance?
      - Can I change the snapshot time of an add-on that's already enabled?
      instructions:
      - text: Enable the add-on {addOnRequest} on {resourceName}.
        slots:
          addOnRequest: requestBody.addOnRequest
          resourceName: requestBody.resourceName
      - text: Turn on automatic snapshots for {resourceName} with settings {addOnRequest}.
        slots:
          resourceName: requestBody.resourceName
          addOnRequest: requestBody.addOnRequest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetActiveNames'].post
  update:
    x-apievangelist-phrasing:
      intent: List names of all active resources
      effect: read
      questions:
      - What resource names are currently in use in my Lightsail account?
      - Is there a quick way to get just the names of every resource that isn't deleted?
      instructions:
      - text: List the names of all my active Lightsail resources.
      - text: Get the next page of active resource names using token {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetCloudFormationStackRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: List CloudFormation stack records from exports
      effect: read
      questions:
      - Where can I see the CloudFormation stacks created when I moved snapshots to EC2?
      - What's the status of the stack records from my create-CloudFormation-stack requests?
      instructions:
      - text: Show my CloudFormation stack records.
      - text: Fetch more CloudFormation stack records starting at {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetProfile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Lightsail account profile
      effect: read
      questions:
      - What does my Lightsail account profile look like?
      - Can I check the account-level status and details of the account making calls?
      instructions:
      - text: Get my Lightsail account profile.
      - text: Show the profile details of the account I'm calling with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/IsVpcPeered'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether the Lightsail VPC is peered
      effect: read
      questions:
      - Is my Lightsail VPC peered with my default VPC?
      - How can I tell if VPC peering is already turned on?
      instructions:
      - text: Check whether my Lightsail VPC is peered.
      - text: Tell me if VPC peering is enabled for this region.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/PeerVpc'].post
  update:
    x-apievangelist-phrasing:
      intent: Peer the Lightsail VPC with the default VPC
      effect: write
      questions:
      - How do I let Lightsail resources talk to my other AWS resources in the default VPC?
      - Can I peer the Lightsail VPC with my account's default VPC?
      instructions:
      - text: Peer my Lightsail VPC with my default VPC.
      - text: Turn on VPC peering between Lightsail and my default VPC.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/SetIpAddressType'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch a resource between IPv4, dual-stack or IPv6
      effect: write
      questions:
      - How do I make my instance dual-stack so it gets an IPv6 address?
      - Can I switch a load balancer or distribution to IPv6-only?
      instructions:
      - text: Set the IP address type of {resourceType} {resourceName} to {ipAddressType}.
        slots:
          resourceType: requestBody.resourceType
          resourceName: requestBody.resourceName
          ipAddressType: requestBody.ipAddressType
      - text: Change {resourceName} ({resourceType}) to {ipAddressType} and accept the bundle update {acceptBundleUpdate}.
        slots:
          resourceName: requestBody.resourceName
          resourceType: requestBody.resourceType
          ipAddressType: requestBody.ipAddressType
          acceptBundleUpdate: requestBody.acceptBundleUpdate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UnpeerVpc'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove peering with the default VPC
      effect: destructive
      questions:
      - How do I undo VPC peering between Lightsail and my default VPC?
      - Can I disconnect the Lightsail VPC from the default VPC?
      instructions:
      - text: Unpeer my Lightsail VPC from the default VPC.
      - text: Turn off VPC peering for Lightsail.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/create-gui-session-access-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get URLs to open a GUI desktop session
      effect: write
      questions:
      - How do I get the URLs to open the graphical desktop of my virtual computer?
      - What do I need to connect to a DCV GUI session in the browser?
      instructions:
      - text: Create GUI session access URLs for {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      - text: Generate the desktop session links for virtual computer {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/start-gui-session'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a GUI desktop session
      effect: write
      questions:
      - How can I start a graphical desktop session on my virtual computer?
      - Can I launch the DCV session for an instance before connecting?
      instructions:
      - text: Start a GUI session on {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      - text: Initiate the graphical desktop session for virtual computer {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/stop-gui-session'].post
  update:
    x-apievangelist-phrasing:
      intent: End a GUI desktop session
      effect: destructive
      questions:
      - How do I terminate a running DCV desktop session?
      - Can I end someone's browser GUI session on a virtual computer?
      instructions:
      - text: Stop the GUI session on {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      - text: Terminate the web desktop session for virtual computer {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      method: generated
      generated: '2026-09-26'