Amazon S3 Versions (bucket-level)

openapi: 3.1.0
info:
  title: Amazon S3 Versions (bucket-level)
  description: '1 operations from the Amazon S3 REST API, generated from the authoritative service model.


    S3 identifies these operations by the `versions` query subresource, which is declared as a required
    query parameter on each one because an OpenAPI path cannot carry a query string.


    Generated from boto/botocore `service-2.json` at `aeb03fc4ae530e0b3f47d588b6021581db870c8c` (Apache-2.0).
    Responses are XML.'
  version: '2006-03-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
externalDocs:
  description: Amazon S3 API Reference
  url: https://docs.aws.amazon.com/AmazonS3/latest/API/
servers:
- url: https://s3.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: versions
paths:
  /{Bucket}:
    get:
      operationId: ListObjectVersions
      summary: This operation is not supported for directory buckets. Returns metadata about all versions
        of the objects in a bucket. Y
      description: 'This operation is not supported for directory buckets. Returns metadata about all
        versions of the objects in a bucket. You can also use request parameters as selection criteria
        to return metadata about a subset of all the object versions. To use this operation, you must
        have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.
        A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse
        the contents of the response and handle it appropriately. To use this operation, you must have
        READ access to the bucket. The following operations are related to ListObjectVersions: ListObjectsV2
        GetObject PutObject DeleteObject You must URL encode any signed header values that contain spaces.
        For example, if your header value is my file.txt, containing two spaces after my, you must URL
        encode this value to my%20%20file.txt.'
      tags:
      - versions
      parameters:
      - name: versions
        in: query
        required: true
        description: Selects this operation. S3 identifies it by the `versions` subresource.
        schema:
          type: string
      - name: Bucket
        in: path
        required: true
        description: The bucket name that contains the objects.
        schema:
          type: string
      - name: delimiter
        in: query
        required: false
        description: 'A delimiter is a character that you specify to group keys. All keys that contain
          the same string between the prefix and the first occurrence of the delimiter are grouped under
          a single result element '
        schema:
          type: string
      - name: encoding-type
        in: query
        required: false
        schema:
          type: string
          enum:
          - url
      - name: key-marker
        in: query
        required: false
        description: Specifies the key to start with when listing objects in a bucket.
        schema:
          type: string
      - name: max-keys
        in: query
        required: false
        description: Sets the maximum number of keys returned in the response. By default, the action
          returns up to 1,000 key names. The response might contain fewer keys but will never contain
          more. If additional keys sa
        schema:
          type: integer
      - name: prefix
        in: query
        required: false
        description: Use this parameter to select only those keys that begin with the specified prefix.
          You can use prefixes to separate a bucket into different groupings of keys. (You can think of
          using prefix to make gr
        schema:
          type: string
      - name: version-id-marker
        in: query
        required: false
        description: Specifies the object version you want to start listing from.
        schema:
          type: string
      - name: x-amz-expected-bucket-owner
        in: header
        required: false
        description: The account ID of the expected bucket owner. If the account ID that you provide does
          not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
          (access denied)
        schema:
          type: string
      - name: x-amz-request-payer
        in: header
        required: false
        schema:
          type: string
          enum:
          - requester
      - name: x-amz-optional-object-attributes
        in: header
        required: false
        description: Specifies the optional fields that you want returned in the response. Fields that
          you do not specify are not returned.
        schema:
          type: string
      responses:
        '200':
          description: Success. S3 answers in XML, not JSON.
          x-output-shape: ListObjectVersionsOutput
        '403':
          description: AccessDenied. S3 validates the signature before it routes the operation, so this
            does not distinguish an unsupported operation from an unauthorised one.