Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Static IPs API

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

$.info
$.paths['/ls/api/2016-11-28/AllocateStaticIp'].post
$.paths['/ls/api/2016-11-28/AttachStaticIp'].post
$.paths['/ls/api/2016-11-28/DetachStaticIp'].post
$.paths['/ls/api/2016-11-28/GetStaticIp'].post
$.paths['/ls/api/2016-11-28/GetStaticIps'].post
$.paths['/ls/api/2016-11-28/ReleaseStaticIp'].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 Static IPs API
  version: 1.0.0
extends: openapi/amazon-lightsail-static-ips-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: 6
- target: $.paths['/ls/api/2016-11-28/AllocateStaticIp'].post
  update:
    x-apievangelist-phrasing:
      intent: Reserve a new static IP address
      effect: write
      questions:
      - How do I get a fixed public IP that doesn't change on reboot?
      - Can I reserve a static IP before I have an instance for it?
      instructions:
      - text: Allocate a static IP named {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      - text: Reserve a new static IP address called {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/AttachStaticIp'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a static IP to an instance
      effect: write
      questions:
      - How do I assign my static IP to an instance?
      - Can I move a static IP from one instance to another?
      instructions:
      - text: Attach static IP {staticIpName} to {instanceName}.
        slots:
          staticIpName: requestBody.staticIpName
          instanceName: requestBody.instanceName
      - text: Point {staticIpName} at instance {instanceName}.
        slots:
          staticIpName: requestBody.staticIpName
          instanceName: requestBody.instanceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DetachStaticIp'].post
  update:
    x-apievangelist-phrasing:
      intent: Detach a static IP from its instance
      effect: write
      questions:
      - How do I unassign a static IP but keep it reserved?
      - What IP does the instance get after I detach its static IP?
      instructions:
      - text: Detach static IP {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      - text: Unassign {staticIpName} from its instance but keep it.
        slots:
          staticIpName: requestBody.staticIpName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetStaticIp'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one static IP
      effect: read
      questions:
      - Which instance is a given static IP attached to?
      - What's the actual address of a named static IP?
      instructions:
      - text: Get static IP {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      - text: Show the address and attachment of {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetStaticIps'].post
  update:
    x-apievangelist-phrasing:
      intent: List all static IPs
      effect: read
      questions:
      - What static IP addresses do I have reserved?
      - Are any of my static IPs unattached and costing money?
      instructions:
      - text: List all my static IPs.
      - text: Get the next page of static IPs using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/ReleaseStaticIp'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a static IP address
      effect: destructive
      questions:
      - How do I give back a static IP I no longer need?
      - Can I get the same IP back after releasing it?
      instructions:
      - text: Release static IP {staticIpName}.
        slots:
          staticIpName: requestBody.staticIpName
      - text: Delete the static IP {staticIpName} from my account.
        slots:
          staticIpName: requestBody.staticIpName
      method: generated
      generated: '2026-09-26'