Amazon Lightsail · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Amazon Lightsail Load Balancers API
10 actions
10 updates
phrasing
extends
openapi/amazon-lightsail-load-balancers-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.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/ls/api/2016-11-28/AttachInstancesToLoadBalancer'].post
$.paths['/ls/api/2016-11-28/CreateLoadBalancer'].post
$.paths['/ls/api/2016-11-28/DeleteLoadBalancer'].post
$.paths['/ls/api/2016-11-28/DetachInstancesFromLoadBalancer'].post
$.paths['/ls/api/2016-11-28/GetLoadBalancer'].post
$.paths['/ls/api/2016-11-28/GetLoadBalancerMetricData'].post
$.paths['/ls/api/2016-11-28/GetLoadBalancerTlsPolicies'].post
$.paths['/ls/api/2016-11-28/GetLoadBalancers'].post
$.paths['/ls/api/2016-11-28/UpdateLoadBalancerAttribute'].post
OpenAPI Overlay
# 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 Load Balancers API
version: 1.0.0
extends: openapi/amazon-lightsail-load-balancers-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: 9
- target: $.paths['/ls/api/2016-11-28/AttachInstancesToLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Add instances to a load balancer
effect: write
questions:
- How do I put my web servers behind a Lightsail load balancer?
- Can I add several instances to a load balancer at once?
instructions:
- text: Attach {instanceNames} to load balancer {loadBalancerName}.
slots:
instanceNames: requestBody.instanceNames
loadBalancerName: requestBody.loadBalancerName
- text: Add instances {instanceNames} as targets of {loadBalancerName}.
slots:
instanceNames: requestBody.instanceNames
loadBalancerName: requestBody.loadBalancerName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Create a load balancer
effect: write
questions:
- How do I create a load balancer for my Lightsail instances?
- Can I set a custom health check path when creating it?
- Can I create the HTTPS certificate at the same time as the load balancer?
instructions:
- text: Create load balancer {loadBalancerName} forwarding to port {instancePort}.
slots:
loadBalancerName: requestBody.loadBalancerName
instancePort: requestBody.instancePort
- text: Create {loadBalancerName} on port {instancePort} with health check {healthCheckPath}.
slots:
loadBalancerName: requestBody.loadBalancerName
instancePort: requestBody.instancePort
healthCheckPath: requestBody.healthCheckPath
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Delete a load balancer
effect: destructive
questions:
- How do I delete a load balancer I no longer need?
- Are the load balancer's certificates deleted along with it?
instructions:
- text: Delete load balancer {loadBalancerName}.
slots:
loadBalancerName: requestBody.loadBalancerName
- text: Remove {loadBalancerName} and its TLS certificates.
slots:
loadBalancerName: requestBody.loadBalancerName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DetachInstancesFromLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Remove instances from a load balancer
effect: write
questions:
- How do I take an instance out of the load balancer for maintenance?
- Can I detach several instances from a load balancer in one call?
instructions:
- text: Detach {instanceNames} from load balancer {loadBalancerName}.
slots:
instanceNames: requestBody.instanceNames
loadBalancerName: requestBody.loadBalancerName
- text: Take instances {instanceNames} out of rotation on {loadBalancerName}.
slots:
instanceNames: requestBody.instanceNames
loadBalancerName: requestBody.loadBalancerName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Get one load balancer's details
effect: read
questions:
- Are the instances behind my load balancer healthy?
- What's the DNS name of a specific load balancer?
instructions:
- text: Get load balancer {loadBalancerName}.
slots:
loadBalancerName: requestBody.loadBalancerName
- text: Show target health and DNS name for {loadBalancerName}.
slots:
loadBalancerName: requestBody.loadBalancerName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetLoadBalancerMetricData'].post
update:
x-apievangelist-phrasing:
intent: Get health metrics for a load balancer
effect: read
questions:
- How many requests is my load balancer handling?
- Can I see 5xx errors or response time for a load balancer?
instructions:
- text: Get {metricName} for {loadBalancerName} from {startTime} to {endTime} every {period} seconds as {statistics} in {unit}.
slots:
metricName: requestBody.metricName
loadBalancerName: requestBody.loadBalancerName
startTime: requestBody.startTime
endTime: requestBody.endTime
period: requestBody.period
statistics: requestBody.statistics
unit: requestBody.unit
- text: Show load balancer {loadBalancerName} {metricName} since {startTime}.
slots:
loadBalancerName: requestBody.loadBalancerName
metricName: requestBody.metricName
startTime: requestBody.startTime
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetLoadBalancerTlsPolicies'].post
update:
x-apievangelist-phrasing:
intent: List load balancer TLS security policies
effect: read
questions:
- Which TLS security policies can I apply to a load balancer?
- What protocols and ciphers does each TLS policy allow?
instructions:
- text: List the load balancer TLS policies.
- text: Get more TLS policies from page {pageToken}.
slots:
pageToken: requestBody.pageToken
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetLoadBalancers'].post
update:
x-apievangelist-phrasing:
intent: List all load balancers
effect: read
questions:
- What load balancers are in my account?
- Can I page through every load balancer I have?
instructions:
- text: List all my load balancers.
- text: Get the next page of load balancers using {pageToken}.
slots:
pageToken: requestBody.pageToken
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateLoadBalancerAttribute'].post
update:
x-apievangelist-phrasing:
intent: Change a load balancer setting
effect: write
questions:
- How do I change the health check path or turn on session stickiness?
- Can I redirect HTTP to HTTPS on my load balancer?
instructions:
- text: Set {attributeName} to {attributeValue} on load balancer {loadBalancerName}.
slots:
attributeName: requestBody.attributeName
attributeValue: requestBody.attributeValue
loadBalancerName: requestBody.loadBalancerName
- text: Update {loadBalancerName} so its {attributeName} is {attributeValue}.
slots:
loadBalancerName: requestBody.loadBalancerName
attributeName: requestBody.attributeName
attributeValue: requestBody.attributeValue
method: generated
generated: '2026-09-26'