Amazon Keyspaces API

openapi: 3.2.0
info:
  title: Amazon Keyspaces API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Keyspaces across 2 of this provider''s published API definitions: amazon-keyspaces-openapi.yml, amazon-keyspaces-keyspaces-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cassandra.us-east-1.amazonaws.com
  description: Amazon Keyspaces endpoint
- url: https://cassandra.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Keyspaces
  description: Cassandra keyspace management
paths:
  /keyspaces:
    post:
      operationId: CreateKeyspace
      summary: Amazon Keyspaces Create Keyspace
      description: Creates a new keyspace.
      tags:
      - Keyspaces
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListKeyspaces
      summary: Amazon Keyspaces List Keyspaces
      description: Returns a list of keyspaces.
      tags:
      - Keyspaces
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://cassandra.us-east-1.amazonaws.com
      description: Amazon Keyspaces endpoint
  /keyspaces/{keyspaceName}:
    get:
      operationId: GetKeyspace
      summary: Amazon Keyspaces Get Keyspace
      description: Returns the name and the Amazon Resource Name (ARN) of a keyspace.
      tags:
      - Keyspaces
      parameters:
      - name: keyspaceName
        in: path
        required: true
        schema:
          type: string
        description: The name of the keyspace.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteKeyspace
      summary: Amazon Keyspaces Delete Keyspace
      description: The DeleteKeyspace operation allows you to delete a keyspace and all of its tables.
      tags:
      - Keyspaces
      parameters:
      - name: keyspaceName
        in: path
        required: true
        schema:
          type: string
        description: The name of the keyspace.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request
        '403':
          description: Access denied
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://cassandra.us-east-1.amazonaws.com
      description: Amazon Keyspaces endpoint
  /#CreateKeyspace:
    post:
      operationId: post#CreateKeyspace
      summary: Create Keyspace
      description: The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region. CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation. For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateKeyspaceResponse'
        '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'
        '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.CreateKeyspace
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateKeyspaceRequest'
      tags:
      - Keyspaces
      x-operation-id-source: normalized
      x-operation-id-original: CreateKeyspace
    servers:
    - url: https://cassandra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DeleteKeyspace:
    post:
      operationId: post#DeleteKeyspace
      summary: Delete Keyspace
      description: The DeleteKeyspace operation deletes a keyspace and all of its tables.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteKeyspaceResponse'
        '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.DeleteKeyspace
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteKeyspaceRequest'
      tags:
      - Keyspaces
      x-operation-id-source: normalized
      x-operation-id-original: DeleteKeyspace
    servers:
    - url: https://cassandra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#GetKeyspace:
    post:
      operationId: post#GetKeyspace
      summary: Get Keyspace
      description: Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetKeyspaceResponse'
        '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.GetKeyspace
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetKeyspaceRequest'
      tags:
      - Keyspaces
      x-operation-id-source: normalized
      x-operation-id-original: GetKeyspace
    servers:
    - url: https://cassandra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#ListKeyspaces:
    post:
      operationId: post#ListKeyspaces
      summary: List Keyspaces
      description: The ListKeyspaces operation returns a list of keyspaces.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListKeyspacesResponse'
        '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.ListKeyspaces
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListKeyspacesRequest'
      tags:
      - Keyspaces
      x-operation-id-source: normalized
      x-operation-id-original: ListKeyspaces
    servers:
    - url: https://cassandra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#UpdateKeyspace:
    post:
      operationId: UpdateKeyspace
      summary: Update Keyspace
      description: 'Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide. To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal needs permissions for the following IAM actions: cassandra:Alter cassandra:AlterMultiRegionResource cassandra:Create cassandra:CreateMultiRegionResource cassandra:Select cassandra:SelectMultiRegionResource cassandra:Modify cassandra:ModifyMultiRegionResource If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed. application-autoscaling:RegisterScalableTarget application-autoscaling:DeregisterScalableTarget application-autoscal'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateKeyspaceResponse'
        '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.UpdateKeyspace
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateKeyspaceRequest'
      tags:
      - Keyspaces
    servers:
    - url: https://cassandra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    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
    CreateKeyspaceRequest:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace to be created.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of key-value pair tags to be attached to the keyspace. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
        replicationSpecification:
          $ref: '#/components/schemas/ReplicationSpecification'
      required:
      - keyspaceName
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The request parameters are invalid or malformed. Review the API documentation and correct the request format.
    UpdateKeyspaceRequest:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
        replicationSpecification:
          $ref: '#/components/schemas/ReplicationSpecification'
        clientSideTimestamps:
          $ref: '#/components/schemas/ClientSideTimestamps'
      required:
      - keyspaceName
      - replicationSpecification
    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.
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The requested operation conflicts with the current state of the resource or another concurrent operation.
    ReplicationSpecification:
      type: object
      properties:
        replicationStrategy:
          type: string
          description: The replicationStrategy of a keyspace, the required value is SINGLE_REGION or MULTI_REGION.
        regionList:
          type: array
          items:
            type: string
          description: The regionList contains the Amazon Web Services Regions where the keyspace is replicated in.
      required:
      - replicationStrategy
    CreateKeyspaceResponse:
      type: object
      properties:
        resourceArn:
          type: string
          description: The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
      required:
      - resourceArn
    DeleteKeyspaceResponse:
      type: object
      properties: {}
    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.
    ListKeyspacesResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
        keyspaces:
          type: array
          items:
            $ref: '#/components/schemas/KeyspaceSummary'
          description: A list of keyspaces.
      required:
      - keyspaces
    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.
    ClientSideTimestamps:
      type: object
      properties:
        status:
          type: string
          description: Shows how to enable client-side timestamps settings for the specified table.
      required:
      - status
    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.
    ReplicationGroupStatus:
      type: object
      properties:
        region:
          type: string
          description: The name of the Region that was added to the keyspace.
        keyspaceStatus:
          type: string
          description: The status of the keyspace.
        tablesReplicationProgress:
          type: string
          description: This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables with status Active compared to the total number of tables in the keyspace.
      required:
      - region
      - keyspaceStatus
    DeleteKeyspaceRequest:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace to be deleted.
      required:
      - keyspaceName
    UpdateKeyspaceResponse:
      type: object
      properties:
        resourceArn:
          type: string
          description: The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
      required:
      - resourceArn
    GetKeyspaceResponse:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
        resourceArn:
          type: string
          description: Returns the ARN of the keyspace.
        replicationStrategy:
          type: string
          description: Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_REGION.
        replicationRegions:
          type: array
          items:
            type: string
          description: If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
        replicationGroupStatuses:
          type: array
          items:
            $ref: '#/components/schemas/ReplicationGroupStatus'
          description: A list of all Regions the keyspace is replicated in after the update keyspace operation and their status.
      required:
      - keyspaceName
      - resourceArn
      - replicationStrategy
    KeyspaceSummary:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
        resourceArn:
          type: string
          description: The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
        replicationStrategy:
          type: string
          description: This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.
        replicationRegions:
          type: array
          items:
            type: string
          description: If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
      required:
      - keyspaceName
      - resourceArn
      - replicationStrategy
    GetKeyspaceRequest:
      type: object
      properties:
        keyspaceName:
          type: string
          description: The name of the keyspace.
      required:
      - keyspaceName
    ListKeyspacesRequest:
      type: object
      properties:
        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 keyspaces to return in the output. If the total number of keyspaces 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.
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
x-refined-from:
- amazon-keyspaces-openapi.yml
- amazon-keyspaces-keyspaces-api-openapi.yml