Amazon DynamoDB Exports API

openapi: 3.1.0
info:
  title: Amazon DynamoDB Backups Exports API
  description: Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB uses a JSON-based wire protocol with target-specific headers in an RPC style. The API exposes operations for creating and managing tables, reading and writing items, and executing queries and scans. All requests are authenticated via AWS Signature Version 4 and use the X-Amz-Target header to specify the operation.
  version: '2012-08-10'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://dynamodb.{region}.amazonaws.com
  description: Amazon DynamoDB Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-north-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- aws_sigv4: []
tags:
- name: Exports
  description: Operations for exporting table data to Amazon S3
paths:
  /#ExportTableToPointInTime:
    post:
      operationId: ExportTableToPointInTime
      summary: Amazon Dynamodb Export Table Data to S3
      description: Exports table data to an S3 bucket. The table must have point in time recovery enabled. You can export data in DynamoDB JSON or Amazon Ion format.
      tags:
      - Exports
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-ExportTableToPointInTime'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ExportTableToPointInTimeInput'
      responses:
        '200':
          description: Export initiated successfully
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ExportTableToPointInTimeOutput'
        '400':
          description: Bad request
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Table not found
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Limit exceeded
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        __type:
          type: string
          description: The exception type
          examples:
          - com.amazonaws.dynamodb.v20120810#ResourceNotFoundException
          - com.amazonaws.dynamodb.v20120810#ValidationException
          - com.amazonaws.dynamodb.v20120810#ConditionalCheckFailedException
          - com.amazonaws.dynamodb.v20120810#ProvisionedThroughputExceededException
          - com.amazonaws.dynamodb.v20120810#ResourceInUseException
          - com.amazonaws.dynamodb.v20120810#ItemCollectionSizeLimitExceededException
          - com.amazonaws.dynamodb.v20120810#TransactionConflictException
          - com.amazonaws.dynamodb.v20120810#TransactionCanceledException
          - com.amazonaws.dynamodb.v20120810#InternalServerError
        message:
          type: string
          description: A human-readable description of the error
          example: example_value
        Message:
          type: string
          description: A human-readable description of the error (alternative casing)
          example: example_value
    ExportTableToPointInTimeInput:
      type: object
      required:
      - TableArn
      - S3Bucket
      properties:
        TableArn:
          type: string
          description: ARN of the table to export
          example: example_value
        ExportTime:
          type: string
          format: date-time
          description: Time in the past from which to export table data
          example: '2026-01-15T10:30:00Z'
        ClientToken:
          type: string
          description: Idempotency token
          example: example_value
        S3Bucket:
          type: string
          description: Name of the S3 bucket to export to
          example: example_value
        S3BucketOwner:
          type: string
          description: Account ID of the S3 bucket owner
          example: example_value
        S3Prefix:
          type: string
          description: S3 key prefix for the export
          example: example_value
        S3SseAlgorithm:
          type: string
          enum:
          - AES256
          - KMS
          example: AES256
        S3SseKmsKeyId:
          type: string
          example: '500123'
        ExportFormat:
          type: string
          enum:
          - DYNAMODB_JSON
          - ION
          example: DYNAMODB_JSON
    ExportTableToPointInTimeOutput:
      type: object
      properties:
        ExportDescription:
          type: object
          properties:
            ExportArn:
              type: string
            ExportStatus:
              type: string
              enum:
              - IN_PROGRESS
              - COMPLETED
              - FAILED
            StartTime:
              type: string
              format: date-time
            EndTime:
              type: string
              format: date-time
            ExportTime:
              type: string
              format: date-time
            TableArn:
              type: string
            TableId:
              type: string
            S3Bucket:
              type: string
            S3Prefix:
              type: string
            ExportFormat:
              type: string
              enum:
              - DYNAMODB_JSON
              - ION
            ItemCount:
              type: integer
            ExportSizeBytes:
              type: integer
          example: example_value
  parameters:
    X-Amz-Target-ExportTableToPointInTime:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - DynamoDB_20120810.ExportTableToPointInTime
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication. All DynamoDB requests must be signed using the AWS SigV4 signing process. The service name for signing is 'dynamodb'.
externalDocs:
  description: Amazon DynamoDB API Reference
  url: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html