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-contributor-insights-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 Contributor Insights API
  version: '2012-08-10'
  description: Generated from AWS's published Smithy model for Amazon DynamoDB. 3 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: Contributor Insights
paths:
  /#DescribeContributorInsights:
    post:
      operationId: DescribeContributorInsights
      summary: Describe Contributor Insights
      description: Returns information about contributor insights for a given table or global secondary index.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeContributorInsightsOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '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.DescribeContributorInsights
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeContributorInsightsInput'
      tags:
      - Contributor Insights
  /#ListContributorInsights:
    post:
      operationId: ListContributorInsights
      summary: List Contributor Insights
      description: Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListContributorInsightsOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '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.ListContributorInsights
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListContributorInsightsInput'
      tags:
      - Contributor Insights
  /#UpdateContributorInsights:
    post:
      operationId: UpdateContributorInsights
      summary: Update Contributor Insights
      description: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateContributorInsightsOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '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.UpdateContributorInsights
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateContributorInsightsInput'
      tags:
      - Contributor Insights
components:
  schemas:
    UpdateContributorInsightsInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
        IndexName:
          type: string
          description: The global secondary index name, if applicable.
        ContributorInsightsAction:
          type: string
          enum:
          - ENABLE
          - DISABLE
          description: Represents the contributor insights action.
        ContributorInsightsMode:
          type: string
          enum:
          - ACCESSED_AND_THROTTLED_KEYS
          - THROTTLED_KEYS
          description: Specifies whether to track all access and throttled events or throttled events only for the DynamoDB table or index.
      required:
      - TableName
      - ContributorInsightsAction
    ContributorInsightsSummary:
      type: object
      properties:
        TableName:
          type: string
          description: Name of the table associated with the summary.
        IndexName:
          type: string
          description: Name of the index associated with the summary, if any.
        ContributorInsightsStatus:
          type: string
          enum:
          - ENABLING
          - ENABLED
          - DISABLING
          - DISABLED
          - FAILED
          description: Describes the current status for contributor insights for the given table and index, if applicable.
        ContributorInsightsMode:
          type: string
          enum:
          - ACCESSED_AND_THROTTLED_KEYS
          - THROTTLED_KEYS
          description: Indicates the current mode of CloudWatch Contributor Insights, specifying whether it tracks all access and throttled events or throttled events only for the DynamoDB table or index.
    DescribeContributorInsightsOutput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table being described.
        IndexName:
          type: string
          description: The name of the global secondary index being described.
        ContributorInsightsRuleList:
          type: array
          items:
            type: string
          description: List of names of the associated contributor insights rules.
        ContributorInsightsStatus:
          type: string
          enum:
          - ENABLING
          - ENABLED
          - DISABLING
          - DISABLED
          - FAILED
          description: Current status of contributor insights.
        LastUpdateDateTime:
          type: string
          format: date-time
          description: Timestamp of the last time the status was changed.
        FailureException:
          $ref: '#/components/schemas/FailureException'
        ContributorInsightsMode:
          type: string
          enum:
          - ACCESSED_AND_THROTTLED_KEYS
          - THROTTLED_KEYS
          description: The mode of CloudWatch Contributor Insights for DynamoDB that determines which events are emitted. Can be set to track all access and throttled events or throttled events only.
    ListContributorInsightsOutput:
      type: object
      properties:
        ContributorInsightsSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ContributorInsightsSummary'
          description: A list of ContributorInsightsSummary.
        NextToken:
          type: string
          description: A token to go to the next page if there is one.
    UpdateContributorInsightsOutput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table.
        IndexName:
          type: string
          description: The name of the global secondary index, if applicable.
        ContributorInsightsStatus:
          type: string
          enum:
          - ENABLING
          - ENABLED
          - DISABLING
          - DISABLED
          - FAILED
          description: The status of contributor insights
        ContributorInsightsMode:
          type: string
          enum:
          - ACCESSED_AND_THROTTLED_KEYS
          - THROTTLED_KEYS
          description: The updated mode of CloudWatch Contributor Insights that determines whether to monitor all access and throttled events or to track throttled events exclusively.
    ListContributorInsightsInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
        NextToken:
          type: string
          description: A token to for the desired page, if there is one.
        MaxResults:
          type: integer
          description: Maximum number of results to return per page.
    DescribeContributorInsightsInput:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
        IndexName:
          type: string
          description: The name of the global secondary index to describe, if applicable.
      required:
      - TableName
    InternalServerError:
      type: object
      properties:
        message:
          type: string
          description: The server encountered an internal error trying to fulfill the request.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The resource which is being requested does not exist.
    FailureException:
      type: object
      properties:
        ExceptionName:
          type: string
          description: Exception name.
        ExceptionDescription:
          type: string
          description: Description of the failure.
  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)