Amazon DynamoDB Dynamodb Ttl API

openapi: 3.2.0
info:
  title: Amazon DynamoDB Ttl API
  version: '2012-08-10'
  description: Generated from AWS's published Smithy model for Amazon DynamoDB. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://dynamodb.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ttl
paths:
  /#DescribeTimeToLive:
    post:
      operationId: DescribeTimeToLive
      summary: Describe Time To Live
      description: Gives a description of the Time to Live (TTL) status on the specified table.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeTimeToLiveOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '421':
          description: InvalidEndpointException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidEndpointException'
        '400':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DynamoDB_20120810.DescribeTimeToLive
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeTimeToLiveInput'
      tags:
      - Ttl
  /#UpdateTimeToLive:
    post:
      operationId: UpdateTimeToLive
      summary: Update Time To Live
      description: The UpdateTimeToLive method 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. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException. TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted. The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC. DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans. As items are deleted, they are removed from any local secondary index and global secondary index immediately in the sam
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateTimeToLiveOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '421':
          description: InvalidEndpointException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidEndpointException'
        '400':
          description: LimitExceededException; ResourceInUseException; ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DynamoDB_20120810.UpdateTimeToLive
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateTimeToLiveInput'
      tags:
      - Ttl
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: Too many operations for a given subscriber.
    UpdateTimeToLiveOutput:
      type: object
      properties:
        TimeToLiveSpecification:
          $ref: '#/components/schemas/TimeToLiveSpecification'
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The resource which is being requested does not exist.
    TimeToLiveDescription:
      type: object
      properties:
        TimeToLiveStatus:
          type: string
          enum:
          - ENABLING
          - DISABLING
          - ENABLED
          - DISABLED
          description: The TTL status for the table.
        AttributeName:
          type: string
          description: The name of the TTL attribute for items in the table.
    DescribeTimeToLiveInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
      required:
      - TableName
    TimeToLiveSpecification:
      type: object
      properties:
        Enabled:
          type: boolean
          description: Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
        AttributeName:
          type: string
          description: The name of the TTL attribute used to store the expiration time for items in the table.
      required:
      - Enabled
      - AttributeName
    UpdateTimeToLiveInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
        TimeToLiveSpecification:
          $ref: '#/components/schemas/TimeToLiveSpecification'
      required:
      - TableName
      - TimeToLiveSpecification
    InternalServerError:
      type: object
      properties:
        message:
          type: string
          description: The server encountered an internal error trying to fulfill the request.
    InvalidEndpointException:
      type: object
      properties:
        Message:
          type: string
    DescribeTimeToLiveOutput:
      type: object
      properties:
        TimeToLiveDescription:
          $ref: '#/components/schemas/TimeToLiveDescription'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: dynamodb
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)