Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 Control Storage Lens API

5 actions 5 updates phrasing extends openapi/amazon-s3-storage-lens-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon S3's API. It is a proposal applied on top of the contract, not a document Amazon S3 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v20180820/storagelens'].get
$.paths['/v20180820/storagelens/{storagelensid}'].get
$.paths['/v20180820/storagelens/{storagelensid}'].put
$.paths['/v20180820/storagelens/{storagelensid}'].delete

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 S3 Control Storage Lens API
  version: 1.0.0
extends: openapi/amazon-s3-storage-lens-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: 4
- target: $.paths['/v20180820/storagelens'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storage Lens dashboards
      effect: read
      questions:
      - Which S3 Storage Lens configurations exist in my account?
      - How do I page through all Storage Lens dashboards?
      instructions:
      - text: List Storage Lens configurations for account {account}.
        slots:
          account: header.x-amz-account-id
      - text: List all my Storage Lens dashboards.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/storagelens/{storagelensid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Storage Lens configuration
      effect: read
      questions:
      - What metrics and scope does a Storage Lens dashboard cover?
      - Is a particular Storage Lens configuration enabled?
      instructions:
      - text: Show Storage Lens configuration {id}.
        slots:
          id: path.storagelensid
      - text: Get the settings of Storage Lens dashboard {id} in account {account}.
        slots:
          id: path.storagelensid
          account: header.x-amz-account-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/storagelens/{storagelensid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Storage Lens configuration
      effect: write
      questions:
      - How do I set up a Storage Lens dashboard for storage usage across my account?
      - Can I export Storage Lens metrics or limit them to certain buckets?
      instructions:
      - text: Save Storage Lens configuration {id} with account-level settings {account_level} and enabled {enabled}.
        slots:
          id: path.storagelensid
          account_level: requestBody.AccountLevel
          enabled: requestBody.IsEnabled
      - text: Update Storage Lens dashboard {id} to export metrics to {export}.
        slots:
          id: path.storagelensid
          export: requestBody.DataExport
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/storagelens/{storagelensid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Storage Lens configuration
      effect: destructive
      questions:
      - How do I remove a Storage Lens dashboard I no longer use?
      - Can I delete just one Storage Lens configuration?
      instructions:
      - text: Delete Storage Lens configuration {id}.
        slots:
          id: path.storagelensid
      - text: Remove Storage Lens dashboard {id} from account {account}.
        slots:
          id: path.storagelensid
          account: header.x-amz-account-id
      method: generated
      generated: '2026-10-01'