Amazon Keyspaces Keyspaces Operations API

openapi: 3.1.0
info:
  title: Amazon Keyspaces Operations API
  version: '2022-02-10'
  description: Generated from AWS's published Smithy model for Amazon Keyspaces. 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://cassandra.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#GetTableAutoScalingSettings:
    post:
      operationId: GetTableAutoScalingSettings
      summary: Get Table Auto Scaling Settings
      description: 'Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region
        table, the Amazon Web Services Region specific auto scaling settings of the table are included. Amazon Keyspaces auto
        scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your
        table''s read and write capacity automatically in response to application traffic. For more information, see Managing
        throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide. GetTableAutoScalingSettings
        can''t be used as an action in an IAM policy. To define permissions for GetTableAutoScalingSettings, you must allow
        the following two actions in the IAM policy statement''s Action element: application-autoscaling:DescribeScalableTargets
        application-autoscaling:DescribeScalingPolicies'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetTableAutoScalingSettingsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - KeyspacesService.GetTableAutoScalingSettings
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetTableAutoScalingSettingsRequest'
      tags:
      - Operations
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Returns a list of all tags associated with the specified Amazon Keyspaces resource. To read keyspace metadata
        using ListTagsForResource, the IAM principal needs Select action permissions for the specified resource and the system
        keyspace.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - KeyspacesService.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Operations
  /#TagResource:
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags
        so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding
        tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide. For IAM policy examples that
        show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based
        on tags in the Amazon Keyspaces Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - KeyspacesService.TagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/TagResourceRequest'
      tags:
      - Operations
  /#UntagResource:
    post:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes the association of tags from a Amazon Keyspaces resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - KeyspacesService.UntagResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UntagResourceRequest'
      tags:
      - Operations
components:
  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: cassandra
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: You don't have the required permissions to perform this operation. Verify your IAM permissions and
            try again.
    AutoScalingPolicy:
      type: object
      properties:
        targetTrackingScalingPolicyConfiguration:
          $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration'
    AutoScalingSettings:
      type: object
      properties:
        autoScalingDisabled:
          type: boolean
          description: This optional parameter enables auto scaling for the table if set to false.
        minimumUnits:
          type: integer
          description: The minimum level of throughput the table should always be ready to support. The value must be between
            1 and the max throughput per second quota for your account (40,000 by default).
        maximumUnits:
          type: integer
          description: Manage costs by specifying the maximum amount of throughput to provision. The value must be between
            1 and the max throughput per second quota for your account (40,000 by default).
        scalingPolicy:
          $ref: '#/components/schemas/AutoScalingPolicy'
    AutoScalingSpecification:
      type: object
      properties:
        writeCapacityAutoScaling:
          $ref: '#/components/schemas/AutoScalingSettings'
        readCapacityAutoScaling:
          $ref: '#/components/schemas/AutoScalingSettings'
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The requested operation conflicts with the current state of the resource or another concurrent operation.
    GetTableAutoScalingSettingsRequest:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
        tableName:
          type: string
          description: The name of the table.
      required:
      - keyspaceName
      - tableName
    GetTableAutoScalingSettingsResponse:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
        tableName:
          type: string
          description: The name of the table.
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the table.
        autoScalingSpecification:
          $ref: '#/components/schemas/AutoScalingSpecification'
        replicaSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/ReplicaAutoScalingSpecification'
          description: The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for
            all Regions the table is replicated in.
      required:
      - keyspaceName
      - tableName
      - resourceArn
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: An internal service error occurred. Retry your request. If the problem persists, contact Amazon Web
            Services Support.
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
        nextToken:
          type: string
          description: The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent
            API invocation.
        maxResults:
          type: integer
          description: The total number of tags to return in the output. If the total number of tags available is more than
            the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value
            as an argument of a subsequent API invocation.
      required:
      - resourceArn
    ListTagsForResourceResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags.
    ReplicaAutoScalingSpecification:
      type: object
      properties:
        region:
          type: string
          description: The Amazon Web Services Region.
        autoScalingSpecification:
          $ref: '#/components/schemas/AutoScalingSpecification'
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The specified resource was not found. Verify the resource identifier and ensure the resource exists
            and is in an ACTIVE state.
        resourceArn:
          type: string
          description: The unique identifier in the format of Amazon Resource Name (ARN) for the resource couldn't be found.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: The requested operation would exceed the service quota for this resource. Review the service quotas
            and adjust your request accordingly.
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource 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
    TagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the Amazon Keyspaces resource.
      required:
      - resourceArn
      - tags
    TagResourceResponse:
      type: object
      properties: {}
    TargetTrackingScalingPolicyConfiguration:
      type: object
      properties:
        disableScaleIn:
          type: boolean
          description: Specifies if scale-in is enabled. When auto scaling automatically decreases capacity for a table, the
            table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.
        scaleInCooldown:
          type: integer
          description: Specifies a scale-in cool down period. A cooldown period in seconds between scaling activities that
            lets the table stabilize before another scaling activity starts.
        scaleOutCooldown:
          type: integer
          description: Specifies a scale out cool down period. A cooldown period in seconds between scaling activities that
            lets the table stabilize before another scaling activity starts.
        targetValue:
          type: number
          description: Specifies the target value for the target tracking auto scaling policy. Amazon Keyspaces auto scaling
            scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it
            falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near
            this value. You define targetValue as a percentage. A double between 20 and 90.
      required:
      - targetValue
    UntagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource
            Name (ARN).
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of existing tags to be removed from the Amazon Keyspaces resource.
      required:
      - resourceArn
      - tags
    UntagResourceResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The request parameters are invalid or malformed. Review the API documentation and correct the request
            format.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/keyspaces/service/2022-02-10/keyspaces-2022-02-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)