CloudFront · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon CloudFront Distributions API

7 actions 7 updates phrasing extends openapi/cloudfront-distributions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for CloudFront's API. It is a proposal applied on top of the contract, not a document CloudFront publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/2020-05-31/distribution'].get
$.paths['/2020-05-31/distribution'].post
$.paths['/2020-05-31/distribution/{Id}'].get
$.paths['/2020-05-31/distribution/{Id}'].delete
$.paths['/2020-05-31/distribution/{Id}/config'].get
$.paths['/2020-05-31/distribution/{Id}/config'].put

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 CloudFront Distributions API
  version: 1.0.0
extends: openapi/cloudfront-distributions-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['/2020-05-31/distribution'].get
  update:
    x-apievangelist-phrasing:
      intent: List CloudFront distributions
      effect: read
      questions:
      - Which CloudFront distributions exist in my AWS account?
      - Can I page through my distributions a few at a time instead of getting them all at once?
      - What CDN distributions have I set up so far?
      instructions:
      - text: List all of my CloudFront distributions.
      - text: List up to {max_items} distributions starting after marker {marker}.
        slots:
          max_items: query.MaxItems
          marker: query.Marker
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CloudFront distribution
      effect: write
      questions:
      - How do I set up a new CloudFront distribution in front of my origin?
      - Can I create a brand-new CDN distribution through the API?
      - What does it take to launch a new distribution for my website?
      instructions:
      - text: Create a new CloudFront distribution for my site.
      - text: Set up a fresh CDN distribution to serve my origin.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a distribution's details and status
      effect: read
      questions:
      - Has my distribution finished deploying, or is it still in progress?
      - Where can I see the domain name and current status of one distribution?
      - What does CloudFront report about a single distribution I own?
      instructions:
      - text: Get the details and deployment status of distribution {id}.
        slots:
          id: path.Id
      - text: Show me distribution {id}, including its domain name.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CloudFront distribution
      effect: destructive
      questions:
      - How do I permanently remove a CloudFront distribution I no longer need?
      - Does deleting a distribution require the current ETag value?
      - Can I tear down an old distribution once it's disabled?
      instructions:
      - text: Delete distribution {id}.
        slots:
          id: path.Id
      - text: Delete distribution {id} using ETag {etag}.
        slots:
          id: path.Id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{Id}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a distribution's configuration
      effect: read
      questions:
      - Where do I read just the configuration settings of a distribution before editing them?
      - Can I fetch a distribution's config along with the ETag I need to update it?
      - What origins and cache behaviors are configured on my distribution?
      instructions:
      - text: Get the configuration of distribution {id}.
        slots:
          id: path.Id
      - text: Fetch the current config and ETag for distribution {id} so I can edit it.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{Id}/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a distribution's configuration
      effect: write
      questions:
      - How do I change the settings of an existing CloudFront distribution?
      - Can I disable a distribution by updating its configuration?
      - Which ETag must I send when saving changes to a distribution's config?
      instructions:
      - text: Update the configuration of distribution {id}.
        slots:
          id: path.Id
      - text: Save the edited config for distribution {id} with ETag {etag}.
        slots:
          id: path.Id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'