Skip to content

Finspace module#

Index > Finspace

Auto-generated documentation for Finspace type annotations stubs module mypy-boto3-finspace.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Finspace service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Finspace.

From PyPI with pip#

Install boto3-stubs for Finspace service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[finspace]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[finspace]'

# standalone installation
python -m pip install mypy-boto3-finspace

How to uninstall#

python -m pip uninstall -y mypy-boto3-finspace

Usage#

Code samples can be found in Examples.

FinspaceClient#

Type annotations and code completion for boto3.client("finspace") as FinspaceClient boto3 documentation

# FinspaceClient usage example

from boto3.session import Session

from mypy_boto3_finspace.client import FinspaceClient

def get_client() -> FinspaceClient:
    return Session().client("finspace")

Paginators#

Type annotations and code completion for paginators from boto3.client("finspace").get_paginator("...").

# ListKxEnvironmentsPaginator usage example

from boto3.session import Session

from mypy_boto3_finspace.paginator import ListKxEnvironmentsPaginator

def get_list_kx_environments_paginator() -> ListKxEnvironmentsPaginator:
    return Session().client("finspace").get_paginator("list_kx_environments"))

Literals#

Type annotations for literals used in methods and schema.

# AutoScalingMetricType usage example

from mypy_boto3_finspace.literals import AutoScalingMetricType

def get_value() -> AutoScalingMetricType:
    return "CPU_UTILIZATION_PERCENTAGE"