Amazon FinSpace Tagging API

Tag FinSpace resources

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-schema/amazon-finspace-environment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-schema/amazon-finspace-kx-environment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-schema/amazon-finspace-kx-cluster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-schema/amazon-finspace-kx-database-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-schema/amazon-finspace-kx-user-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-structure/amazon-finspace-environment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-structure/amazon-finspace-kx-environment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-structure/amazon-finspace-kx-cluster-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-structure/amazon-finspace-kx-database-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-finspace/refs/heads/main/json-structure/amazon-finspace-kx-user-structure.json

Other Resources

OpenAPI Specification

amazon-finspace-tagging-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon FinSpace Environments Tagging 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: Tagging
  description: Tag FinSpace resources
paths:
  /tags/{resourceArn}:
    get:
      operationId: listTagsForResource
      summary: Amazon FinSpace List Tags for Resource
      description: A list of all tags for a resource.
      tags:
      - Tagging
      parameters:
      - name: resourceArn
        in: path
        required: true
        description: Resource ARN
        schema:
          type: string
      responses:
        '200':
          description: Tags returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTagsResponse'
              examples:
                listTagsForResource200Example:
                  summary: Default
                  x-microcks-default: true
                  value:
                    tags:
                      Environment: production
        '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
    post:
      operationId: tagResource
      summary: Amazon FinSpace Tag a Resource
      description: Adds metadata tags to a FinSpace resource.
      tags:
      - Tagging
      parameters:
      - name: resourceArn
        in: path
        required: true
        description: Resource ARN
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagResourceRequest'
            examples:
              TagResourceReq:
                summary: Default
                x-microcks-default: true
                value:
                  tags:
                    Environment: production
      responses:
        '200':
          description: Tags applied
          content:
            application/json:
              schema:
                type: object
              examples:
                tagResource200Example:
                  summary: Default
                  x-microcks-default: true
                  value: {}
        '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
components:
  schemas:
    TagResourceRequest:
      type: object
      required:
      - tags
      description: Request to tag a resource
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
    ListTagsResponse:
      type: object
      description: Response from ListTagsForResource
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
    ErrorResponse:
      type: object
      description: Error response from Amazon FinSpace
      properties:
        message:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
  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