Amazon Lightsail · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Amazon Lightsail Container Services API
15 actions
15 updates
phrasing
extends
openapi/amazon-lightsail-container-services-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 15
$.info
$.paths['/ls/api/2016-11-28/container-api-metadata'].get
$.paths['/ls/api/2016-11-28/container-registry-login'].post
$.paths['/ls/api/2016-11-28/container-service-powers'].get
$.paths['/ls/api/2016-11-28/container-services'].get
$.paths['/ls/api/2016-11-28/container-services'].post
$.paths['/ls/api/2016-11-28/container-services/{serviceName}'].delete
$.paths['/ls/api/2016-11-28/container-services/{serviceName}'].patch
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log'].get
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/deployments'].get
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/deployments'].post
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/images'].get
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/images'].post
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/images/{image}'].delete
$.paths['/ls/api/2016-11-28/container-services/{serviceName}/metrics'].get
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 Container Services API
version: 1.0.0
extends: openapi/amazon-lightsail-container-services-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/container-api-metadata'].get
update:
x-apievangelist-phrasing:
intent: Get Lightsail container API metadata
effect: read
questions:
- Which version of the lightsailctl plugin is current?
- Where do I find metadata about the Lightsail containers API?
instructions:
- text: Get the Lightsail container API metadata.
- text: Show the current lightsailctl plugin version.
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-registry-login'].post
update:
x-apievangelist-phrasing:
intent: Get temporary Docker registry login credentials
effect: write
questions:
- How do I log my local Docker in so I can push images to a container service?
- How long do the container registry login credentials last?
instructions:
- text: Create temporary registry login credentials for my local Docker.
- text: Give me a container registry login so I can push images.
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-service-powers'].get
update:
x-apievangelist-phrasing:
intent: List container service power sizes
effect: read
questions:
- What power levels (CPU and memory) can a container service use?
- How much does each container service power cost per month?
instructions:
- text: List the container service powers.
- text: Show the CPU, RAM and price of each container power option.
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services'].get
update:
x-apievangelist-phrasing:
intent: List container services or get one
effect: read
questions:
- Which container services am I running and what state are they in?
- What's the public URL of one of my container services?
instructions:
- text: List my container services.
- text: Get details for container service {serviceName}.
slots:
serviceName: query.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services'].post
update:
x-apievangelist-phrasing:
intent: Create a container service
effect: write
questions:
- How do I create a Lightsail container service to run my Docker app?
- Can I set custom domain names and a first deployment when creating the service?
instructions:
- text: Create container service {serviceName} with power {power} and scale {scale}.
slots:
serviceName: requestBody.serviceName
power: requestBody.power
scale: requestBody.scale
- text: Create {serviceName} at {power} power, {scale} nodes, with initial deployment {deployment}.
slots:
serviceName: requestBody.serviceName
power: requestBody.power
scale: requestBody.scale
deployment: requestBody.deployment
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a container service
effect: destructive
questions:
- How do I tear down a container service I'm done with?
- Does deleting a container service remove its registered images too?
instructions:
- text: Delete container service {serviceName}.
slots:
serviceName: path.serviceName
- text: Remove {serviceName} and stop billing for it.
slots:
serviceName: path.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}'].patch
update:
x-apievangelist-phrasing:
intent: Change a container service's power, scale or domains
effect: write
questions:
- How do I scale my container service to more nodes?
- Can I disable a container service temporarily without deleting it?
- How do I add a custom domain to a running container service?
instructions:
- text: Scale container service {serviceName} to {scale} nodes.
slots:
serviceName: path.serviceName
scale: requestBody.scale
- text: Change {serviceName} power to {power}.
slots:
serviceName: path.serviceName
power: requestBody.power
- text: Set {serviceName} disabled to {isDisabled}.
slots:
serviceName: path.serviceName
isDisabled: requestBody.isDisabled
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log'].get
update:
x-apievangelist-phrasing:
intent: Read a container's log events
effect: read
questions:
- How do I see the logs from a container in my service?
- Can I filter container logs for errors in a time window?
instructions:
- text: Show logs for container {containerName} in {serviceName}.
slots:
containerName: path.containerName
serviceName: path.serviceName
- text: Get {containerName} logs in {serviceName} matching {filterPattern} from {startTime} to {endTime}.
slots:
containerName: path.containerName
serviceName: path.serviceName
filterPattern: query.filterPattern
startTime: query.startTime
endTime: query.endTime
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/deployments'].get
update:
x-apievangelist-phrasing:
intent: List a container service's deployments
effect: read
questions:
- What deployments has my container service had, and which is active?
- Did my latest container deployment fail?
instructions:
- text: List deployments for container service {serviceName}.
slots:
serviceName: path.serviceName
- text: Show the active and previous deployment versions of {serviceName}.
slots:
serviceName: path.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/deployments'].post
update:
x-apievangelist-phrasing:
intent: Deploy containers to a container service
effect: write
questions:
- How do I deploy a new image version to my container service?
- Can I set which container and port serve public traffic?
instructions:
- text: Deploy containers {containers} to {serviceName}.
slots:
containers: requestBody.containers
serviceName: path.serviceName
- text: Create a deployment on {serviceName} with {containers} and public endpoint {publicEndpoint}.
slots:
serviceName: path.serviceName
containers: requestBody.containers
publicEndpoint: requestBody.publicEndpoint
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/images'].get
update:
x-apievangelist-phrasing:
intent: List images registered to a container service
effect: read
questions:
- Which container images have I pushed to my service?
- What image versions are available to deploy on a service?
instructions:
- text: List container images registered to {serviceName}.
slots:
serviceName: path.serviceName
- text: Show the pushed images on {serviceName}.
slots:
serviceName: path.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/images'].post
update:
x-apievangelist-phrasing:
intent: Register a pushed image to a container service
effect: write
questions:
- How do I register an image I pushed so a service can deploy it?
- Do I need the image digest to register a container image?
instructions:
- text: Register image {digest} as {label} on {serviceName}.
slots:
digest: requestBody.digest
label: requestBody.label
serviceName: path.serviceName
- text: Add container image with label {label} and digest {digest} to {serviceName}.
slots:
label: requestBody.label
digest: requestBody.digest
serviceName: path.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/images/{image}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an image from a container service
effect: destructive
questions:
- How do I clean up old container images from my service?
- Can I delete an image that's no longer deployed?
instructions:
- text: Delete image {image} from container service {serviceName}.
slots:
image: path.image
serviceName: path.serviceName
- text: Remove the registered image {image} on {serviceName}.
slots:
image: path.image
serviceName: path.serviceName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/container-services/{serviceName}/metrics'].get
update:
x-apievangelist-phrasing:
intent: Get CPU or memory metrics for a container service
effect: read
questions:
- How much CPU is my container service using?
- Can I pull memory utilization for a container service over the last day?
instructions:
- text: Get {metricName} for {serviceName} from {startTime} to {endTime} every {period} seconds as {statistics}.
slots:
metricName: query.metricName
serviceName: path.serviceName
startTime: query.startTime
endTime: query.endTime
period: query.period
statistics: query.statistics
- text: Show container service {serviceName} {metricName} utilization since {startTime}.
slots:
serviceName: path.serviceName
metricName: query.metricName
startTime: query.startTime
method: generated
generated: '2026-09-26'