Amazon Lightsail · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Amazon Lightsail Distributions API
12 actions
12 updates
phrasing
extends
openapi/amazon-lightsail-distributions-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 12
$.info
$.paths['/ls/api/2016-11-28/AttachCertificateToDistribution'].post
$.paths['/ls/api/2016-11-28/CreateDistribution'].post
$.paths['/ls/api/2016-11-28/DeleteDistribution'].post
$.paths['/ls/api/2016-11-28/DetachCertificateFromDistribution'].post
$.paths['/ls/api/2016-11-28/GetDistributionBundles'].post
$.paths['/ls/api/2016-11-28/GetDistributionLatestCacheReset'].post
$.paths['/ls/api/2016-11-28/GetDistributionMetricData'].post
$.paths['/ls/api/2016-11-28/GetDistributions'].post
$.paths['/ls/api/2016-11-28/ResetDistributionCache'].post
$.paths['/ls/api/2016-11-28/UpdateDistribution'].post
$.paths['/ls/api/2016-11-28/UpdateDistributionBundle'].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 Distributions API
version: 1.0.0
extends: openapi/amazon-lightsail-distributions-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: 11
- target: $.paths['/ls/api/2016-11-28/AttachCertificateToDistribution'].post
update:
x-apievangelist-phrasing:
intent: Attach a certificate to a CDN distribution
effect: write
questions:
- How do I use my custom domain with HTTPS on a Lightsail CDN distribution?
- Can I attach a validated certificate to an existing distribution?
instructions:
- text: Attach certificate {certificateName} to distribution {distributionName}.
slots:
certificateName: requestBody.certificateName
distributionName: requestBody.distributionName
- text: Enable custom-domain HTTPS on {distributionName} with {certificateName}.
slots:
distributionName: requestBody.distributionName
certificateName: requestBody.certificateName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateDistribution'].post
update:
x-apievangelist-phrasing:
intent: Create a CDN distribution
effect: write
questions:
- How do I put a CDN in front of my Lightsail instance or bucket?
- Can I set caching rules per path when creating a distribution?
- What's the minimum TLS version I can require from viewers?
instructions:
- text: Create distribution {distributionName} for origin {origin} with cache behavior {defaultCacheBehavior} on plan {bundleId}.
slots:
distributionName: requestBody.distributionName
origin: requestBody.origin
defaultCacheBehavior: requestBody.defaultCacheBehavior
bundleId: requestBody.bundleId
- text: Set up a CDN {distributionName} for {origin}, caching {defaultCacheBehavior}, plan {bundleId}, cert {certificateName}.
slots:
distributionName: requestBody.distributionName
origin: requestBody.origin
defaultCacheBehavior: requestBody.defaultCacheBehavior
bundleId: requestBody.bundleId
certificateName: requestBody.certificateName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteDistribution'].post
update:
x-apievangelist-phrasing:
intent: Delete a CDN distribution
effect: destructive
questions:
- How do I delete a CDN distribution I no longer need?
- Will deleting the distribution affect my origin instance?
instructions:
- text: Delete distribution {distributionName}.
slots:
distributionName: requestBody.distributionName
- text: Tear down the CDN named {distributionName}.
slots:
distributionName: requestBody.distributionName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DetachCertificateFromDistribution'].post
update:
x-apievangelist-phrasing:
intent: Remove the certificate from a distribution
effect: write
questions:
- How do I stop using my custom-domain certificate on a distribution?
- Does detaching a certificate revert the distribution to its default domain?
instructions:
- text: Detach the certificate from distribution {distributionName}.
slots:
distributionName: requestBody.distributionName
- text: Remove custom-domain TLS from {distributionName}.
slots:
distributionName: requestBody.distributionName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDistributionBundles'].post
update:
x-apievangelist-phrasing:
intent: List CDN distribution plans
effect: read
questions:
- What CDN plans are available and how much transfer do they include?
- Which distribution bundle should cover 500 GB a month?
instructions:
- text: List the distribution bundles.
- text: Show CDN plan prices and data transfer quotas.
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDistributionLatestCacheReset'].post
update:
x-apievangelist-phrasing:
intent: Check the last CDN cache reset
effect: read
questions:
- When was my distribution's cache last cleared?
- Has my most recent cache reset finished?
instructions:
- text: Get the latest cache reset for {distributionName}.
slots:
distributionName: requestBody.distributionName
- text: Check the status of the last cache purge on {distributionName}.
slots:
distributionName: requestBody.distributionName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDistributionMetricData'].post
update:
x-apievangelist-phrasing:
intent: Get traffic metrics for a distribution
effect: read
questions:
- How many requests is my CDN distribution serving?
- Can I see bytes downloaded or error rates for a distribution?
instructions:
- text: Get {metricName} for distribution {distributionName} from {startTime} to {endTime} every {period} seconds as {statistics} in {unit}.
slots:
metricName: requestBody.metricName
distributionName: requestBody.distributionName
startTime: requestBody.startTime
endTime: requestBody.endTime
period: requestBody.period
statistics: requestBody.statistics
unit: requestBody.unit
- text: Chart CDN {distributionName} {metricName} since {startTime}.
slots:
distributionName: requestBody.distributionName
metricName: requestBody.metricName
startTime: requestBody.startTime
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDistributions'].post
update:
x-apievangelist-phrasing:
intent: List CDN distributions
effect: read
questions:
- What CDN distributions do I have and what domains do they serve?
- Can I look up just one distribution's configuration?
instructions:
- text: List my CDN distributions.
- text: Get the configuration of distribution {distributionName}.
slots:
distributionName: requestBody.distributionName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/ResetDistributionCache'].post
update:
x-apievangelist-phrasing:
intent: Purge a distribution's cached content
effect: write
questions:
- How do I clear the CDN cache after deploying new files?
- Can I force the distribution to fetch fresh content from the origin?
instructions:
- text: Reset the cache of distribution {distributionName}.
slots:
distributionName: requestBody.distributionName
- text: Purge everything cached on {distributionName}.
slots:
distributionName: requestBody.distributionName
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateDistribution'].post
update:
x-apievangelist-phrasing:
intent: Change a CDN distribution's settings
effect: write
questions:
- How do I change the origin or caching behavior of an existing distribution?
- Can I temporarily disable a distribution?
- Can I switch a distribution back to its default certificate?
instructions:
- text: Point distribution {distributionName} at origin {origin}.
slots:
distributionName: requestBody.distributionName
origin: requestBody.origin
- text: Set {distributionName} enabled to {isEnabled}.
slots:
distributionName: requestBody.distributionName
isEnabled: requestBody.isEnabled
- text: Change the cache behaviors of {distributionName} to {cacheBehaviors}.
slots:
distributionName: requestBody.distributionName
cacheBehaviors: requestBody.cacheBehaviors
method: generated
generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateDistributionBundle'].post
update:
x-apievangelist-phrasing:
intent: Change a distribution's CDN plan
effect: write
questions:
- How do I upgrade my CDN distribution to a larger transfer plan?
- Can I downgrade a distribution's bundle?
instructions:
- text: Move distribution {distributionName} to bundle {bundleId}.
slots:
distributionName: requestBody.distributionName
bundleId: requestBody.bundleId
- text: Change the CDN plan of {distributionName} to {bundleId}.
slots:
distributionName: requestBody.distributionName
bundleId: requestBody.bundleId
method: generated
generated: '2026-09-26'