Amazon DynamoDB TTL API

openapi: 3.1.0
info:
  title: Amazon DynamoDB Backups TTL 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: TTL
  description: Time to Live configuration for automatic item expiration
paths:
  /#DescribeTimeToLive:
    post:
      operationId: DescribeTimeToLive
      summary: Amazon Dynamodb Describe Ttl Settings for a Table
      description: Gives a description of the Time to Live (TTL) status on the specified table.
      tags:
      - TTL
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-DescribeTimeToLive'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeTimeToLiveInput'
      responses:
        '200':
          description: TTL description returned successfully
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeTimeToLiveOutput'
        '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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#UpdateTimeToLive:
    post:
      operationId: UpdateTimeToLive
      summary: Amazon Dynamodb Enable or Disable Ttl on a Table
      description: Enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process.
      tags:
      - TTL
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-UpdateTimeToLive'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateTimeToLiveInput'
      responses:
        '200':
          description: TTL updated successfully
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateTimeToLiveOutput'
        '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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateTimeToLiveOutput:
      type: object
      properties:
        TimeToLiveSpecification:
          type: object
          properties:
            Enabled:
              type: boolean
            AttributeName:
              type: string
          example: example_value
    DescribeTimeToLiveOutput:
      type: object
      properties:
        TimeToLiveDescription:
          type: object
          properties:
            TimeToLiveStatus:
              type: string
              enum:
              - ENABLING
              - DISABLING
              - ENABLED
              - DISABLED
            AttributeName:
              type: string
          example: example_value
    UpdateTimeToLiveInput:
      type: object
      required:
      - TableName
      - TimeToLiveSpecification
      properties:
        TableName:
          type: string
          minLength: 3
          maxLength: 255
          example: example_value
        TimeToLiveSpecification:
          type: object
          required:
          - Enabled
          - AttributeName
          properties:
            Enabled:
              type: boolean
            AttributeName:
              type: string
              minLength: 1
              maxLength: 255
          example: example_value
    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
    DescribeTimeToLiveInput:
      type: object
      required:
      - TableName
      properties:
        TableName:
          type: string
          minLength: 3
          maxLength: 255
          example: example_value
  parameters:
    X-Amz-Target-UpdateTimeToLive:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - DynamoDB_20120810.UpdateTimeToLive
    X-Amz-Target-DescribeTimeToLive:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - DynamoDB_20120810.DescribeTimeToLive
  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