CloudFront · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon CloudFront Invalidations API

4 actions 4 updates phrasing extends openapi/cloudfront-invalidations-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 4

$.info
$.paths['/2020-05-31/distribution/{DistributionId}/invalidation'].get
$.paths['/2020-05-31/distribution/{DistributionId}/invalidation'].post
$.paths['/2020-05-31/distribution/{DistributionId}/invalidation/{Id}'].get

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 Invalidations API
  version: 1.0.0
extends: openapi/cloudfront-invalidations-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: 3
- target: $.paths['/2020-05-31/distribution/{DistributionId}/invalidation'].get
  update:
    x-apievangelist-phrasing:
      intent: List a distribution's cache invalidations
      effect: read
      questions:
      - Which cache invalidations have been run on my distribution?
      - Can I see the history of cache purges for one distribution?
      - How do I find past invalidation requests for a distribution?
      instructions:
      - text: List invalidations for distribution {distribution_id}.
        slots:
          distribution_id: path.DistributionId
      - text: Show the cache purge history of distribution {distribution_id}.
        slots:
          distribution_id: path.DistributionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{DistributionId}/invalidation'].post
  update:
    x-apievangelist-phrasing:
      intent: Invalidate cached content on a distribution
      effect: write
      questions:
      - How do I clear cached files from CloudFront after deploying new content?
      - Can I purge the CDN cache so users get the latest version of my site?
      - What do I call to force CloudFront to fetch fresh files from my origin?
      instructions:
      - text: Invalidate the cache on distribution {distribution_id}.
        slots:
          distribution_id: path.DistributionId
      - text: Purge cached files from distribution {distribution_id} so new content is served.
        slots:
          distribution_id: path.DistributionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2020-05-31/distribution/{DistributionId}/invalidation/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a cache invalidation
      effect: read
      questions:
      - Has my cache invalidation finished yet?
      - Can I check whether a specific invalidation is still in progress?
      - What paths were included in one invalidation request?
      instructions:
      - text: Get invalidation {id} on distribution {distribution_id}.
        slots:
          id: path.Id
          distribution_id: path.DistributionId
      - text: Check if invalidation {id} for distribution {distribution_id} has completed.
        slots:
          id: path.Id
          distribution_id: path.DistributionId
      method: generated
      generated: '2026-10-01'