Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Certificates API

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

$.info
$.paths['/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate'].post
$.paths['/ls/api/2016-11-28/CreateCertificate'].post
$.paths['/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate'].post
$.paths['/ls/api/2016-11-28/DeleteCertificate'].post
$.paths['/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate'].post
$.paths['/ls/api/2016-11-28/GetCertificates'].post
$.paths['/ls/api/2016-11-28/GetLoadBalancerTlsCertificates'].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 Certificates API
  version: 1.0.0
extends: openapi/amazon-lightsail-certificates-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: 7
- target: $.paths['/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a TLS certificate to a load balancer
      effect: write
      questions:
      - How do I enable HTTPS on my load balancer with a validated certificate?
      - Can I swap the certificate a load balancer is using?
      instructions:
      - text: Attach certificate {certificateName} to load balancer {loadBalancerName}.
        slots:
          certificateName: requestBody.certificateName
          loadBalancerName: requestBody.loadBalancerName
      - text: Switch load balancer {loadBalancerName} to use TLS cert {certificateName}.
        slots:
          loadBalancerName: requestBody.loadBalancerName
          certificateName: requestBody.certificateName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a certificate for a CDN or container service
      effect: write
      questions:
      - How do I get an SSL certificate for my Lightsail distribution's custom domain?
      - Can one certificate cover extra subdomains for a container service?
      instructions:
      - text: Create certificate {certificateName} for {domainName}.
        slots:
          certificateName: requestBody.certificateName
          domainName: requestBody.domainName
      - text: Request certificate {certificateName} for {domainName} plus {subjectAlternativeNames} for my distribution.
        slots:
          certificateName: requestBody.certificateName
          domainName: requestBody.domainName
          subjectAlternativeNames: requestBody.subjectAlternativeNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a TLS certificate on a load balancer
      effect: write
      questions:
      - How do I create an SSL certificate specifically for a Lightsail load balancer?
      - Can I add alternative domain names to a load balancer certificate?
      instructions:
      - text: Create load balancer certificate {certificateName} on {loadBalancerName} for {certificateDomainName}.
        slots:
          certificateName: requestBody.certificateName
          loadBalancerName: requestBody.loadBalancerName
          certificateDomainName: requestBody.certificateDomainName
      - text: On {loadBalancerName}, create TLS cert {certificateName} for {certificateDomainName} and {certificateAlternativeNames}.
        slots:
          loadBalancerName: requestBody.loadBalancerName
          certificateName: requestBody.certificateName
          certificateDomainName: requestBody.certificateDomainName
          certificateAlternativeNames: requestBody.certificateAlternativeNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a CDN/container certificate
      effect: destructive
      questions:
      - How do I delete a certificate I made for my CDN distribution?
      - Can I remove an unused distribution certificate?
      instructions:
      - text: Delete certificate {certificateName}.
        slots:
          certificateName: requestBody.certificateName
      - text: Remove the distribution certificate {certificateName} from my account.
        slots:
          certificateName: requestBody.certificateName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a load balancer's TLS certificate
      effect: destructive
      questions:
      - How do I remove a TLS certificate from my load balancer?
      - Can I force-delete a load balancer certificate that's still attached?
      instructions:
      - text: Delete certificate {certificateName} from load balancer {loadBalancerName}.
        slots:
          certificateName: requestBody.certificateName
          loadBalancerName: requestBody.loadBalancerName
      - text: Force-delete ({force}) TLS cert {certificateName} on {loadBalancerName}.
        slots:
          force: requestBody.force
          certificateName: requestBody.certificateName
          loadBalancerName: requestBody.loadBalancerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetCertificates'].post
  update:
    x-apievangelist-phrasing:
      intent: List CDN and container certificates
      effect: read
      questions:
      - Which of my distribution certificates are still pending validation?
      - Can I see the full details of one certificate, including validation records?
      instructions:
      - text: List my Lightsail certificates with status {certificateStatuses}.
        slots:
          certificateStatuses: requestBody.certificateStatuses
      - text: Get certificate {certificateName} with details ({includeCertificateDetails}).
        slots:
          certificateName: requestBody.certificateName
          includeCertificateDetails: requestBody.includeCertificateDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetLoadBalancerTlsCertificates'].post
  update:
    x-apievangelist-phrasing:
      intent: List a load balancer's TLS certificates
      effect: read
      questions:
      - What certificates are associated with my load balancer?
      - Has my load balancer certificate been validated yet?
      instructions:
      - text: List TLS certificates on load balancer {loadBalancerName}.
        slots:
          loadBalancerName: requestBody.loadBalancerName
      - text: Show the validation status of certificates attached to {loadBalancerName}.
        slots:
          loadBalancerName: requestBody.loadBalancerName
      method: generated
      generated: '2026-09-26'