find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-dynamodb:amazon-dynamodb-streams-kinesis-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon DynamoDB Streams Kinesis API
  version: '2012-08-10'
  description: Generated from AWS's published Smithy model for Amazon DynamoDB. 4 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: Streams Kinesis
paths:
  /#DescribeKinesisStreamingDestination:
    post:
      operationId: DescribeKinesisStreamingDestination
      summary: Describe Kinesis Streaming Destination
      description: Returns information about the status of Kinesis streaming.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeKinesisStreamingDestinationOutput'
        '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.DescribeKinesisStreamingDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeKinesisStreamingDestinationInput'
      tags:
      - Streams Kinesis
  /#DisableKinesisStreamingDestination:
    post:
      operationId: DisableKinesisStreamingDestination
      summary: Disable Kinesis Streaming Destination
      description: Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/KinesisStreamingDestinationOutput'
        '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.DisableKinesisStreamingDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/KinesisStreamingDestinationInput'
      tags:
      - Streams Kinesis
  /#EnableKinesisStreamingDestination:
    post:
      operationId: EnableKinesisStreamingDestination
      summary: Enable Kinesis Streaming Destination
      description: Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/KinesisStreamingDestinationOutput'
        '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.EnableKinesisStreamingDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/KinesisStreamingDestinationInput'
      tags:
      - Streams Kinesis
  /#UpdateKinesisStreamingDestination:
    post:
      operationId: UpdateKinesisStreamingDestination
      summary: Update Kinesis Streaming Destination
      description: The command to update the Kinesis stream destination.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateKinesisStreamingDestinationOutput'
        '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.UpdateKinesisStreamingDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateKinesisStreamingDestinationInput'
      tags:
      - Streams Kinesis
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: Too many operations for a given subscriber.
    DescribeKinesisStreamingDestinationInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
      required:
      - TableName
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The resource which is being requested does not exist.
    EnableKinesisStreamingConfiguration:
      type: object
      properties:
        ApproximateCreationDateTimePrecision:
          type: string
          enum:
          - MILLISECOND
          - MICROSECOND
          description: Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
    KinesisDataStreamDestination:
      type: object
      properties:
        StreamArn:
          type: string
          description: The ARN for a specific Kinesis data stream.
        DestinationStatus:
          type: string
          enum:
          - ENABLING
          - ACTIVE
          - DISABLING
          - DISABLED
          - ENABLE_FAILED
          - UPDATING
          description: The current status of replication.
        DestinationStatusDescription:
          type: string
          description: The human-readable string that corresponds to the replica status.
        ApproximateCreationDateTimePrecision:
          type: string
          enum:
          - MILLISECOND
          - MICROSECOND
          description: The precision of the Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
    UpdateKinesisStreamingConfiguration:
      type: object
      properties:
        ApproximateCreationDateTimePrecision:
          type: string
          enum:
          - MILLISECOND
          - MICROSECOND
          description: Enables updating the precision of Kinesis data stream timestamp.
    KinesisStreamingDestinationOutput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table being modified.
        StreamArn:
          type: string
          description: The ARN for the specific Kinesis data stream.
        DestinationStatus:
          type: string
          enum:
          - ENABLING
          - ACTIVE
          - DISABLING
          - DISABLED
          - ENABLE_FAILED
          - UPDATING
          description: The current status of the replication.
        EnableKinesisStreamingConfiguration:
          $ref: '#/components/schemas/EnableKinesisStreamingConfiguration'
    UpdateKinesisStreamingDestinationInput:
      type: object
      properties:
        TableName:
          type: string
          description: The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.
        StreamArn:
          type: string
          description: The Amazon Resource Name (ARN) for the Kinesis stream input.
        UpdateKinesisStreamingConfiguration:
          $ref: '#/components/schemas/UpdateKinesisStreamingConfiguration'
      required:
      - TableName
      - StreamArn
    DescribeKinesisStreamingDestinationOutput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table being described.
        KinesisDataStreamDestinations:
          type: array
          items:
            $ref: '#/components/schemas/KinesisDataStreamDestination'
          description: The list of replica structures for the table being described.
    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
    KinesisStreamingDestinationInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
        StreamArn:
          type: string
          description: The ARN for a Kinesis data stream.
        EnableKinesisStreamingConfiguration:
          $ref: '#/components/schemas/EnableKinesisStreamingConfiguration'
      required:
      - TableName
      - StreamArn
    UpdateKinesisStreamingDestinationOutput:
      type: object
      properties:
        TableName:
          type: string
          description: The table name for the Kinesis streaming destination output.
        StreamArn:
          type: string
          description: The ARN for the Kinesis stream input.
        DestinationStatus:
          type: string
          enum:
          - ENABLING
          - ACTIVE
          - DISABLING
          - DISABLED
          - ENABLE_FAILED
          - UPDATING
          description: The status of the attempt to update the Kinesis streaming destination output.
        UpdateKinesisStreamingConfiguration:
          $ref: '#/components/schemas/UpdateKinesisStreamingConfiguration'
  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)