Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Key Pairs API

7 actions 7 updates phrasing extends openapi/amazon-lightsail-keypairs-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/CreateKeyPair'].post
$.paths['/ls/api/2016-11-28/DeleteKeyPair'].post
$.paths['/ls/api/2016-11-28/DownloadDefaultKeyPair'].post
$.paths['/ls/api/2016-11-28/GetKeyPair'].post
$.paths['/ls/api/2016-11-28/GetKeyPairs'].post
$.paths['/ls/api/2016-11-28/ImportKeyPair'].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 Key Pairs API
  version: 1.0.0
extends: openapi/amazon-lightsail-keypairs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/ls/api/2016-11-28/CreateKeyPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a new SSH key pair
      effect: write
      questions:
      - How do I create a new SSH key pair for my instances?
      - Does Lightsail give me the private key when it creates a key pair?
      instructions:
      - text: Create SSH key pair {keyPairName}.
        slots:
          keyPairName: requestBody.keyPairName
      - text: Generate a new key pair named {keyPairName} tagged {tags}.
        slots:
          keyPairName: requestBody.keyPairName
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/DeleteKeyPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSH key pair
      effect: destructive
      questions:
      - How do I delete an SSH key pair I no longer use?
      - Can I make sure I delete the right key by its fingerprint?
      instructions:
      - text: Delete key pair {keyPairName}.
        slots:
          keyPairName: requestBody.keyPairName
      - text: Delete {keyPairName} only if its fingerprint is {expectedFingerprint}.
        slots:
          keyPairName: requestBody.keyPairName
          expectedFingerprint: requestBody.expectedFingerprint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/DownloadDefaultKeyPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Download the regional default key pair
      effect: read
      questions:
      - Where do I get the default SSH private key for this region?
      - Can I download the default key to SSH from my own terminal?
      instructions:
      - text: Download the default key pair for this region.
      - text: Get the regional default SSH key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/GetKeyPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one key pair
      effect: read
      questions:
      - What's the fingerprint of a particular key pair?
      - When was a specific key pair created?
      instructions:
      - text: Get key pair {keyPairName}.
        slots:
          keyPairName: requestBody.keyPairName
      - text: Show the fingerprint of {keyPairName}.
        slots:
          keyPairName: requestBody.keyPairName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/GetKeyPairs'].post
  update:
    x-apievangelist-phrasing:
      intent: List all SSH key pairs
      effect: read
      questions:
      - Which SSH key pairs exist in my account?
      - Can the key pair list include the default key pair?
      instructions:
      - text: List all my key pairs.
      - text: List key pairs including the default one ({includeDefaultKeyPair}).
        slots:
          includeDefaultKeyPair: requestBody.includeDefaultKeyPair
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/ImportKeyPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an existing public SSH key
      effect: write
      questions:
      - How do I use my own existing SSH key with Lightsail?
      - Can I upload a public key instead of generating one?
      instructions:
      - text: Import public key {publicKeyBase64} as {keyPairName}.
        slots:
          publicKeyBase64: requestBody.publicKeyBase64
          keyPairName: requestBody.keyPairName
      - text: Upload my public SSH key {publicKeyBase64} under the name {keyPairName}.
        slots:
          publicKeyBase64: requestBody.publicKeyBase64
          keyPairName: requestBody.keyPairName
      method: generated
      generated: '2026-10-01'