Amazon Kinesis Account API

openapi: 3.2.0
info:
  title: Amazon Kinesis Data Streams Account API
  description: Amazon Kinesis Data Streams is a massively scalable and durable real-time data streaming service. It can continuously capture gigabytes of data per second from hundreds of thousands of sources such as website clickstreams, database event streams, financial transactions, social media feeds, IT logs, and location-tracking events. The Kinesis Data Streams API uses a JSON protocol over HTTP with the X-Amz-Target header to specify the action.
  version: '2013-12-02'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/kinesis/data-streams/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
servers:
- url: https://kinesis.{region}.amazonaws.com
  description: Amazon Kinesis Data Streams 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-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- aws_sigv4: []
tags:
- name: Account
  description: Operations for describing and updating account-level settings and limits.
paths:
  /#X-Amz-Target=Kinesis_20131202.DescribeLimits:
    post:
      operationId: DescribeLimits
      summary: Amazon Kinesis Describe account shard limits
      description: Describes the shard limits and usage for the account. This operation has a limit of one transaction per second per account.
      tags:
      - Account
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-DescribeLimits'
      requestBody:
        required: false
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
      responses:
        '200':
          description: Limits returned successfully.
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLimitsOutput'
        '400':
          description: Limit exceeded.
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    DescribeLimitsOutput:
      type: object
      required:
      - ShardLimit
      - OpenShardCount
      - OnDemandStreamCount
      - OnDemandStreamCountLimit
      properties:
        ShardLimit:
          type: integer
          minimum: 0
          description: The maximum number of shards.
        OpenShardCount:
          type: integer
          minimum: 0
          description: The number of open shards.
        OnDemandStreamCount:
          type: integer
          minimum: 0
          description: The number of on-demand streams.
        OnDemandStreamCountLimit:
          type: integer
          minimum: 0
          description: The maximum number of on-demand streams.
    ErrorResponse:
      type: object
      properties:
        __type:
          type: string
          description: The error type identifier.
        message:
          type: string
          description: A human-readable description of the error.
  parameters:
    X-Amz-Target-DescribeLimits:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - Kinesis_20131202.DescribeLimits
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication. Requests must be signed with the access key ID and secret access key of an IAM principal.
externalDocs:
  description: Amazon Kinesis Data Streams API Reference
  url: https://docs.aws.amazon.com/kinesis/latest/APIReference/