Amazon S3 Bucket API

openapi: 3.2.0
info:
  title: Amazon S3 Core (-level) Bucket API
  description: '5 operations from the Amazon S3 REST API, generated from the authoritative service model.


    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/
servers:
- url: https://s3.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Bucket
paths:
  /WriteGetObjectResponse:
    post:
      operationId: WriteGetObjectResponse
      summary: This operation is not supported for directory buckets
      description: 'This operation is not supported for directory buckets. Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide. This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return. You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata. Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable informa'
      tags:
      - Bucket
      parameters:
      - name: x-amz-request-route
        in: header
        required: true
        description: Route prefix to the HTTP URL generated.
        schema:
          type: string
      - name: x-amz-request-token
        in: header
        required: true
        description: A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
        schema:
          type: string
      - name: x-amz-fwd-status
        in: header
        required: false
        description: The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes. 200 - OK 206 - Partial Content 304 - Not Modified 400 - Bad Request 401 - Un
        schema:
          type: integer
      - name: x-amz-fwd-error-code
        in: header
        required: false
        description: 'A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header '
        schema:
          type: string
      - name: x-amz-fwd-error-message
        in: header
        required: false
        description: Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode hea
        schema:
          type: string
      - name: x-amz-fwd-header-accept-ranges
        in: header
        required: false
        description: Indicates that a range of bytes was specified.
        schema:
          type: string
      - name: x-amz-fwd-header-Cache-Control
        in: header
        required: false
        description: Specifies caching behavior along the request/reply chain.
        schema:
          type: string
      - name: x-amz-fwd-header-Content-Disposition
        in: header
        required: false
        description: Specifies presentational information for the object.
        schema:
          type: string
      - name: x-amz-fwd-header-Content-Encoding
        in: header
        required: false
        description: Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
        schema:
          type: string
      - name: x-amz-fwd-header-Content-Language
        in: header
        required: false
        description: The language the content is in.
        schema:
          type: string
      - name: Content-Length
        in: header
        required: false
        description: The size of the content body in bytes.
        schema:
          type: integer
      - name: x-amz-fwd-header-Content-Range
        in: header
        required: false
        description: The portion of the object returned in the response.
        schema:
          type: string
      - name: x-amz-fwd-header-Content-Type
        in: header
        required: false
        description: A standard MIME type describing the format of the object data.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-crc32
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32 checksum of the object ret
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-crc32c
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32C checksum of the object re
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-crc64nvme
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-sha1
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 160-bit SHA1 digest of the object retur
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-sha256
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 256-bit SHA256 digest of the object ret
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-sha512
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 512-bit SHA512 digest of the par
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-md5
        in: header
        required: false
        description: 'This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 128-bit MD5 digest of the part. '
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-xxhash64
        in: header
        required: false
        description: 'This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit XXHASH64 checksum of the '
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-xxhash3
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit XXHASH3 checksum of the p
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-xxhash128
        in: header
        required: false
        description: This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 128-bit XXHASH128 checksum of th
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-delete-marker
        in: header
        required: false
        description: Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.
        schema:
          type: boolean
      - name: x-amz-fwd-header-ETag
        in: header
        required: false
        description: An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
        schema:
          type: string
      - name: x-amz-fwd-header-Expires
        in: header
        required: false
        description: The date and time at which the object is no longer cacheable.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-expiration
        in: header
        required: false
        description: If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration informa
        schema:
          type: string
      - name: x-amz-fwd-header-Last-Modified
        in: header
        required: false
        description: The date and time that the object was last modified.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-missing-meta
        in: header
        required: false
        description: Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For exam
        schema:
          type: integer
      - name: x-amz-meta-
        in: header
        required: false
        description: A map of metadata to store with the object in S3.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-object-lock-mode
        in: header
        required: false
        description: Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
        schema:
          type: string
          enum:
          - GOVERNANCE
          - COMPLIANCE
      - name: x-amz-fwd-header-x-amz-object-lock-legal-hold
        in: header
        required: false
        description: Indicates whether an object stored in Amazon S3 has an active legal hold.
        schema:
          type: string
          enum:
          - 'ON'
          - 'OFF'
      - name: x-amz-fwd-header-x-amz-object-lock-retain-until-date
        in: header
        required: false
        description: The date and time when Object Lock is configured to expire.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-mp-parts-count
        in: header
        required: false
        description: The count of parts this object has.
        schema:
          type: integer
      - name: x-amz-fwd-header-x-amz-replication-status
        in: header
        required: false
        description: Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
        schema:
          type: string
          enum:
          - COMPLETE
          - PENDING
          - FAILED
          - REPLICA
          - COMPLETED
      - name: x-amz-fwd-header-x-amz-request-charged
        in: header
        required: false
        schema:
          type: string
          enum:
          - requester
      - name: x-amz-fwd-header-x-amz-restore
        in: header
        required: false
        description: Provides information about object restoration operation and expiration time of the restored object copy.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-server-side-encryption
        in: header
        required: false
        description: 'The server-side encryption algorithm used when storing requested object in Amazon S3 or Amazon FSx. When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server '
        schema:
          type: string
          enum:
          - AES256
          - aws:fsx
          - aws:backup
          - aws:kms
          - aws:kms:dsse
      - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm
        in: header
        required: false
        description: Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id
        in: header
        required: false
        description: If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for sto
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5
        in: header
        required: false
        description: 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided enc
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-storage-class
        in: header
        required: false
        description: Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects. For more information, see Storage Classes.
        schema:
          type: string
          enum:
          - STANDARD
          - REDUCED_REDUNDANCY
          - STANDARD_IA
          - ONEZONE_IA
          - INTELLIGENT_TIERING
          - GLACIER
          - DEEP_ARCHIVE
          - OUTPOSTS
          - GLACIER_IR
          - SNOW
          - EXPRESS_ONEZONE
          - FSX_OPENZFS
          - FSX_ONTAP
          - AWS_BACKUP_WARM
          - AWS_BACKUP_LOW_COST_WARM
      - name: x-amz-fwd-header-x-amz-tagging-count
        in: header
        required: false
        description: The number of tags, if any, on the object.
        schema:
          type: integer
      - name: x-amz-fwd-header-x-amz-version-id
        in: header
        required: false
        description: An ID used to reference a specific version of the object.
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled
        in: header
        required: false
        description: Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
        schema:
          type: boolean
      responses:
        '200':
          description: Success. S3 answers in XML, not JSON.
        '403':
          description: AccessDenied. S3 validates the signature before it routes the operation, so this does not distinguish an unsupported operation from an unauthorised one.
externalDocs:
  description: Amazon S3 API Reference
  url: https://docs.aws.amazon.com/AmazonS3/latest/API/