Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 REST Bucket Configuration API

12 actions 12 updates phrasing extends openapi/amazon-s3-bucket-configuration-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 12

$.info
$.paths['/{Bucket}?versioning'].get
$.paths['/{Bucket}?versioning'].put
$.paths['/{Bucket}?encryption'].get
$.paths['/{Bucket}?encryption'].put
$.paths['/{Bucket}?encryption'].delete
$.paths['/{Bucket}?lifecycle'].get
$.paths['/{Bucket}?lifecycle'].put
$.paths['/{Bucket}?lifecycle'].delete
$.paths['/{Bucket}?cors'].get
$.paths['/{Bucket}?cors'].put
$.paths['/{Bucket}?cors'].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 REST Bucket Configuration API
  version: 1.0.0
extends: openapi/amazon-s3-bucket-configuration-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: 11
- target: $.paths['/{Bucket}?versioning'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bucket's versioning state
      effect: read
      questions:
      - Is versioning turned on for my S3 bucket?
      - Can I see whether MFA Delete is enabled on a bucket's versioning setup?
      instructions:
      - text: Show the versioning status of bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Tell me whether versioning and MFA Delete are enabled on {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?versioning'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn bucket versioning on or suspend it
      effect: write
      questions:
      - How do I enable versioning on an existing bucket so old object versions are kept?
      - Can I suspend versioning on a bucket without deleting prior versions?
      - What does it take to switch on MFA Delete when changing versioning?
      instructions:
      - text: Enable versioning on bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Set versioning on {bucket} to {status}.
        slots:
          bucket: path.Bucket
          status: requestBody.Status
      - text: Change MFA Delete on {bucket} to {mfa_delete} using MFA token {mfa}.
        slots:
          bucket: path.Bucket
          mfa_delete: requestBody.MFADelete
          mfa: header.x-amz-mfa
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?encryption'].get
  update:
    x-apievangelist-phrasing:
      intent: View a bucket's default encryption
      effect: read
      questions:
      - What default encryption is applied to new objects in my bucket?
      - Is my bucket using SSE-S3 or a KMS key by default?
      instructions:
      - text: Show the default encryption configuration for bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Check which server-side encryption {bucket} applies by default.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?encryption'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a bucket's default encryption
      effect: write
      questions:
      - How do I make every new object in a bucket encrypted with my KMS key by default?
      - Can I turn on S3 Bucket Keys when configuring default encryption?
      instructions:
      - text: Configure default encryption on bucket {bucket} with rule {rule}.
        slots:
          bucket: path.Bucket
          rule: requestBody.Rule
      - text: Change the default server-side encryption for {bucket} to use a KMS key and Bucket Keys.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?encryption'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a bucket's default encryption to SSE-S3
      effect: destructive
      questions:
      - How do I remove a custom default encryption setting and go back to S3-managed keys?
      - What happens to default encryption when I delete a bucket's encryption configuration?
      instructions:
      - text: Reset default encryption on bucket {bucket} back to SSE-S3.
        slots:
          bucket: path.Bucket
      - text: Remove the custom default encryption configuration from {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?lifecycle'].get
  update:
    x-apievangelist-phrasing:
      intent: View a bucket's lifecycle rules
      effect: read
      questions:
      - Which lifecycle rules are set up to transition or expire objects in my bucket?
      - Does this bucket have any lifecycle configuration at all?
      instructions:
      - text: Show the lifecycle rules configured on bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: List the transition and expiration rules for {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?lifecycle'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace bucket lifecycle rules
      effect: write
      questions:
      - How do I automatically expire old objects in a bucket after a number of days?
      - Can I move objects to a cheaper storage class over time with lifecycle rules?
      - Will adding lifecycle rules replace the configuration that is already on the bucket?
      instructions:
      - text: Apply lifecycle rule {rule} to bucket {bucket}.
        slots:
          rule: requestBody.Rule
          bucket: path.Bucket
      - text: Replace the lifecycle configuration on {bucket} with rules that expire old log files.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?lifecycle'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all lifecycle rules from a bucket
      effect: destructive
      questions:
      - How do I stop all automatic expirations and transitions on a bucket?
      - Can I wipe a bucket's lifecycle configuration entirely?
      instructions:
      - text: Delete the lifecycle configuration from bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Remove every lifecycle rule on {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?cors'].get
  update:
    x-apievangelist-phrasing:
      intent: View a bucket's CORS rules
      effect: read
      questions:
      - Which origins are allowed to make cross-origin requests to my bucket?
      - What CORS configuration is set on my S3 bucket right now?
      instructions:
      - text: Show the CORS rules for bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: List the allowed origins and methods in the CORS setup of {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?cors'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a bucket's CORS rules
      effect: write
      questions:
      - How do I let my web app's domain fetch files from a bucket in the browser?
      - Does setting CORS rules overwrite the ones already on the bucket?
      instructions:
      - text: Set CORS on bucket {bucket} to rule {cors_rule}.
        slots:
          bucket: path.Bucket
          cors_rule: requestBody.CORSRule
      - text: Allow GET requests from my site's origin on {bucket} via a CORS rule.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}?cors'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a bucket's CORS rules
      effect: destructive
      questions:
      - How do I remove all cross-origin access rules from a bucket?
      - Can I clear the CORS configuration so browsers can no longer fetch cross-origin?
      instructions:
      - text: Delete the CORS configuration from bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Clear all CORS rules on {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'