Amazon FinSpace Kdb Environments API

openapi: 3.1.0
info:
  title: Amazon FinSpace Environments Kdb Environments API
  description: 'Amazon FinSpace is a data management and analytics service for the financial services industry. NOTE: AWS announced end of support effective October 7, 2026. This API provides access to FinSpace environments, datasets, and Managed kdb Insights analytics environments.'
  version: '2021-03-12'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
  x-deprecated: 'End of support: October 7, 2026'
servers:
- url: https://finspace.{region}.amazonaws.com
  description: Amazon FinSpace Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
security:
- aws_signature_v4: []
tags:
- name: Kdb Environments
  description: Manage Managed kdb Insights environments
paths:
  /kdb/environments:
    post:
      operationId: createKxEnvironment
      summary: Amazon FinSpace Create kdb Environment
      description: Creates a managed kdb environment for the account.
      tags:
      - Kdb Environments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKxEnvironmentRequest'
            examples:
              CreateKxEnvReq:
                summary: Default
                x-microcks-default: true
                value:
                  name: my-kdb-env
                  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/abc123
      responses:
        '200':
          description: kdb environment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KxEnvironment'
              examples:
                createKxEnvironment200Example:
                  summary: Default
                  x-microcks-default: true
                  value:
                    environmentId: kdbenv-abc123
                    name: my-kdb-env
                    status: CREATED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listKxEnvironments
      summary: Amazon FinSpace List kdb Environments
      description: Returns a list of kdb environments created in an account.
      tags:
      - Kdb Environments
      parameters:
      - name: nextToken
        in: query
        description: Pagination token
        schema:
          type: string
      - name: maxResults
        in: query
        description: Max results
        schema:
          type: integer
      responses:
        '200':
          description: List returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListKxEnvironmentsResponse'
              examples:
                listKxEnvironments200Example:
                  summary: Default
                  x-microcks-default: true
                  value:
                    environments:
                    - environmentId: kdbenv-abc123
                      name: my-kdb-env
                      status: CREATED
                    nextToken: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /kdb/environments/{environmentId}:
    get:
      operationId: getKxEnvironment
      summary: Amazon FinSpace Get kdb Environment
      description: Retrieves all the relevant information about the specified kdb environment.
      tags:
      - Kdb Environments
      parameters:
      - name: environmentId
        in: path
        required: true
        description: kdb environment ID
        schema:
          type: string
      responses:
        '200':
          description: kdb environment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KxEnvironment'
              examples:
                getKxEnvironment200Example:
                  summary: Default
                  x-microcks-default: true
                  value:
                    environmentId: kdbenv-abc123
                    name: my-kdb-env
                    status: CREATED
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateKxEnvironment
      summary: Amazon FinSpace Update kdb Environment
      description: Updates information for the given kdb environment.
      tags:
      - Kdb Environments
      parameters:
      - name: environmentId
        in: path
        required: true
        description: Environment ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              UpdateKxEnvReq:
                summary: Default
                x-microcks-default: true
                value:
                  name: updated-kdb-env
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KxEnvironment'
              examples:
                updateKxEnvironment200Example:
                  summary: Default
                  x-microcks-default: true
                  value:
                    environmentId: kdbenv-abc123
                    name: my-kdb-env
                    status: CREATED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteKxEnvironment
      summary: Amazon FinSpace Delete kdb Environment
      description: Deletes the kdb environment. This action is irreversible.
      tags:
      - Kdb Environments
      parameters:
      - name: environmentId
        in: path
        required: true
        description: Environment ID
        schema:
          type: string
      responses:
        '200':
          description: Deleted
          content:
            application/json:
              schema:
                type: object
              examples:
                deleteKxEnvironment200Example:
                  summary: Default
                  x-microcks-default: true
                  value: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      description: Error response from Amazon FinSpace
      properties:
        message:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
    ListKxEnvironmentsResponse:
      type: object
      description: Response from ListKxEnvironments
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/KxEnvironment'
        nextToken:
          type: string
          description: Pagination token
    KxEnvironment:
      type: object
      description: A managed kdb Insights environment
      properties:
        environmentId:
          type: string
          description: Environment ID
          example: kdbenv-abc123
        name:
          type: string
          description: Name
          example: my-kdb-env
        status:
          type: string
          description: Status
          example: CREATED
          enum:
          - CREATE_REQUESTED
          - CREATING
          - CREATED
          - DELETE_REQUESTED
          - DELETING
          - DELETED
          - FAILED_CREATION
          - SUSPENDED
        description:
          type: string
          description: Description
        kmsKeyId:
          type: string
          description: KMS key ID
        createdTimestamp:
          type: string
          format: date-time
          description: Creation timestamp
        lastModifiedTimestamp:
          type: string
          format: date-time
          description: Last modified
    CreateKxEnvironmentRequest:
      type: object
      required:
      - name
      - kmsKeyId
      description: Request to create a kdb environment
      properties:
        name:
          type: string
          description: Name
        description:
          type: string
          description: Description
        kmsKeyId:
          type: string
          description: KMS key ID
        tags:
          type: object
          additionalProperties:
            type: string
        clientToken:
          type: string
          description: Idempotency token
  securitySchemes:
    aws_signature_v4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4
externalDocs:
  description: Amazon FinSpace API Reference
  url: https://docs.aws.amazon.com/finspace/latest/management-api/fs-api-welcome.html