Finspace module#
Index > Finspace
Auto-generated documentation for Finspace type annotations stubs module types-boto3-finspace.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
Finspace
service. - 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 types-boto3
for Finspace
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[finspace]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[finspace]'
# standalone installation
python -m pip install types-boto3-finspace
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 types_boto3_finspace.literals import AutoScalingMetricType
def get_value() -> AutoScalingMetricType:
return "CPU_UTILIZATION_PERCENTAGE"
- AutoScalingMetricType
- ChangeTypeType
- ChangesetStatusType
- DnsStatusType
- EnvironmentStatusType
- ErrorDetailsType
- FederationModeType
- IPAddressTypeType
- KxAzModeType
- KxClusterCodeDeploymentStrategyType
- KxClusterStatusType
- KxClusterTypeType
- KxDataviewStatusType
- KxDeploymentStrategyType
- KxNAS1TypeType
- KxNodeStatusType
- KxSavedownStorageTypeType
- KxScalingGroupStatusType
- KxVolumeStatusType
- KxVolumeTypeType
- ListKxEnvironmentsPaginatorName
- RuleActionType
- TgwStatusType
- VolumeTypeType
- FinspaceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AutoScalingConfigurationTypeDef
- CapacityConfigurationTypeDef
- ChangeRequestTypeDef
- CodeConfigurationTypeDef
- FederationParametersTypeDef
- SuperuserParametersTypeDef
- ResponseMetadataTypeDef
- ErrorInfoTypeDef
- KxCacheStorageConfigurationTypeDef
- KxCommandLineArgumentTypeDef
- KxSavedownStorageConfigurationTypeDef
- KxScalingGroupConfigurationTypeDef
- TickerplantLogConfigurationTypeDef
- VpcConfigurationTypeDef
- TickerplantLogConfigurationOutputTypeDef
- VolumeTypeDef
- VpcConfigurationOutputTypeDef
- CreateKxDatabaseRequestRequestTypeDef
- KxDataviewSegmentConfigurationOutputTypeDef
- CreateKxEnvironmentRequestRequestTypeDef
- CreateKxScalingGroupRequestRequestTypeDef
- CreateKxUserRequestRequestTypeDef
- KxNAS1ConfigurationTypeDef
- CustomDNSServerTypeDef
- DeleteEnvironmentRequestRequestTypeDef
- DeleteKxClusterNodeRequestRequestTypeDef
- DeleteKxClusterRequestRequestTypeDef
- DeleteKxDatabaseRequestRequestTypeDef
- DeleteKxDataviewRequestRequestTypeDef
- DeleteKxEnvironmentRequestRequestTypeDef
- DeleteKxScalingGroupRequestRequestTypeDef
- DeleteKxUserRequestRequestTypeDef
- DeleteKxVolumeRequestRequestTypeDef
- FederationParametersOutputTypeDef
- GetEnvironmentRequestRequestTypeDef
- GetKxChangesetRequestRequestTypeDef
- GetKxClusterRequestRequestTypeDef
- GetKxConnectionStringRequestRequestTypeDef
- GetKxDatabaseRequestRequestTypeDef
- GetKxDataviewRequestRequestTypeDef
- GetKxEnvironmentRequestRequestTypeDef
- GetKxScalingGroupRequestRequestTypeDef
- GetKxUserRequestRequestTypeDef
- GetKxVolumeRequestRequestTypeDef
- KxAttachedClusterTypeDef
- IcmpTypeCodeTypeDef
- KxChangesetListEntryTypeDef
- KxClusterCodeDeploymentConfigurationTypeDef
- KxDatabaseCacheConfigurationOutputTypeDef
- KxDatabaseCacheConfigurationTypeDef
- KxDatabaseListEntryTypeDef
- KxDataviewSegmentConfigurationTypeDef
- KxDeploymentConfigurationTypeDef
- KxNodeTypeDef
- KxScalingGroupTypeDef
- KxUserTypeDef
- KxVolumeTypeDef
- ListEnvironmentsRequestRequestTypeDef
- ListKxChangesetsRequestRequestTypeDef
- ListKxClusterNodesRequestRequestTypeDef
- ListKxClustersRequestRequestTypeDef
- ListKxDatabasesRequestRequestTypeDef
- ListKxDataviewsRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListKxEnvironmentsRequestRequestTypeDef
- ListKxScalingGroupsRequestRequestTypeDef
- ListKxUsersRequestRequestTypeDef
- ListKxVolumesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PortRangeTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateKxDatabaseRequestRequestTypeDef
- UpdateKxEnvironmentRequestRequestTypeDef
- UpdateKxUserRequestRequestTypeDef
- CreateKxChangesetRequestRequestTypeDef
- UpdateEnvironmentRequestRequestTypeDef
- CreateEnvironmentRequestRequestTypeDef
- CreateEnvironmentResponseTypeDef
- CreateKxDatabaseResponseTypeDef
- CreateKxEnvironmentResponseTypeDef
- CreateKxScalingGroupResponseTypeDef
- CreateKxUserResponseTypeDef
- GetKxConnectionStringResponseTypeDef
- GetKxDatabaseResponseTypeDef
- GetKxScalingGroupResponseTypeDef
- GetKxUserResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateKxDatabaseResponseTypeDef
- UpdateKxUserResponseTypeDef
- CreateKxChangesetResponseTypeDef
- GetKxChangesetResponseTypeDef
- KxClusterTypeDef
- CreateKxDataviewResponseTypeDef
- KxDataviewActiveVersionTypeDef
- KxDataviewConfigurationOutputTypeDef
- CreateKxVolumeRequestRequestTypeDef
- CreateKxVolumeResponseTypeDef
- UpdateKxVolumeRequestRequestTypeDef
- EnvironmentTypeDef
- GetKxVolumeResponseTypeDef
- UpdateKxVolumeResponseTypeDef
- ListKxChangesetsResponseTypeDef
- UpdateKxClusterCodeConfigurationRequestRequestTypeDef
- KxDatabaseCacheConfigurationUnionTypeDef
- ListKxDatabasesResponseTypeDef
- KxDataviewSegmentConfigurationUnionTypeDef
- UpdateKxDataviewRequestRequestTypeDef
- ListKxClusterNodesResponseTypeDef
- ListKxScalingGroupsResponseTypeDef
- ListKxUsersResponseTypeDef
- ListKxVolumesResponseTypeDef
- ListKxEnvironmentsRequestPaginateTypeDef
- NetworkACLEntryTypeDef
- ListKxClustersResponseTypeDef
- GetKxDataviewResponseTypeDef
- KxDataviewListEntryTypeDef
- UpdateKxDataviewResponseTypeDef
- KxDatabaseConfigurationOutputTypeDef
- GetEnvironmentResponseTypeDef
- ListEnvironmentsResponseTypeDef
- UpdateEnvironmentResponseTypeDef
- CreateKxDataviewRequestRequestTypeDef
- KxDataviewConfigurationTypeDef
- TransitGatewayConfigurationOutputTypeDef
- TransitGatewayConfigurationTypeDef
- ListKxDataviewsResponseTypeDef
- CreateKxClusterResponseTypeDef
- GetKxClusterResponseTypeDef
- KxDataviewConfigurationUnionTypeDef
- GetKxEnvironmentResponseTypeDef
- KxEnvironmentTypeDef
- UpdateKxEnvironmentNetworkResponseTypeDef
- UpdateKxEnvironmentResponseTypeDef
- UpdateKxEnvironmentNetworkRequestRequestTypeDef
- KxDatabaseConfigurationTypeDef
- ListKxEnvironmentsResponseTypeDef
- KxDatabaseConfigurationUnionTypeDef
- UpdateKxClusterDatabasesRequestRequestTypeDef
- CreateKxClusterRequestRequestTypeDef