Amazon DynamoDB Dynamodb Tags API

openapi: 3.2.0
info:
  title: Amazon DynamoDB Tags 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: Tags
paths:
  /#ListTagsOfResource:
    post:
      operationId: ListTagsOfResource
      summary: List Tags Of Resource
      description: List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListTagsOfResourceOutput'
        '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.ListTagsOfResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListTagsOfResourceInput'
      tags:
      - Tags
  /#TagResource:
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account. TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again. The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '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.TagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/TagResourceInput'
      tags:
      - Tags
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
        Value:
          type: string
          description: The value of the tag. Tag values are case-sensitive and can be null.
      required:
      - Key
      - Value
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: Too many operations for a given subscriber.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The resource which is being requested does not exist.
    TagResourceInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the Amazon DynamoDB resource.
      required:
      - ResourceArn
      - Tags
    ListTagsOfResourceOutput:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags currently associated with the Amazon DynamoDB resource.
        NextToken:
          type: string
          description: If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.
    ListTagsOfResourceInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
        NextToken:
          type: string
          description: An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.
      required:
      - ResourceArn
    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
  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)