APIs.io Engineering Platform R2 Event Notification API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 R2 Event Notification API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</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: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    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://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: R2 Event Notification
paths:
  /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration:
    get:
      description: Returns all notification rules for each queue for which bucket notifications are produced.
      operationId: event-notification-get-r2-bucket-configs
      parameters:
      - in: path
        name: bucket_name
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Read Configuration failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_bucket-config'
                  type: object
          description: Read Configuration response
        '404':
          content:
            application/json:
              example:
                errors:
                - code: 11015
                  message: workers.api.error.no_configs_found_for_bucket
                messages: []
                result: null
                success: false
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: No Configuration Found response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Read Configuration
      tags:
      - R2 Event Notification
      x-api-token-group:
      - Workers R2 Storage Read
  /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}:
    delete:
      description: Turn off all event notifications configured for delivery to a given queue. No further notifications will be produced for the queue once complete.
      operationId: event-notification-delete-queue-config
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: bucket_name
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Configuration failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common'
          description: Delete Configuration response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Configuration
      tags:
      - R2 Event Notification
    put:
      description: Define the rules for a given queue which will determine event notification production.
      operationId: event-notification-create-queue-config
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: bucket_name
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                rules:
                  description: Array of rules to drive notifications
                  items:
                    $ref: '#/components/schemas/mq_rule'
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Configuration failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-common'
                - properties:
                    result:
                      properties:
                        event_notification_detail_id:
                          example: deadbeef-1234-4e81-5678-abadfeedbead
                          type: string
                      type: object
                  type: object
          description: Create Configuration response
        '409':
          content:
            application/json:
              example:
                errors:
                - code: 11010
                  message: workers.api.error.event_notification_detail_exists
                messages: []
                result: null
                success: false
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Duplicate Configuration failure
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Configuration
      tags:
      - R2 Event Notification
components:
  schemas:
    mq_rule:
      properties:
        actions:
          description: Array of R2 object actions that will trigger notifications
          example:
          - PutObject
          - CopyObject
          items:
            $ref: '#/components/schemas/mq_r2-action'
          type: array
          uniqueItems: true
        prefix:
          description: Notifications will be sent only for objects with this prefix
          example: img/
          type: string
        suffix:
          description: Notifications will be sent only for objects with this suffix
          example: .jpeg
          type: string
      required:
      - actions
      type: object
    mq_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/mq_messages'
        messages:
          $ref: '#/components/schemas/mq_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful.
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    mq_r2-action:
      enum:
      - PutObject
      - CopyObject
      - DeleteObject
      - CompleteMultipartUpload
      - AbortMultipartUpload
      type: string
    mq_config-detail:
      additionalProperties:
        $ref: '#/components/schemas/mq_detail'
      type: object
    mq_detail:
      properties:
        queue:
          description: Queue ID that will receive notifications based on the configured rules
          example: 98fa6c35-dead-beef-a42b-8d12196e0000
          type: string
        rules:
          description: Array of rules to drive notifications
          items:
            $ref: '#/components/schemas/mq_rule'
          type: array
      required:
      - queue
      - rules
      type: object
    mq_bucket-config:
      additionalProperties:
        $ref: '#/components/schemas/mq_config-detail'
      example:
        my-bucket:
          b588b5d5-0647-4e81-bb8c-800fad2239a0:
            queue: 98fa6c35-dead-beef-a42b-8d12196e0000
            rules:
            - actions:
              - PutObject
              - DeleteObject
              prefix: img/
              suffix: .jpg
          deadbeef-1234-4e81-5678-abadfeedbead:
            queue: 11111111-dead-beef-0000-109238eeffff
            rules:
            - actions:
              - CopyObject
              suffix: .mov
      type: object
    mq_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/mq_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/mq_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful.
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    mq_identifier:
      description: Identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    mq_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true