Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 Control Access Points API

8 actions 8 updates phrasing extends openapi/amazon-s3-access-points-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 8

$.info
$.paths['/v20180820/accesspoint/{name}'].get
$.paths['/v20180820/accesspoint/{name}'].put
$.paths['/v20180820/accesspoint/{name}'].delete
$.paths['/v20180820/accesspoint'].get
$.paths['/v20180820/accesspoint/{name}/policy'].get
$.paths['/v20180820/accesspoint/{name}/policy'].put
$.paths['/v20180820/accesspoint/{name}/policy'].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 Access Points API
  version: 1.0.0
extends: openapi/amazon-s3-access-points-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: 7
- target: $.paths['/v20180820/accesspoint/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access point's configuration
      effect: read
      questions:
      - What bucket and network settings does an access point use?
      - Can I see whether an access point is restricted to a VPC?
      instructions:
      - text: Show the configuration of access point {name} in account {account}.
        slots:
          name: path.name
          account: header.x-amz-account-id
      - text: Get details for access point {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an access point for a bucket
      effect: write
      questions:
      - How do I give an application its own entry point into a shared S3 bucket?
      - Can I limit a new access point to traffic from one VPC?
      - Can I block public access on an access point when I create it?
      instructions:
      - text: Create access point {name} on bucket {bucket}.
        slots:
          name: path.name
          bucket: requestBody.Bucket
      - text: Create access point {name} for bucket {bucket} restricted to VPC config {vpc}.
        slots:
          name: path.name
          bucket: requestBody.Bucket
          vpc: requestBody.VpcConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access point
      effect: destructive
      questions:
      - How do I remove an access point I no longer need?
      - Does deleting an access point affect the bucket behind it?
      instructions:
      - text: Delete access point {name}.
        slots:
          name: path.name
      - text: Remove access point {name} from account {account}.
        slots:
          name: path.name
          account: header.x-amz-account-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint'].get
  update:
    x-apievangelist-phrasing:
      intent: List access points
      effect: read
      questions:
      - Which access points exist for a given bucket?
      - How many access points can I fetch per page?
      instructions:
      - text: List the access points attached to bucket {bucket}.
        slots:
          bucket: query.bucket
      - text: List all access points in account {account}, {max} at a time.
        slots:
          account: header.x-amz-account-id
          max: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint/{name}/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: View an access point's policy
      effect: read
      questions:
      - What permissions does the policy on my access point grant?
      - Is there a resource policy attached to this access point?
      instructions:
      - text: Show the access policy on access point {name}.
        slots:
          name: path.name
      - text: Get the policy document attached to access point {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint/{name}/policy'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an access point's policy
      effect: write
      questions:
      - How do I control who can use a specific access point?
      - Will attaching a policy replace the access point's existing one?
      instructions:
      - text: Attach policy {policy} to access point {name}.
        slots:
          policy: requestBody.Policy
          name: path.name
      - text: Replace the access policy on {name} so only one role can read through it.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/accesspoint/{name}/policy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an access point's policy
      effect: destructive
      questions:
      - How do I detach the resource policy from an access point?
      - Can I strip an access point's policy without deleting the access point?
      instructions:
      - text: Delete the policy on access point {name}.
        slots:
          name: path.name
      - text: Remove the access policy from {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'