openapi: 3.0.0
info:
  version: 2006-03-01
  x-release: s3
  title: Amazon Simple Storage Service WriteGetObjectResponse#x Amz Request Route&x Amz Request Token API
  description: <p/>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: s3
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/s3-2006-03-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://s3{dash-or-dot}{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - eu-west-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - sa-east-1
      default: us-east-1
    dash-or-dot:
      description: The service/region URL separator
      enum:
      - .
      - '-'
      default: .
  description: The Amazon S3 multi-region endpoint
- url: https://s3{dash-or-dot}{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - eu-west-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - sa-east-1
      default: us-east-1
    dash-or-dot:
      description: The service/region URL separator
      enum:
      - .
      - '-'
      default: .
  description: The Amazon S3 multi-region endpoint
- url: http://s3.amazonaws.com
  variables: {}
  description: The general Amazon S3 endpoint for US East (N. Virginia)
- url: https://s3.amazonaws.com
  variables: {}
  description: The general Amazon S3 endpoint for US East (N. Virginia)
- url: http://s3.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-2
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-east-1
      - ap-south-1
      - me-south-1
      default: us-east-2
  description: The Amazon S3 multi-region endpoint
- url: https://s3.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-2
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-east-1
      - ap-south-1
      - me-south-1
      default: us-east-2
  description: The Amazon S3 multi-region endpoint
- url: http://s3.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon S3 endpoint for China (Beijing) and China (Ningxia)
- url: https://s3.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon S3 endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: WriteGetObjectResponse#x Amz Request Route&x Amz Request Token
paths:
  /WriteGetObjectResponse#x-amz-request-route&x-amz-request-token:
    parameters:
    - $ref: '#/components/parameters/x-amz-security-token'
    post:
      operationId: WriteGetObjectResponse
      description: '<p>Passes transformed objects to a <code>GetObject</code> operation when using Object Lambda access points. For information about Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with Object Lambda access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This operation supports metadata that can be returned by <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>, in addition to <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>, <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code> response metadata is supported so that the <code>WriteGetObjectResponse</code> caller, typically an Lambda function, can provide the same metadata when it internally invokes <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a customer-owned Lambda function, the metadata returned to the end user <code>GetObject</code> call might differ from what Amazon S3 would normally return.</p> <p>You can include any number of metadata headers. When including a metadata header, it should be prefaced with <code>x-amz-meta</code>. For example, <code>x-amz-meta-my-custom-header: MyCustomValue</code>. The primary use case for this is to forward <code>GetObject</code> metadata.</p> <p>Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.</p> <p>Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. </p> <p>Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. </p> <p>Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. </p> <p>For information on how to view and use these functions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html">Using Amazon Web Services built Lambda functions</a> in the <i>Amazon S3 User Guide</i>.</p>'
      responses:
        '200':
          description: Success
      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 <code>WriteGetObjectResponse</code> to the end user <code>GetObject</code> request.
        schema:
          type: string
      - name: x-amz-fwd-status
        in: header
        required: false
        description: <p>The integer status code for an HTTP response of a corresponding <code>GetObject</code> request.</p> <p class="title"> <b>Status Codes</b> </p> <ul> <li> <p> <code>200 - OK</code> </p> </li> <li> <p> <code>206 - Partial Content</code> </p> </li> <li> <p> <code>304 - Not Modified</code> </p> </li> <li> <p> <code>400 - Bad Request</code> </p> </li> <li> <p> <code>401 - Unauthorized</code> </p> </li> <li> <p> <code>403 - Forbidden</code> </p> </li> <li> <p> <code>404 - Not Found</code> </p> </li> <li> <p> <code>405 - Method Not Allowed</code> </p> </li> <li> <p> <code>409 - Conflict</code> </p> </li> <li> <p> <code>411 - Length Required</code> </p> </li> <li> <p> <code>412 - Precondition Failed</code> </p> </li> <li> <p> <code>416 - Range Not Satisfiable</code> </p> </li> <li> <p> <code>500 - Internal Server Error</code> </p> </li> <li> <p> <code>503 - Service Unavailable</code> </p> </li> </ul>
        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 &lt;Code&gt; tag of the error XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful <code>StatusCode</code> header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is <code>"^[A-Z][a-zA-Z]+$"</code>.
        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 &lt;Message&gt; tag of the error XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful <code>StatusCode</code> header or when the transformed object is provided in body.
        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: <p>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 returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p> <p/>
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-crc32c
        in: header
        required: false
        description: <p>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 returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-sha1
        in: header
        required: false
        description: <p>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 SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-checksum-sha256
        in: header
        required: false
        description: <p>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 SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>
        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 (<code>true</code>) or is not (<code>false</code>) a delete marker. '
        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
          format: date-time
      - 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 <code>expiry-date</code> and <code>rule-id</code> key-value pairs that provide the object expiration information. The value of the <code>rule-id</code> is URL-encoded. '
        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
          format: date-time
      - name: x-amz-fwd-header-x-amz-missing-meta
        in: header
        required: false
        description: Set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
        schema:
          type: integer
      - 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Object Lock</a>.
        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:
          - true
          - false
      - 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
          format: date-time
      - 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html">Replication</a>.
        schema:
          type: string
          enum:
          - COMPLETE
          - PENDING
          - FAILED
          - REPLICA
      - name: x-amz-fwd-header-x-amz-request-charged
        in: header
        required: false
        description: ''
        schema:
          type: string
          enum:
          - requester
          description: If present, indicates that the requester was successfully charged for the request.
      - 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 (for example, AES256, aws:kms).'
        schema:
          type: string
          enum:
          - AES256
          - aws:kms
      - 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 of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for stored in Amazon S3 object. '
        schema:
          type: string
          format: password
      - 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">Protecting data using server-side encryption with customer-provided encryption keys (SSE-C)</a>.'
        schema:
          type: string
      - name: x-amz-fwd-header-x-amz-storage-class
        in: header
        required: false
        description: <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
        schema:
          type: string
          enum:
          - STANDARD
          - REDUCED_REDUNDANCY
          - STANDARD_IA
          - ONEZONE_IA
          - INTELLIGENT_TIERING
          - GLACIER
          - DEEP_ARCHIVE
          - OUTPOSTS
          - GLACIER_IR
          - SNOW
      - 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
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              type: object
              properties:
                Body:
                  description: The object data.
                  type: string
                x-amz-meta-:
                  description: A map of metadata to store with the object in S3.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/MetadataValue'
      summary: Amazon S3 - WriteGetObjectResponse
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - WriteGetObjectResponse#x Amz Request Route&x Amz Request Token
components:
  schemas:
    MetadataValue:
      type: string
  parameters:
    x-amz-security-token:
      name: x-amz-security-token
      in: header
      required: false
      schema:
        type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon S3 signature
      x-amazon-apigateway-authtype: awsS3
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/s3/
x-hasEquivalentPaths: true