Type definitions#
Auto-generated documentation for Finspace type annotations stubs module mypy-boto3-finspace.
FederationParametersUnionTypeDef#
# FederationParametersUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import FederationParametersUnionTypeDef
def get_value() -> FederationParametersUnionTypeDef:
return ...
# FederationParametersUnionTypeDef definition
FederationParametersUnionTypeDef = Union[
FederationParametersTypeDef, # (1)
FederationParametersOutputTypeDef, # (2)
]KxDatabaseCacheConfigurationUnionTypeDef#
# KxDatabaseCacheConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import KxDatabaseCacheConfigurationUnionTypeDef
def get_value() -> KxDatabaseCacheConfigurationUnionTypeDef:
return ...
# KxDatabaseCacheConfigurationUnionTypeDef definition
KxDatabaseCacheConfigurationUnionTypeDef = Union[
KxDatabaseCacheConfigurationTypeDef, # (1)
KxDatabaseCacheConfigurationOutputTypeDef, # (2)
]KxDataviewSegmentConfigurationUnionTypeDef#
# KxDataviewSegmentConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import KxDataviewSegmentConfigurationUnionTypeDef
def get_value() -> KxDataviewSegmentConfigurationUnionTypeDef:
return ...
# KxDataviewSegmentConfigurationUnionTypeDef definition
KxDataviewSegmentConfigurationUnionTypeDef = Union[
KxDataviewSegmentConfigurationTypeDef, # (1)
KxDataviewSegmentConfigurationOutputTypeDef, # (2)
]TickerplantLogConfigurationUnionTypeDef#
# TickerplantLogConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import TickerplantLogConfigurationUnionTypeDef
def get_value() -> TickerplantLogConfigurationUnionTypeDef:
return ...
# TickerplantLogConfigurationUnionTypeDef definition
TickerplantLogConfigurationUnionTypeDef = Union[
TickerplantLogConfigurationTypeDef, # (1)
TickerplantLogConfigurationOutputTypeDef, # (2)
]VpcConfigurationUnionTypeDef#
# VpcConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import VpcConfigurationUnionTypeDef
def get_value() -> VpcConfigurationUnionTypeDef:
return ...
# VpcConfigurationUnionTypeDef definition
VpcConfigurationUnionTypeDef = Union[
VpcConfigurationTypeDef, # (1)
VpcConfigurationOutputTypeDef, # (2)
]KxDataviewConfigurationUnionTypeDef#
# KxDataviewConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import KxDataviewConfigurationUnionTypeDef
def get_value() -> KxDataviewConfigurationUnionTypeDef:
return ...
# KxDataviewConfigurationUnionTypeDef definition
KxDataviewConfigurationUnionTypeDef = Union[
KxDataviewConfigurationTypeDef, # (1)
KxDataviewConfigurationOutputTypeDef, # (2)
]TransitGatewayConfigurationUnionTypeDef#
# TransitGatewayConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import TransitGatewayConfigurationUnionTypeDef
def get_value() -> TransitGatewayConfigurationUnionTypeDef:
return ...
# TransitGatewayConfigurationUnionTypeDef definition
TransitGatewayConfigurationUnionTypeDef = Union[
TransitGatewayConfigurationTypeDef, # (1)
TransitGatewayConfigurationOutputTypeDef, # (2)
]KxDatabaseConfigurationUnionTypeDef#
# KxDatabaseConfigurationUnionTypeDef Union usage example
from mypy_boto3_finspace.type_defs import KxDatabaseConfigurationUnionTypeDef
def get_value() -> KxDatabaseConfigurationUnionTypeDef:
return ...
# KxDatabaseConfigurationUnionTypeDef definition
KxDatabaseConfigurationUnionTypeDef = Union[
KxDatabaseConfigurationTypeDef, # (1)
KxDatabaseConfigurationOutputTypeDef, # (2)
]AutoScalingConfigurationTypeDef#
# AutoScalingConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import AutoScalingConfigurationTypeDef
def get_value() -> AutoScalingConfigurationTypeDef:
return {
"minNodeCount": ...,
}
# AutoScalingConfigurationTypeDef definition
class AutoScalingConfigurationTypeDef(TypedDict):
minNodeCount: NotRequired[int],
maxNodeCount: NotRequired[int],
autoScalingMetric: NotRequired[AutoScalingMetricType], # (1)
metricTarget: NotRequired[float],
scaleInCooldownSeconds: NotRequired[float],
scaleOutCooldownSeconds: NotRequired[float],CapacityConfigurationTypeDef#
# CapacityConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CapacityConfigurationTypeDef
def get_value() -> CapacityConfigurationTypeDef:
return {
"nodeType": ...,
}
# CapacityConfigurationTypeDef definition
class CapacityConfigurationTypeDef(TypedDict):
nodeType: NotRequired[str],
nodeCount: NotRequired[int],ChangeRequestTypeDef#
# ChangeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ChangeRequestTypeDef
def get_value() -> ChangeRequestTypeDef:
return {
"changeType": ...,
}
# ChangeRequestTypeDef definition
class ChangeRequestTypeDef(TypedDict):
changeType: ChangeTypeType, # (1)
dbPath: str,
s3Path: NotRequired[str],- See ChangeTypeType
CodeConfigurationTypeDef#
# CodeConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CodeConfigurationTypeDef
def get_value() -> CodeConfigurationTypeDef:
return {
"s3Bucket": ...,
}
# CodeConfigurationTypeDef definition
class CodeConfigurationTypeDef(TypedDict):
s3Bucket: NotRequired[str],
s3Key: NotRequired[str],
s3ObjectVersion: NotRequired[str],SuperuserParametersTypeDef#
# SuperuserParametersTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import SuperuserParametersTypeDef
def get_value() -> SuperuserParametersTypeDef:
return {
"emailAddress": ...,
}
# SuperuserParametersTypeDef definition
class SuperuserParametersTypeDef(TypedDict):
emailAddress: str,
firstName: str,
lastName: str,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],ErrorInfoTypeDef#
# ErrorInfoTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"errorMessage": ...,
}
# ErrorInfoTypeDef definition
class ErrorInfoTypeDef(TypedDict):
errorMessage: NotRequired[str],
errorType: NotRequired[ErrorDetailsType], # (1)- See ErrorDetailsType
KxCacheStorageConfigurationTypeDef#
# KxCacheStorageConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxCacheStorageConfigurationTypeDef
def get_value() -> KxCacheStorageConfigurationTypeDef:
return {
"type": ...,
}
# KxCacheStorageConfigurationTypeDef definition
class KxCacheStorageConfigurationTypeDef(TypedDict):
type: str,
size: int,KxCommandLineArgumentTypeDef#
# KxCommandLineArgumentTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxCommandLineArgumentTypeDef
def get_value() -> KxCommandLineArgumentTypeDef:
return {
"key": ...,
}
# KxCommandLineArgumentTypeDef definition
class KxCommandLineArgumentTypeDef(TypedDict):
key: NotRequired[str],
value: NotRequired[str],KxSavedownStorageConfigurationTypeDef#
# KxSavedownStorageConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxSavedownStorageConfigurationTypeDef
def get_value() -> KxSavedownStorageConfigurationTypeDef:
return {
"type": ...,
}
# KxSavedownStorageConfigurationTypeDef definition
class KxSavedownStorageConfigurationTypeDef(TypedDict):
type: NotRequired[KxSavedownStorageTypeType], # (1)
size: NotRequired[int],
volumeName: NotRequired[str],KxScalingGroupConfigurationTypeDef#
# KxScalingGroupConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxScalingGroupConfigurationTypeDef
def get_value() -> KxScalingGroupConfigurationTypeDef:
return {
"scalingGroupName": ...,
}
# KxScalingGroupConfigurationTypeDef definition
class KxScalingGroupConfigurationTypeDef(TypedDict):
scalingGroupName: str,
memoryReservation: int,
nodeCount: int,
memoryLimit: NotRequired[int],
cpu: NotRequired[float],TickerplantLogConfigurationOutputTypeDef#
# TickerplantLogConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import TickerplantLogConfigurationOutputTypeDef
def get_value() -> TickerplantLogConfigurationOutputTypeDef:
return {
"tickerplantLogVolumes": ...,
}
# TickerplantLogConfigurationOutputTypeDef definition
class TickerplantLogConfigurationOutputTypeDef(TypedDict):
tickerplantLogVolumes: NotRequired[List[str]],VolumeTypeDef#
# VolumeTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import VolumeTypeDef
def get_value() -> VolumeTypeDef:
return {
"volumeName": ...,
}
# VolumeTypeDef definition
class VolumeTypeDef(TypedDict):
volumeName: NotRequired[str],
volumeType: NotRequired[VolumeTypeType], # (1)- See VolumeTypeType
VpcConfigurationOutputTypeDef#
# VpcConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import VpcConfigurationOutputTypeDef
def get_value() -> VpcConfigurationOutputTypeDef:
return {
"vpcId": ...,
}
# VpcConfigurationOutputTypeDef definition
class VpcConfigurationOutputTypeDef(TypedDict):
vpcId: NotRequired[str],
securityGroupIds: NotRequired[List[str]],
subnetIds: NotRequired[List[str]],
ipAddressType: NotRequired[IPAddressTypeType], # (1)CreateKxDatabaseRequestTypeDef#
# CreateKxDatabaseRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxDatabaseRequestTypeDef
def get_value() -> CreateKxDatabaseRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxDatabaseRequestTypeDef definition
class CreateKxDatabaseRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
clientToken: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],KxDataviewSegmentConfigurationOutputTypeDef#
# KxDataviewSegmentConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewSegmentConfigurationOutputTypeDef
def get_value() -> KxDataviewSegmentConfigurationOutputTypeDef:
return {
"dbPaths": ...,
}
# KxDataviewSegmentConfigurationOutputTypeDef definition
class KxDataviewSegmentConfigurationOutputTypeDef(TypedDict):
dbPaths: List[str],
volumeName: str,
onDemand: NotRequired[bool],CreateKxEnvironmentRequestTypeDef#
# CreateKxEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxEnvironmentRequestTypeDef
def get_value() -> CreateKxEnvironmentRequestTypeDef:
return {
"name": ...,
}
# CreateKxEnvironmentRequestTypeDef definition
class CreateKxEnvironmentRequestTypeDef(TypedDict):
name: str,
kmsKeyId: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],CreateKxScalingGroupRequestTypeDef#
# CreateKxScalingGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxScalingGroupRequestTypeDef
def get_value() -> CreateKxScalingGroupRequestTypeDef:
return {
"clientToken": ...,
}
# CreateKxScalingGroupRequestTypeDef definition
class CreateKxScalingGroupRequestTypeDef(TypedDict):
clientToken: str,
environmentId: str,
scalingGroupName: str,
hostType: str,
availabilityZoneId: str,
tags: NotRequired[Mapping[str, str]],CreateKxUserRequestTypeDef#
# CreateKxUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxUserRequestTypeDef
def get_value() -> CreateKxUserRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxUserRequestTypeDef definition
class CreateKxUserRequestTypeDef(TypedDict):
environmentId: str,
userName: str,
iamRole: str,
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],KxNAS1ConfigurationTypeDef#
# KxNAS1ConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxNAS1ConfigurationTypeDef
def get_value() -> KxNAS1ConfigurationTypeDef:
return {
"type": ...,
}
# KxNAS1ConfigurationTypeDef definition
class KxNAS1ConfigurationTypeDef(TypedDict):
type: NotRequired[KxNAS1TypeType], # (1)
size: NotRequired[int],- See KxNAS1TypeType
CustomDNSServerTypeDef#
# CustomDNSServerTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CustomDNSServerTypeDef
def get_value() -> CustomDNSServerTypeDef:
return {
"customDNSServerName": ...,
}
# CustomDNSServerTypeDef definition
class CustomDNSServerTypeDef(TypedDict):
customDNSServerName: str,
customDNSServerIP: str,DeleteEnvironmentRequestTypeDef#
# DeleteEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteEnvironmentRequestTypeDef
def get_value() -> DeleteEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteEnvironmentRequestTypeDef definition
class DeleteEnvironmentRequestTypeDef(TypedDict):
environmentId: str,DeleteKxClusterNodeRequestTypeDef#
# DeleteKxClusterNodeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxClusterNodeRequestTypeDef
def get_value() -> DeleteKxClusterNodeRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxClusterNodeRequestTypeDef definition
class DeleteKxClusterNodeRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
nodeId: str,DeleteKxClusterRequestTypeDef#
# DeleteKxClusterRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxClusterRequestTypeDef
def get_value() -> DeleteKxClusterRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxClusterRequestTypeDef definition
class DeleteKxClusterRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
clientToken: NotRequired[str],DeleteKxDatabaseRequestTypeDef#
# DeleteKxDatabaseRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxDatabaseRequestTypeDef
def get_value() -> DeleteKxDatabaseRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxDatabaseRequestTypeDef definition
class DeleteKxDatabaseRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
clientToken: str,DeleteKxDataviewRequestTypeDef#
# DeleteKxDataviewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxDataviewRequestTypeDef
def get_value() -> DeleteKxDataviewRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxDataviewRequestTypeDef definition
class DeleteKxDataviewRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
dataviewName: str,
clientToken: str,DeleteKxEnvironmentRequestTypeDef#
# DeleteKxEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxEnvironmentRequestTypeDef
def get_value() -> DeleteKxEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxEnvironmentRequestTypeDef definition
class DeleteKxEnvironmentRequestTypeDef(TypedDict):
environmentId: str,
clientToken: NotRequired[str],DeleteKxScalingGroupRequestTypeDef#
# DeleteKxScalingGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxScalingGroupRequestTypeDef
def get_value() -> DeleteKxScalingGroupRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxScalingGroupRequestTypeDef definition
class DeleteKxScalingGroupRequestTypeDef(TypedDict):
environmentId: str,
scalingGroupName: str,
clientToken: NotRequired[str],DeleteKxUserRequestTypeDef#
# DeleteKxUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxUserRequestTypeDef
def get_value() -> DeleteKxUserRequestTypeDef:
return {
"userName": ...,
}
# DeleteKxUserRequestTypeDef definition
class DeleteKxUserRequestTypeDef(TypedDict):
userName: str,
environmentId: str,
clientToken: NotRequired[str],DeleteKxVolumeRequestTypeDef#
# DeleteKxVolumeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import DeleteKxVolumeRequestTypeDef
def get_value() -> DeleteKxVolumeRequestTypeDef:
return {
"environmentId": ...,
}
# DeleteKxVolumeRequestTypeDef definition
class DeleteKxVolumeRequestTypeDef(TypedDict):
environmentId: str,
volumeName: str,
clientToken: NotRequired[str],FederationParametersOutputTypeDef#
# FederationParametersOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import FederationParametersOutputTypeDef
def get_value() -> FederationParametersOutputTypeDef:
return {
"samlMetadataDocument": ...,
}
# FederationParametersOutputTypeDef definition
class FederationParametersOutputTypeDef(TypedDict):
samlMetadataDocument: NotRequired[str],
samlMetadataURL: NotRequired[str],
applicationCallBackURL: NotRequired[str],
federationURN: NotRequired[str],
federationProviderName: NotRequired[str],
attributeMap: NotRequired[Dict[str, str]],FederationParametersTypeDef#
# FederationParametersTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import FederationParametersTypeDef
def get_value() -> FederationParametersTypeDef:
return {
"samlMetadataDocument": ...,
}
# FederationParametersTypeDef definition
class FederationParametersTypeDef(TypedDict):
samlMetadataDocument: NotRequired[str],
samlMetadataURL: NotRequired[str],
applicationCallBackURL: NotRequired[str],
federationURN: NotRequired[str],
federationProviderName: NotRequired[str],
attributeMap: NotRequired[Mapping[str, str]],GetEnvironmentRequestTypeDef#
# GetEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetEnvironmentRequestTypeDef
def get_value() -> GetEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# GetEnvironmentRequestTypeDef definition
class GetEnvironmentRequestTypeDef(TypedDict):
environmentId: str,GetKxChangesetRequestTypeDef#
# GetKxChangesetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxChangesetRequestTypeDef
def get_value() -> GetKxChangesetRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxChangesetRequestTypeDef definition
class GetKxChangesetRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
changesetId: str,GetKxClusterRequestTypeDef#
# GetKxClusterRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxClusterRequestTypeDef
def get_value() -> GetKxClusterRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxClusterRequestTypeDef definition
class GetKxClusterRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,GetKxConnectionStringRequestTypeDef#
# GetKxConnectionStringRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxConnectionStringRequestTypeDef
def get_value() -> GetKxConnectionStringRequestTypeDef:
return {
"userArn": ...,
}
# GetKxConnectionStringRequestTypeDef definition
class GetKxConnectionStringRequestTypeDef(TypedDict):
userArn: str,
environmentId: str,
clusterName: str,GetKxDatabaseRequestTypeDef#
# GetKxDatabaseRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxDatabaseRequestTypeDef
def get_value() -> GetKxDatabaseRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxDatabaseRequestTypeDef definition
class GetKxDatabaseRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,GetKxDataviewRequestTypeDef#
# GetKxDataviewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxDataviewRequestTypeDef
def get_value() -> GetKxDataviewRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxDataviewRequestTypeDef definition
class GetKxDataviewRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
dataviewName: str,GetKxEnvironmentRequestTypeDef#
# GetKxEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxEnvironmentRequestTypeDef
def get_value() -> GetKxEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxEnvironmentRequestTypeDef definition
class GetKxEnvironmentRequestTypeDef(TypedDict):
environmentId: str,GetKxScalingGroupRequestTypeDef#
# GetKxScalingGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxScalingGroupRequestTypeDef
def get_value() -> GetKxScalingGroupRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxScalingGroupRequestTypeDef definition
class GetKxScalingGroupRequestTypeDef(TypedDict):
environmentId: str,
scalingGroupName: str,GetKxUserRequestTypeDef#
# GetKxUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxUserRequestTypeDef
def get_value() -> GetKxUserRequestTypeDef:
return {
"userName": ...,
}
# GetKxUserRequestTypeDef definition
class GetKxUserRequestTypeDef(TypedDict):
userName: str,
environmentId: str,GetKxVolumeRequestTypeDef#
# GetKxVolumeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxVolumeRequestTypeDef
def get_value() -> GetKxVolumeRequestTypeDef:
return {
"environmentId": ...,
}
# GetKxVolumeRequestTypeDef definition
class GetKxVolumeRequestTypeDef(TypedDict):
environmentId: str,
volumeName: str,KxAttachedClusterTypeDef#
# KxAttachedClusterTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxAttachedClusterTypeDef
def get_value() -> KxAttachedClusterTypeDef:
return {
"clusterName": ...,
}
# KxAttachedClusterTypeDef definition
class KxAttachedClusterTypeDef(TypedDict):
clusterName: NotRequired[str],
clusterType: NotRequired[KxClusterTypeType], # (1)
clusterStatus: NotRequired[KxClusterStatusType], # (2)- See KxClusterTypeType
- See KxClusterStatusType
IcmpTypeCodeTypeDef#
# IcmpTypeCodeTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import IcmpTypeCodeTypeDef
def get_value() -> IcmpTypeCodeTypeDef:
return {
"type": ...,
}
# IcmpTypeCodeTypeDef definition
class IcmpTypeCodeTypeDef(TypedDict):
type: int,
code: int,KxChangesetListEntryTypeDef#
# KxChangesetListEntryTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxChangesetListEntryTypeDef
def get_value() -> KxChangesetListEntryTypeDef:
return {
"changesetId": ...,
}
# KxChangesetListEntryTypeDef definition
class KxChangesetListEntryTypeDef(TypedDict):
changesetId: NotRequired[str],
createdTimestamp: NotRequired[datetime.datetime],
activeFromTimestamp: NotRequired[datetime.datetime],
lastModifiedTimestamp: NotRequired[datetime.datetime],
status: NotRequired[ChangesetStatusType], # (1)KxClusterCodeDeploymentConfigurationTypeDef#
# KxClusterCodeDeploymentConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxClusterCodeDeploymentConfigurationTypeDef
def get_value() -> KxClusterCodeDeploymentConfigurationTypeDef:
return {
"deploymentStrategy": ...,
}
# KxClusterCodeDeploymentConfigurationTypeDef definition
class KxClusterCodeDeploymentConfigurationTypeDef(TypedDict):
deploymentStrategy: KxClusterCodeDeploymentStrategyType, # (1)KxDatabaseCacheConfigurationOutputTypeDef#
# KxDatabaseCacheConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDatabaseCacheConfigurationOutputTypeDef
def get_value() -> KxDatabaseCacheConfigurationOutputTypeDef:
return {
"cacheType": ...,
}
# KxDatabaseCacheConfigurationOutputTypeDef definition
class KxDatabaseCacheConfigurationOutputTypeDef(TypedDict):
cacheType: str,
dbPaths: List[str],
dataviewName: NotRequired[str],KxDatabaseCacheConfigurationTypeDef#
# KxDatabaseCacheConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDatabaseCacheConfigurationTypeDef
def get_value() -> KxDatabaseCacheConfigurationTypeDef:
return {
"cacheType": ...,
}
# KxDatabaseCacheConfigurationTypeDef definition
class KxDatabaseCacheConfigurationTypeDef(TypedDict):
cacheType: str,
dbPaths: Sequence[str],
dataviewName: NotRequired[str],KxDatabaseListEntryTypeDef#
# KxDatabaseListEntryTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDatabaseListEntryTypeDef
def get_value() -> KxDatabaseListEntryTypeDef:
return {
"databaseName": ...,
}
# KxDatabaseListEntryTypeDef definition
class KxDatabaseListEntryTypeDef(TypedDict):
databaseName: NotRequired[str],
createdTimestamp: NotRequired[datetime.datetime],
lastModifiedTimestamp: NotRequired[datetime.datetime],KxDataviewSegmentConfigurationTypeDef#
# KxDataviewSegmentConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewSegmentConfigurationTypeDef
def get_value() -> KxDataviewSegmentConfigurationTypeDef:
return {
"dbPaths": ...,
}
# KxDataviewSegmentConfigurationTypeDef definition
class KxDataviewSegmentConfigurationTypeDef(TypedDict):
dbPaths: Sequence[str],
volumeName: str,
onDemand: NotRequired[bool],KxDeploymentConfigurationTypeDef#
# KxDeploymentConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDeploymentConfigurationTypeDef
def get_value() -> KxDeploymentConfigurationTypeDef:
return {
"deploymentStrategy": ...,
}
# KxDeploymentConfigurationTypeDef definition
class KxDeploymentConfigurationTypeDef(TypedDict):
deploymentStrategy: KxDeploymentStrategyType, # (1)KxNodeTypeDef#
# KxNodeTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxNodeTypeDef
def get_value() -> KxNodeTypeDef:
return {
"nodeId": ...,
}
# KxNodeTypeDef definition
class KxNodeTypeDef(TypedDict):
nodeId: NotRequired[str],
availabilityZoneId: NotRequired[str],
launchTime: NotRequired[datetime.datetime],
status: NotRequired[KxNodeStatusType], # (1)- See KxNodeStatusType
KxScalingGroupTypeDef#
# KxScalingGroupTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxScalingGroupTypeDef
def get_value() -> KxScalingGroupTypeDef:
return {
"scalingGroupName": ...,
}
# KxScalingGroupTypeDef definition
class KxScalingGroupTypeDef(TypedDict):
scalingGroupName: NotRequired[str],
hostType: NotRequired[str],
clusters: NotRequired[List[str]],
availabilityZoneId: NotRequired[str],
status: NotRequired[KxScalingGroupStatusType], # (1)
statusReason: NotRequired[str],
lastModifiedTimestamp: NotRequired[datetime.datetime],
createdTimestamp: NotRequired[datetime.datetime],KxUserTypeDef#
# KxUserTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxUserTypeDef
def get_value() -> KxUserTypeDef:
return {
"userArn": ...,
}
# KxUserTypeDef definition
class KxUserTypeDef(TypedDict):
userArn: NotRequired[str],
userName: NotRequired[str],
iamRole: NotRequired[str],
createTimestamp: NotRequired[datetime.datetime],
updateTimestamp: NotRequired[datetime.datetime],KxVolumeTypeDef#
# KxVolumeTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxVolumeTypeDef
def get_value() -> KxVolumeTypeDef:
return {
"volumeName": ...,
}
# KxVolumeTypeDef definition
class KxVolumeTypeDef(TypedDict):
volumeName: NotRequired[str],
volumeType: NotRequired[KxVolumeTypeType], # (1)
status: NotRequired[KxVolumeStatusType], # (2)
description: NotRequired[str],
statusReason: NotRequired[str],
azMode: NotRequired[KxAzModeType], # (3)
availabilityZoneIds: NotRequired[List[str]],
createdTimestamp: NotRequired[datetime.datetime],
lastModifiedTimestamp: NotRequired[datetime.datetime],- See KxVolumeTypeType
- See KxVolumeStatusType
- See KxAzModeType
ListEnvironmentsRequestTypeDef#
# ListEnvironmentsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListEnvironmentsRequestTypeDef
def get_value() -> ListEnvironmentsRequestTypeDef:
return {
"nextToken": ...,
}
# ListEnvironmentsRequestTypeDef definition
class ListEnvironmentsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxChangesetsRequestTypeDef#
# ListKxChangesetsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxChangesetsRequestTypeDef
def get_value() -> ListKxChangesetsRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxChangesetsRequestTypeDef definition
class ListKxChangesetsRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxClusterNodesRequestTypeDef#
# ListKxClusterNodesRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxClusterNodesRequestTypeDef
def get_value() -> ListKxClusterNodesRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxClusterNodesRequestTypeDef definition
class ListKxClusterNodesRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxClustersRequestTypeDef#
# ListKxClustersRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxClustersRequestTypeDef
def get_value() -> ListKxClustersRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxClustersRequestTypeDef definition
class ListKxClustersRequestTypeDef(TypedDict):
environmentId: str,
clusterType: NotRequired[KxClusterTypeType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListKxDatabasesRequestTypeDef#
# ListKxDatabasesRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxDatabasesRequestTypeDef
def get_value() -> ListKxDatabasesRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxDatabasesRequestTypeDef definition
class ListKxDatabasesRequestTypeDef(TypedDict):
environmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxDataviewsRequestTypeDef#
# ListKxDataviewsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxDataviewsRequestTypeDef
def get_value() -> ListKxDataviewsRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxDataviewsRequestTypeDef definition
class ListKxDataviewsRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ListKxEnvironmentsRequestTypeDef#
# ListKxEnvironmentsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxEnvironmentsRequestTypeDef
def get_value() -> ListKxEnvironmentsRequestTypeDef:
return {
"nextToken": ...,
}
# ListKxEnvironmentsRequestTypeDef definition
class ListKxEnvironmentsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxScalingGroupsRequestTypeDef#
# ListKxScalingGroupsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxScalingGroupsRequestTypeDef
def get_value() -> ListKxScalingGroupsRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxScalingGroupsRequestTypeDef definition
class ListKxScalingGroupsRequestTypeDef(TypedDict):
environmentId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListKxUsersRequestTypeDef#
# ListKxUsersRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxUsersRequestTypeDef
def get_value() -> ListKxUsersRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxUsersRequestTypeDef definition
class ListKxUsersRequestTypeDef(TypedDict):
environmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListKxVolumesRequestTypeDef#
# ListKxVolumesRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxVolumesRequestTypeDef
def get_value() -> ListKxVolumesRequestTypeDef:
return {
"environmentId": ...,
}
# ListKxVolumesRequestTypeDef definition
class ListKxVolumesRequestTypeDef(TypedDict):
environmentId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
volumeType: NotRequired[KxVolumeTypeType], # (1)- See KxVolumeTypeType
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,PortRangeTypeDef#
# PortRangeTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import PortRangeTypeDef
def get_value() -> PortRangeTypeDef:
return {
"from": ...,
}
# PortRangeTypeDef definition
class PortRangeTypeDef(TypedDict):
from: int,
to: int,TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],TickerplantLogConfigurationTypeDef#
# TickerplantLogConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import TickerplantLogConfigurationTypeDef
def get_value() -> TickerplantLogConfigurationTypeDef:
return {
"tickerplantLogVolumes": ...,
}
# TickerplantLogConfigurationTypeDef definition
class TickerplantLogConfigurationTypeDef(TypedDict):
tickerplantLogVolumes: NotRequired[Sequence[str]],UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],UpdateKxDatabaseRequestTypeDef#
# UpdateKxDatabaseRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxDatabaseRequestTypeDef
def get_value() -> UpdateKxDatabaseRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxDatabaseRequestTypeDef definition
class UpdateKxDatabaseRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
clientToken: str,
description: NotRequired[str],UpdateKxEnvironmentRequestTypeDef#
# UpdateKxEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentRequestTypeDef
def get_value() -> UpdateKxEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxEnvironmentRequestTypeDef definition
class UpdateKxEnvironmentRequestTypeDef(TypedDict):
environmentId: str,
name: NotRequired[str],
description: NotRequired[str],
clientToken: NotRequired[str],UpdateKxUserRequestTypeDef#
# UpdateKxUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxUserRequestTypeDef
def get_value() -> UpdateKxUserRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxUserRequestTypeDef definition
class UpdateKxUserRequestTypeDef(TypedDict):
environmentId: str,
userName: str,
iamRole: str,
clientToken: NotRequired[str],VpcConfigurationTypeDef#
# VpcConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import VpcConfigurationTypeDef
def get_value() -> VpcConfigurationTypeDef:
return {
"vpcId": ...,
}
# VpcConfigurationTypeDef definition
class VpcConfigurationTypeDef(TypedDict):
vpcId: NotRequired[str],
securityGroupIds: NotRequired[Sequence[str]],
subnetIds: NotRequired[Sequence[str]],
ipAddressType: NotRequired[IPAddressTypeType], # (1)CreateKxChangesetRequestTypeDef#
# CreateKxChangesetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxChangesetRequestTypeDef
def get_value() -> CreateKxChangesetRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxChangesetRequestTypeDef definition
class CreateKxChangesetRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
changeRequests: Sequence[ChangeRequestTypeDef], # (1)
clientToken: str,- See
Sequence[ChangeRequestTypeDef]
CreateEnvironmentResponseTypeDef#
# CreateEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateEnvironmentResponseTypeDef
def get_value() -> CreateEnvironmentResponseTypeDef:
return {
"environmentId": ...,
}
# CreateEnvironmentResponseTypeDef definition
class CreateEnvironmentResponseTypeDef(TypedDict):
environmentId: str,
environmentArn: str,
environmentUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateKxDatabaseResponseTypeDef#
# CreateKxDatabaseResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxDatabaseResponseTypeDef
def get_value() -> CreateKxDatabaseResponseTypeDef:
return {
"databaseName": ...,
}
# CreateKxDatabaseResponseTypeDef definition
class CreateKxDatabaseResponseTypeDef(TypedDict):
databaseName: str,
databaseArn: str,
environmentId: str,
description: str,
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateKxEnvironmentResponseTypeDef#
# CreateKxEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxEnvironmentResponseTypeDef
def get_value() -> CreateKxEnvironmentResponseTypeDef:
return {
"name": ...,
}
# CreateKxEnvironmentResponseTypeDef definition
class CreateKxEnvironmentResponseTypeDef(TypedDict):
name: str,
status: EnvironmentStatusType, # (1)
environmentId: str,
description: str,
environmentArn: str,
kmsKeyId: str,
creationTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateKxScalingGroupResponseTypeDef#
# CreateKxScalingGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxScalingGroupResponseTypeDef
def get_value() -> CreateKxScalingGroupResponseTypeDef:
return {
"environmentId": ...,
}
# CreateKxScalingGroupResponseTypeDef definition
class CreateKxScalingGroupResponseTypeDef(TypedDict):
environmentId: str,
scalingGroupName: str,
hostType: str,
availabilityZoneId: str,
status: KxScalingGroupStatusType, # (1)
lastModifiedTimestamp: datetime.datetime,
createdTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateKxUserResponseTypeDef#
# CreateKxUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxUserResponseTypeDef
def get_value() -> CreateKxUserResponseTypeDef:
return {
"userName": ...,
}
# CreateKxUserResponseTypeDef definition
class CreateKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetKxConnectionStringResponseTypeDef#
# GetKxConnectionStringResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxConnectionStringResponseTypeDef
def get_value() -> GetKxConnectionStringResponseTypeDef:
return {
"signedConnectionString": ...,
}
# GetKxConnectionStringResponseTypeDef definition
class GetKxConnectionStringResponseTypeDef(TypedDict):
signedConnectionString: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetKxDatabaseResponseTypeDef#
# GetKxDatabaseResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxDatabaseResponseTypeDef
def get_value() -> GetKxDatabaseResponseTypeDef:
return {
"databaseName": ...,
}
# GetKxDatabaseResponseTypeDef definition
class GetKxDatabaseResponseTypeDef(TypedDict):
databaseName: str,
databaseArn: str,
environmentId: str,
description: str,
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
lastCompletedChangesetId: str,
numBytes: int,
numChangesets: int,
numFiles: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetKxScalingGroupResponseTypeDef#
# GetKxScalingGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxScalingGroupResponseTypeDef
def get_value() -> GetKxScalingGroupResponseTypeDef:
return {
"scalingGroupName": ...,
}
# GetKxScalingGroupResponseTypeDef definition
class GetKxScalingGroupResponseTypeDef(TypedDict):
scalingGroupName: str,
scalingGroupArn: str,
hostType: str,
clusters: List[str],
availabilityZoneId: str,
status: KxScalingGroupStatusType, # (1)
statusReason: str,
lastModifiedTimestamp: datetime.datetime,
createdTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetKxUserResponseTypeDef#
# GetKxUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxUserResponseTypeDef
def get_value() -> GetKxUserResponseTypeDef:
return {
"userName": ...,
}
# GetKxUserResponseTypeDef definition
class GetKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateKxDatabaseResponseTypeDef#
# UpdateKxDatabaseResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxDatabaseResponseTypeDef
def get_value() -> UpdateKxDatabaseResponseTypeDef:
return {
"databaseName": ...,
}
# UpdateKxDatabaseResponseTypeDef definition
class UpdateKxDatabaseResponseTypeDef(TypedDict):
databaseName: str,
environmentId: str,
description: str,
lastModifiedTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateKxUserResponseTypeDef#
# UpdateKxUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxUserResponseTypeDef
def get_value() -> UpdateKxUserResponseTypeDef:
return {
"userName": ...,
}
# UpdateKxUserResponseTypeDef definition
class UpdateKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateKxChangesetResponseTypeDef#
# CreateKxChangesetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxChangesetResponseTypeDef
def get_value() -> CreateKxChangesetResponseTypeDef:
return {
"changesetId": ...,
}
# CreateKxChangesetResponseTypeDef definition
class CreateKxChangesetResponseTypeDef(TypedDict):
changesetId: str,
databaseName: str,
environmentId: str,
changeRequests: List[ChangeRequestTypeDef], # (1)
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
status: ChangesetStatusType, # (2)
errorInfo: ErrorInfoTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See
List[ChangeRequestTypeDef] - See ChangesetStatusType
- See ErrorInfoTypeDef
- See ResponseMetadataTypeDef
GetKxChangesetResponseTypeDef#
# GetKxChangesetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxChangesetResponseTypeDef
def get_value() -> GetKxChangesetResponseTypeDef:
return {
"changesetId": ...,
}
# GetKxChangesetResponseTypeDef definition
class GetKxChangesetResponseTypeDef(TypedDict):
changesetId: str,
databaseName: str,
environmentId: str,
changeRequests: List[ChangeRequestTypeDef], # (1)
createdTimestamp: datetime.datetime,
activeFromTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
status: ChangesetStatusType, # (2)
errorInfo: ErrorInfoTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See
List[ChangeRequestTypeDef] - See ChangesetStatusType
- See ErrorInfoTypeDef
- See ResponseMetadataTypeDef
KxClusterTypeDef#
# KxClusterTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxClusterTypeDef
def get_value() -> KxClusterTypeDef:
return {
"status": ...,
}
# KxClusterTypeDef definition
class KxClusterTypeDef(TypedDict):
status: NotRequired[KxClusterStatusType], # (1)
statusReason: NotRequired[str],
clusterName: NotRequired[str],
clusterType: NotRequired[KxClusterTypeType], # (2)
clusterDescription: NotRequired[str],
releaseLabel: NotRequired[str],
volumes: NotRequired[List[VolumeTypeDef]], # (3)
initializationScript: NotRequired[str],
executionRole: NotRequired[str],
azMode: NotRequired[KxAzModeType], # (4)
availabilityZoneId: NotRequired[str],
lastModifiedTimestamp: NotRequired[datetime.datetime],
createdTimestamp: NotRequired[datetime.datetime],- See KxClusterStatusType
- See KxClusterTypeType
- See
List[VolumeTypeDef] - See KxAzModeType
CreateKxDataviewResponseTypeDef#
# CreateKxDataviewResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxDataviewResponseTypeDef
def get_value() -> CreateKxDataviewResponseTypeDef:
return {
"dataviewName": ...,
}
# CreateKxDataviewResponseTypeDef definition
class CreateKxDataviewResponseTypeDef(TypedDict):
dataviewName: str,
databaseName: str,
environmentId: str,
azMode: KxAzModeType, # (1)
availabilityZoneId: str,
changesetId: str,
segmentConfigurations: List[KxDataviewSegmentConfigurationOutputTypeDef], # (2)
description: str,
autoUpdate: bool,
readWrite: bool,
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
status: KxDataviewStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See KxAzModeType
- See
List[KxDataviewSegmentConfigurationOutputTypeDef] - See KxDataviewStatusType
- See ResponseMetadataTypeDef
KxDataviewActiveVersionTypeDef#
# KxDataviewActiveVersionTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewActiveVersionTypeDef
def get_value() -> KxDataviewActiveVersionTypeDef:
return {
"changesetId": ...,
}
# KxDataviewActiveVersionTypeDef definition
class KxDataviewActiveVersionTypeDef(TypedDict):
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[List[KxDataviewSegmentConfigurationOutputTypeDef]], # (1)
attachedClusters: NotRequired[List[str]],
createdTimestamp: NotRequired[datetime.datetime],
versionId: NotRequired[str],- See
List[KxDataviewSegmentConfigurationOutputTypeDef]
KxDataviewConfigurationOutputTypeDef#
# KxDataviewConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewConfigurationOutputTypeDef
def get_value() -> KxDataviewConfigurationOutputTypeDef:
return {
"dataviewName": ...,
}
# KxDataviewConfigurationOutputTypeDef definition
class KxDataviewConfigurationOutputTypeDef(TypedDict):
dataviewName: NotRequired[str],
dataviewVersionId: NotRequired[str],
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[List[KxDataviewSegmentConfigurationOutputTypeDef]], # (1)- See
List[KxDataviewSegmentConfigurationOutputTypeDef]
CreateKxVolumeRequestTypeDef#
# CreateKxVolumeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxVolumeRequestTypeDef
def get_value() -> CreateKxVolumeRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxVolumeRequestTypeDef definition
class CreateKxVolumeRequestTypeDef(TypedDict):
environmentId: str,
volumeType: KxVolumeTypeType, # (1)
volumeName: str,
azMode: KxAzModeType, # (2)
availabilityZoneIds: Sequence[str],
clientToken: NotRequired[str],
description: NotRequired[str],
nas1Configuration: NotRequired[KxNAS1ConfigurationTypeDef], # (3)
tags: NotRequired[Mapping[str, str]],- See KxVolumeTypeType
- See KxAzModeType
- See KxNAS1ConfigurationTypeDef
CreateKxVolumeResponseTypeDef#
# CreateKxVolumeResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxVolumeResponseTypeDef
def get_value() -> CreateKxVolumeResponseTypeDef:
return {
"environmentId": ...,
}
# CreateKxVolumeResponseTypeDef definition
class CreateKxVolumeResponseTypeDef(TypedDict):
environmentId: str,
volumeName: str,
volumeType: KxVolumeTypeType, # (1)
volumeArn: str,
nas1Configuration: KxNAS1ConfigurationTypeDef, # (2)
status: KxVolumeStatusType, # (3)
statusReason: str,
azMode: KxAzModeType, # (4)
description: str,
availabilityZoneIds: List[str],
createdTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See KxVolumeTypeType
- See KxNAS1ConfigurationTypeDef
- See KxVolumeStatusType
- See KxAzModeType
- See ResponseMetadataTypeDef
UpdateKxVolumeRequestTypeDef#
# UpdateKxVolumeRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxVolumeRequestTypeDef
def get_value() -> UpdateKxVolumeRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxVolumeRequestTypeDef definition
class UpdateKxVolumeRequestTypeDef(TypedDict):
environmentId: str,
volumeName: str,
description: NotRequired[str],
clientToken: NotRequired[str],
nas1Configuration: NotRequired[KxNAS1ConfigurationTypeDef], # (1)EnvironmentTypeDef#
# EnvironmentTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import EnvironmentTypeDef
def get_value() -> EnvironmentTypeDef:
return {
"name": ...,
}
# EnvironmentTypeDef definition
class EnvironmentTypeDef(TypedDict):
name: NotRequired[str],
environmentId: NotRequired[str],
awsAccountId: NotRequired[str],
status: NotRequired[EnvironmentStatusType], # (1)
environmentUrl: NotRequired[str],
description: NotRequired[str],
environmentArn: NotRequired[str],
sageMakerStudioDomainUrl: NotRequired[str],
kmsKeyId: NotRequired[str],
dedicatedServiceAccountId: NotRequired[str],
federationMode: NotRequired[FederationModeType], # (2)
federationParameters: NotRequired[FederationParametersOutputTypeDef], # (3)GetKxVolumeResponseTypeDef#
# GetKxVolumeResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxVolumeResponseTypeDef
def get_value() -> GetKxVolumeResponseTypeDef:
return {
"environmentId": ...,
}
# GetKxVolumeResponseTypeDef definition
class GetKxVolumeResponseTypeDef(TypedDict):
environmentId: str,
volumeName: str,
volumeType: KxVolumeTypeType, # (1)
volumeArn: str,
nas1Configuration: KxNAS1ConfigurationTypeDef, # (2)
status: KxVolumeStatusType, # (3)
statusReason: str,
createdTimestamp: datetime.datetime,
description: str,
azMode: KxAzModeType, # (4)
availabilityZoneIds: List[str],
lastModifiedTimestamp: datetime.datetime,
attachedClusters: List[KxAttachedClusterTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See KxVolumeTypeType
- See KxNAS1ConfigurationTypeDef
- See KxVolumeStatusType
- See KxAzModeType
- See
List[KxAttachedClusterTypeDef] - See ResponseMetadataTypeDef
UpdateKxVolumeResponseTypeDef#
# UpdateKxVolumeResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxVolumeResponseTypeDef
def get_value() -> UpdateKxVolumeResponseTypeDef:
return {
"environmentId": ...,
}
# UpdateKxVolumeResponseTypeDef definition
class UpdateKxVolumeResponseTypeDef(TypedDict):
environmentId: str,
volumeName: str,
volumeType: KxVolumeTypeType, # (1)
volumeArn: str,
nas1Configuration: KxNAS1ConfigurationTypeDef, # (2)
status: KxVolumeStatusType, # (3)
description: str,
statusReason: str,
createdTimestamp: datetime.datetime,
azMode: KxAzModeType, # (4)
availabilityZoneIds: List[str],
lastModifiedTimestamp: datetime.datetime,
attachedClusters: List[KxAttachedClusterTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See KxVolumeTypeType
- See KxNAS1ConfigurationTypeDef
- See KxVolumeStatusType
- See KxAzModeType
- See
List[KxAttachedClusterTypeDef] - See ResponseMetadataTypeDef
ListKxChangesetsResponseTypeDef#
# ListKxChangesetsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxChangesetsResponseTypeDef
def get_value() -> ListKxChangesetsResponseTypeDef:
return {
"kxChangesets": ...,
}
# ListKxChangesetsResponseTypeDef definition
class ListKxChangesetsResponseTypeDef(TypedDict):
kxChangesets: List[KxChangesetListEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxChangesetListEntryTypeDef] - See ResponseMetadataTypeDef
UpdateKxClusterCodeConfigurationRequestTypeDef#
# UpdateKxClusterCodeConfigurationRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxClusterCodeConfigurationRequestTypeDef
def get_value() -> UpdateKxClusterCodeConfigurationRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxClusterCodeConfigurationRequestTypeDef definition
class UpdateKxClusterCodeConfigurationRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
code: CodeConfigurationTypeDef, # (1)
clientToken: NotRequired[str],
initializationScript: NotRequired[str],
commandLineArguments: NotRequired[Sequence[KxCommandLineArgumentTypeDef]], # (2)
deploymentConfiguration: NotRequired[KxClusterCodeDeploymentConfigurationTypeDef], # (3)- See CodeConfigurationTypeDef
- See
Sequence[KxCommandLineArgumentTypeDef] - See KxClusterCodeDeploymentConfigurationTypeDef
ListKxDatabasesResponseTypeDef#
# ListKxDatabasesResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxDatabasesResponseTypeDef
def get_value() -> ListKxDatabasesResponseTypeDef:
return {
"kxDatabases": ...,
}
# ListKxDatabasesResponseTypeDef definition
class ListKxDatabasesResponseTypeDef(TypedDict):
kxDatabases: List[KxDatabaseListEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxDatabaseListEntryTypeDef] - See ResponseMetadataTypeDef
ListKxClusterNodesResponseTypeDef#
# ListKxClusterNodesResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxClusterNodesResponseTypeDef
def get_value() -> ListKxClusterNodesResponseTypeDef:
return {
"nodes": ...,
}
# ListKxClusterNodesResponseTypeDef definition
class ListKxClusterNodesResponseTypeDef(TypedDict):
nodes: List[KxNodeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxNodeTypeDef] - See ResponseMetadataTypeDef
ListKxScalingGroupsResponseTypeDef#
# ListKxScalingGroupsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxScalingGroupsResponseTypeDef
def get_value() -> ListKxScalingGroupsResponseTypeDef:
return {
"scalingGroups": ...,
}
# ListKxScalingGroupsResponseTypeDef definition
class ListKxScalingGroupsResponseTypeDef(TypedDict):
scalingGroups: List[KxScalingGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxScalingGroupTypeDef] - See ResponseMetadataTypeDef
ListKxUsersResponseTypeDef#
# ListKxUsersResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxUsersResponseTypeDef
def get_value() -> ListKxUsersResponseTypeDef:
return {
"users": ...,
}
# ListKxUsersResponseTypeDef definition
class ListKxUsersResponseTypeDef(TypedDict):
users: List[KxUserTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxUserTypeDef] - See ResponseMetadataTypeDef
ListKxVolumesResponseTypeDef#
# ListKxVolumesResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxVolumesResponseTypeDef
def get_value() -> ListKxVolumesResponseTypeDef:
return {
"kxVolumeSummaries": ...,
}
# ListKxVolumesResponseTypeDef definition
class ListKxVolumesResponseTypeDef(TypedDict):
kxVolumeSummaries: List[KxVolumeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxVolumeTypeDef] - See ResponseMetadataTypeDef
ListKxEnvironmentsRequestPaginateTypeDef#
# ListKxEnvironmentsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxEnvironmentsRequestPaginateTypeDef
def get_value() -> ListKxEnvironmentsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListKxEnvironmentsRequestPaginateTypeDef definition
class ListKxEnvironmentsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)NetworkACLEntryTypeDef#
# NetworkACLEntryTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import NetworkACLEntryTypeDef
def get_value() -> NetworkACLEntryTypeDef:
return {
"ruleNumber": ...,
}
# NetworkACLEntryTypeDef definition
class NetworkACLEntryTypeDef(TypedDict):
ruleNumber: int,
protocol: str,
ruleAction: RuleActionType, # (1)
cidrBlock: str,
portRange: NotRequired[PortRangeTypeDef], # (2)
icmpTypeCode: NotRequired[IcmpTypeCodeTypeDef], # (3)- See RuleActionType
- See PortRangeTypeDef
- See IcmpTypeCodeTypeDef
ListKxClustersResponseTypeDef#
# ListKxClustersResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxClustersResponseTypeDef
def get_value() -> ListKxClustersResponseTypeDef:
return {
"kxClusterSummaries": ...,
}
# ListKxClustersResponseTypeDef definition
class ListKxClustersResponseTypeDef(TypedDict):
kxClusterSummaries: List[KxClusterTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxClusterTypeDef] - See ResponseMetadataTypeDef
GetKxDataviewResponseTypeDef#
# GetKxDataviewResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxDataviewResponseTypeDef
def get_value() -> GetKxDataviewResponseTypeDef:
return {
"databaseName": ...,
}
# GetKxDataviewResponseTypeDef definition
class GetKxDataviewResponseTypeDef(TypedDict):
databaseName: str,
dataviewName: str,
azMode: KxAzModeType, # (1)
availabilityZoneId: str,
changesetId: str,
segmentConfigurations: List[KxDataviewSegmentConfigurationOutputTypeDef], # (2)
activeVersions: List[KxDataviewActiveVersionTypeDef], # (3)
description: str,
autoUpdate: bool,
readWrite: bool,
environmentId: str,
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
status: KxDataviewStatusType, # (4)
statusReason: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See KxAzModeType
- See
List[KxDataviewSegmentConfigurationOutputTypeDef] - See
List[KxDataviewActiveVersionTypeDef] - See KxDataviewStatusType
- See ResponseMetadataTypeDef
KxDataviewListEntryTypeDef#
# KxDataviewListEntryTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewListEntryTypeDef
def get_value() -> KxDataviewListEntryTypeDef:
return {
"environmentId": ...,
}
# KxDataviewListEntryTypeDef definition
class KxDataviewListEntryTypeDef(TypedDict):
environmentId: NotRequired[str],
databaseName: NotRequired[str],
dataviewName: NotRequired[str],
azMode: NotRequired[KxAzModeType], # (1)
availabilityZoneId: NotRequired[str],
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[List[KxDataviewSegmentConfigurationOutputTypeDef]], # (2)
activeVersions: NotRequired[List[KxDataviewActiveVersionTypeDef]], # (3)
status: NotRequired[KxDataviewStatusType], # (4)
description: NotRequired[str],
autoUpdate: NotRequired[bool],
readWrite: NotRequired[bool],
createdTimestamp: NotRequired[datetime.datetime],
lastModifiedTimestamp: NotRequired[datetime.datetime],
statusReason: NotRequired[str],- See KxAzModeType
- See
List[KxDataviewSegmentConfigurationOutputTypeDef] - See
List[KxDataviewActiveVersionTypeDef] - See KxDataviewStatusType
UpdateKxDataviewResponseTypeDef#
# UpdateKxDataviewResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxDataviewResponseTypeDef
def get_value() -> UpdateKxDataviewResponseTypeDef:
return {
"environmentId": ...,
}
# UpdateKxDataviewResponseTypeDef definition
class UpdateKxDataviewResponseTypeDef(TypedDict):
environmentId: str,
databaseName: str,
dataviewName: str,
azMode: KxAzModeType, # (1)
availabilityZoneId: str,
changesetId: str,
segmentConfigurations: List[KxDataviewSegmentConfigurationOutputTypeDef], # (2)
activeVersions: List[KxDataviewActiveVersionTypeDef], # (3)
status: KxDataviewStatusType, # (4)
autoUpdate: bool,
readWrite: bool,
description: str,
createdTimestamp: datetime.datetime,
lastModifiedTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See KxAzModeType
- See
List[KxDataviewSegmentConfigurationOutputTypeDef] - See
List[KxDataviewActiveVersionTypeDef] - See KxDataviewStatusType
- See ResponseMetadataTypeDef
KxDatabaseConfigurationOutputTypeDef#
# KxDatabaseConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDatabaseConfigurationOutputTypeDef
def get_value() -> KxDatabaseConfigurationOutputTypeDef:
return {
"databaseName": ...,
}
# KxDatabaseConfigurationOutputTypeDef definition
class KxDatabaseConfigurationOutputTypeDef(TypedDict):
databaseName: str,
cacheConfigurations: NotRequired[List[KxDatabaseCacheConfigurationOutputTypeDef]], # (1)
changesetId: NotRequired[str],
dataviewName: NotRequired[str],
dataviewConfiguration: NotRequired[KxDataviewConfigurationOutputTypeDef], # (2)- See
List[KxDatabaseCacheConfigurationOutputTypeDef] - See KxDataviewConfigurationOutputTypeDef
GetEnvironmentResponseTypeDef#
# GetEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetEnvironmentResponseTypeDef
def get_value() -> GetEnvironmentResponseTypeDef:
return {
"environment": ...,
}
# GetEnvironmentResponseTypeDef definition
class GetEnvironmentResponseTypeDef(TypedDict):
environment: EnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListEnvironmentsResponseTypeDef#
# ListEnvironmentsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListEnvironmentsResponseTypeDef
def get_value() -> ListEnvironmentsResponseTypeDef:
return {
"environments": ...,
}
# ListEnvironmentsResponseTypeDef definition
class ListEnvironmentsResponseTypeDef(TypedDict):
environments: List[EnvironmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[EnvironmentTypeDef] - See ResponseMetadataTypeDef
UpdateEnvironmentResponseTypeDef#
# UpdateEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateEnvironmentResponseTypeDef
def get_value() -> UpdateEnvironmentResponseTypeDef:
return {
"environment": ...,
}
# UpdateEnvironmentResponseTypeDef definition
class UpdateEnvironmentResponseTypeDef(TypedDict):
environment: EnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateEnvironmentRequestTypeDef#
# CreateEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateEnvironmentRequestTypeDef
def get_value() -> CreateEnvironmentRequestTypeDef:
return {
"name": ...,
}
# CreateEnvironmentRequestTypeDef definition
class CreateEnvironmentRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
kmsKeyId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
federationMode: NotRequired[FederationModeType], # (1)
federationParameters: NotRequired[FederationParametersUnionTypeDef], # (2)
superuserParameters: NotRequired[SuperuserParametersTypeDef], # (3)
dataBundles: NotRequired[Sequence[str]],UpdateEnvironmentRequestTypeDef#
# UpdateEnvironmentRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateEnvironmentRequestTypeDef
def get_value() -> UpdateEnvironmentRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateEnvironmentRequestTypeDef definition
class UpdateEnvironmentRequestTypeDef(TypedDict):
environmentId: str,
name: NotRequired[str],
description: NotRequired[str],
federationMode: NotRequired[FederationModeType], # (1)
federationParameters: NotRequired[FederationParametersUnionTypeDef], # (2)CreateKxDataviewRequestTypeDef#
# CreateKxDataviewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxDataviewRequestTypeDef
def get_value() -> CreateKxDataviewRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxDataviewRequestTypeDef definition
class CreateKxDataviewRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
dataviewName: str,
azMode: KxAzModeType, # (1)
clientToken: str,
availabilityZoneId: NotRequired[str],
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[Sequence[KxDataviewSegmentConfigurationUnionTypeDef]], # (2)
autoUpdate: NotRequired[bool],
readWrite: NotRequired[bool],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],- See KxAzModeType
- See
Sequence[KxDataviewSegmentConfigurationUnionTypeDef]
KxDataviewConfigurationTypeDef#
# KxDataviewConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDataviewConfigurationTypeDef
def get_value() -> KxDataviewConfigurationTypeDef:
return {
"dataviewName": ...,
}
# KxDataviewConfigurationTypeDef definition
class KxDataviewConfigurationTypeDef(TypedDict):
dataviewName: NotRequired[str],
dataviewVersionId: NotRequired[str],
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[Sequence[KxDataviewSegmentConfigurationUnionTypeDef]], # (1)- See
Sequence[KxDataviewSegmentConfigurationUnionTypeDef]
UpdateKxDataviewRequestTypeDef#
# UpdateKxDataviewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxDataviewRequestTypeDef
def get_value() -> UpdateKxDataviewRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxDataviewRequestTypeDef definition
class UpdateKxDataviewRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
dataviewName: str,
clientToken: str,
description: NotRequired[str],
changesetId: NotRequired[str],
segmentConfigurations: NotRequired[Sequence[KxDataviewSegmentConfigurationUnionTypeDef]], # (1)- See
Sequence[KxDataviewSegmentConfigurationUnionTypeDef]
TransitGatewayConfigurationOutputTypeDef#
# TransitGatewayConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import TransitGatewayConfigurationOutputTypeDef
def get_value() -> TransitGatewayConfigurationOutputTypeDef:
return {
"transitGatewayID": ...,
}
# TransitGatewayConfigurationOutputTypeDef definition
class TransitGatewayConfigurationOutputTypeDef(TypedDict):
transitGatewayID: str,
routableCIDRSpace: str,
attachmentNetworkAclConfiguration: NotRequired[List[NetworkACLEntryTypeDef]], # (1)- See
List[NetworkACLEntryTypeDef]
TransitGatewayConfigurationTypeDef#
# TransitGatewayConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import TransitGatewayConfigurationTypeDef
def get_value() -> TransitGatewayConfigurationTypeDef:
return {
"transitGatewayID": ...,
}
# TransitGatewayConfigurationTypeDef definition
class TransitGatewayConfigurationTypeDef(TypedDict):
transitGatewayID: str,
routableCIDRSpace: str,
attachmentNetworkAclConfiguration: NotRequired[Sequence[NetworkACLEntryTypeDef]], # (1)- See
Sequence[NetworkACLEntryTypeDef]
ListKxDataviewsResponseTypeDef#
# ListKxDataviewsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxDataviewsResponseTypeDef
def get_value() -> ListKxDataviewsResponseTypeDef:
return {
"kxDataviews": ...,
}
# ListKxDataviewsResponseTypeDef definition
class ListKxDataviewsResponseTypeDef(TypedDict):
kxDataviews: List[KxDataviewListEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxDataviewListEntryTypeDef] - See ResponseMetadataTypeDef
CreateKxClusterResponseTypeDef#
# CreateKxClusterResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxClusterResponseTypeDef
def get_value() -> CreateKxClusterResponseTypeDef:
return {
"environmentId": ...,
}
# CreateKxClusterResponseTypeDef definition
class CreateKxClusterResponseTypeDef(TypedDict):
environmentId: str,
status: KxClusterStatusType, # (1)
statusReason: str,
clusterName: str,
clusterType: KxClusterTypeType, # (2)
tickerplantLogConfiguration: TickerplantLogConfigurationOutputTypeDef, # (3)
volumes: List[VolumeTypeDef], # (4)
databases: List[KxDatabaseConfigurationOutputTypeDef], # (5)
cacheStorageConfigurations: List[KxCacheStorageConfigurationTypeDef], # (6)
autoScalingConfiguration: AutoScalingConfigurationTypeDef, # (7)
clusterDescription: str,
capacityConfiguration: CapacityConfigurationTypeDef, # (8)
releaseLabel: str,
vpcConfiguration: VpcConfigurationOutputTypeDef, # (9)
initializationScript: str,
commandLineArguments: List[KxCommandLineArgumentTypeDef], # (10)
code: CodeConfigurationTypeDef, # (11)
executionRole: str,
lastModifiedTimestamp: datetime.datetime,
savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef, # (12)
azMode: KxAzModeType, # (13)
availabilityZoneId: str,
createdTimestamp: datetime.datetime,
scalingGroupConfiguration: KxScalingGroupConfigurationTypeDef, # (14)
ResponseMetadata: ResponseMetadataTypeDef, # (15)- See KxClusterStatusType
- See KxClusterTypeType
- See TickerplantLogConfigurationOutputTypeDef
- See
List[VolumeTypeDef] - See
List[KxDatabaseConfigurationOutputTypeDef] - See
List[KxCacheStorageConfigurationTypeDef] - See AutoScalingConfigurationTypeDef
- See CapacityConfigurationTypeDef
- See VpcConfigurationOutputTypeDef
- See
List[KxCommandLineArgumentTypeDef] - See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See KxAzModeType
- See KxScalingGroupConfigurationTypeDef
- See ResponseMetadataTypeDef
GetKxClusterResponseTypeDef#
# GetKxClusterResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxClusterResponseTypeDef
def get_value() -> GetKxClusterResponseTypeDef:
return {
"status": ...,
}
# GetKxClusterResponseTypeDef definition
class GetKxClusterResponseTypeDef(TypedDict):
status: KxClusterStatusType, # (1)
statusReason: str,
clusterName: str,
clusterType: KxClusterTypeType, # (2)
tickerplantLogConfiguration: TickerplantLogConfigurationOutputTypeDef, # (3)
volumes: List[VolumeTypeDef], # (4)
databases: List[KxDatabaseConfigurationOutputTypeDef], # (5)
cacheStorageConfigurations: List[KxCacheStorageConfigurationTypeDef], # (6)
autoScalingConfiguration: AutoScalingConfigurationTypeDef, # (7)
clusterDescription: str,
capacityConfiguration: CapacityConfigurationTypeDef, # (8)
releaseLabel: str,
vpcConfiguration: VpcConfigurationOutputTypeDef, # (9)
initializationScript: str,
commandLineArguments: List[KxCommandLineArgumentTypeDef], # (10)
code: CodeConfigurationTypeDef, # (11)
executionRole: str,
lastModifiedTimestamp: datetime.datetime,
savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef, # (12)
azMode: KxAzModeType, # (13)
availabilityZoneId: str,
createdTimestamp: datetime.datetime,
scalingGroupConfiguration: KxScalingGroupConfigurationTypeDef, # (14)
ResponseMetadata: ResponseMetadataTypeDef, # (15)- See KxClusterStatusType
- See KxClusterTypeType
- See TickerplantLogConfigurationOutputTypeDef
- See
List[VolumeTypeDef] - See
List[KxDatabaseConfigurationOutputTypeDef] - See
List[KxCacheStorageConfigurationTypeDef] - See AutoScalingConfigurationTypeDef
- See CapacityConfigurationTypeDef
- See VpcConfigurationOutputTypeDef
- See
List[KxCommandLineArgumentTypeDef] - See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See KxAzModeType
- See KxScalingGroupConfigurationTypeDef
- See ResponseMetadataTypeDef
GetKxEnvironmentResponseTypeDef#
# GetKxEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import GetKxEnvironmentResponseTypeDef
def get_value() -> GetKxEnvironmentResponseTypeDef:
return {
"name": ...,
}
# GetKxEnvironmentResponseTypeDef definition
class GetKxEnvironmentResponseTypeDef(TypedDict):
name: str,
environmentId: str,
awsAccountId: str,
status: EnvironmentStatusType, # (1)
tgwStatus: TgwStatusType, # (2)
dnsStatus: DnsStatusType, # (3)
errorMessage: str,
description: str,
environmentArn: str,
kmsKeyId: str,
dedicatedServiceAccountId: str,
transitGatewayConfiguration: TransitGatewayConfigurationOutputTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime.datetime,
updateTimestamp: datetime.datetime,
availabilityZoneIds: List[str],
certificateAuthorityArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See EnvironmentStatusType
- See TgwStatusType
- See DnsStatusType
- See TransitGatewayConfigurationOutputTypeDef
- See
List[CustomDNSServerTypeDef] - See ResponseMetadataTypeDef
KxEnvironmentTypeDef#
# KxEnvironmentTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxEnvironmentTypeDef
def get_value() -> KxEnvironmentTypeDef:
return {
"name": ...,
}
# KxEnvironmentTypeDef definition
class KxEnvironmentTypeDef(TypedDict):
name: NotRequired[str],
environmentId: NotRequired[str],
awsAccountId: NotRequired[str],
status: NotRequired[EnvironmentStatusType], # (1)
tgwStatus: NotRequired[TgwStatusType], # (2)
dnsStatus: NotRequired[DnsStatusType], # (3)
errorMessage: NotRequired[str],
description: NotRequired[str],
environmentArn: NotRequired[str],
kmsKeyId: NotRequired[str],
dedicatedServiceAccountId: NotRequired[str],
transitGatewayConfiguration: NotRequired[TransitGatewayConfigurationOutputTypeDef], # (4)
customDNSConfiguration: NotRequired[List[CustomDNSServerTypeDef]], # (5)
creationTimestamp: NotRequired[datetime.datetime],
updateTimestamp: NotRequired[datetime.datetime],
availabilityZoneIds: NotRequired[List[str]],
certificateAuthorityArn: NotRequired[str],- See EnvironmentStatusType
- See TgwStatusType
- See DnsStatusType
- See TransitGatewayConfigurationOutputTypeDef
- See
List[CustomDNSServerTypeDef]
UpdateKxEnvironmentNetworkResponseTypeDef#
# UpdateKxEnvironmentNetworkResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentNetworkResponseTypeDef
def get_value() -> UpdateKxEnvironmentNetworkResponseTypeDef:
return {
"name": ...,
}
# UpdateKxEnvironmentNetworkResponseTypeDef definition
class UpdateKxEnvironmentNetworkResponseTypeDef(TypedDict):
name: str,
environmentId: str,
awsAccountId: str,
status: EnvironmentStatusType, # (1)
tgwStatus: TgwStatusType, # (2)
dnsStatus: DnsStatusType, # (3)
errorMessage: str,
description: str,
environmentArn: str,
kmsKeyId: str,
dedicatedServiceAccountId: str,
transitGatewayConfiguration: TransitGatewayConfigurationOutputTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime.datetime,
updateTimestamp: datetime.datetime,
availabilityZoneIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See EnvironmentStatusType
- See TgwStatusType
- See DnsStatusType
- See TransitGatewayConfigurationOutputTypeDef
- See
List[CustomDNSServerTypeDef] - See ResponseMetadataTypeDef
UpdateKxEnvironmentResponseTypeDef#
# UpdateKxEnvironmentResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentResponseTypeDef
def get_value() -> UpdateKxEnvironmentResponseTypeDef:
return {
"name": ...,
}
# UpdateKxEnvironmentResponseTypeDef definition
class UpdateKxEnvironmentResponseTypeDef(TypedDict):
name: str,
environmentId: str,
awsAccountId: str,
status: EnvironmentStatusType, # (1)
tgwStatus: TgwStatusType, # (2)
dnsStatus: DnsStatusType, # (3)
errorMessage: str,
description: str,
environmentArn: str,
kmsKeyId: str,
dedicatedServiceAccountId: str,
transitGatewayConfiguration: TransitGatewayConfigurationOutputTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime.datetime,
updateTimestamp: datetime.datetime,
availabilityZoneIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See EnvironmentStatusType
- See TgwStatusType
- See DnsStatusType
- See TransitGatewayConfigurationOutputTypeDef
- See
List[CustomDNSServerTypeDef] - See ResponseMetadataTypeDef
KxDatabaseConfigurationTypeDef#
# KxDatabaseConfigurationTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import KxDatabaseConfigurationTypeDef
def get_value() -> KxDatabaseConfigurationTypeDef:
return {
"databaseName": ...,
}
# KxDatabaseConfigurationTypeDef definition
class KxDatabaseConfigurationTypeDef(TypedDict):
databaseName: str,
cacheConfigurations: NotRequired[Sequence[KxDatabaseCacheConfigurationUnionTypeDef]], # (1)
changesetId: NotRequired[str],
dataviewName: NotRequired[str],
dataviewConfiguration: NotRequired[KxDataviewConfigurationUnionTypeDef], # (2)- See
Sequence[KxDatabaseCacheConfigurationUnionTypeDef] - See KxDataviewConfigurationUnionTypeDef
ListKxEnvironmentsResponseTypeDef#
# ListKxEnvironmentsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import ListKxEnvironmentsResponseTypeDef
def get_value() -> ListKxEnvironmentsResponseTypeDef:
return {
"environments": ...,
}
# ListKxEnvironmentsResponseTypeDef definition
class ListKxEnvironmentsResponseTypeDef(TypedDict):
environments: List[KxEnvironmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[KxEnvironmentTypeDef] - See ResponseMetadataTypeDef
UpdateKxEnvironmentNetworkRequestTypeDef#
# UpdateKxEnvironmentNetworkRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentNetworkRequestTypeDef
def get_value() -> UpdateKxEnvironmentNetworkRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxEnvironmentNetworkRequestTypeDef definition
class UpdateKxEnvironmentNetworkRequestTypeDef(TypedDict):
environmentId: str,
transitGatewayConfiguration: NotRequired[TransitGatewayConfigurationUnionTypeDef], # (1)
customDNSConfiguration: NotRequired[Sequence[CustomDNSServerTypeDef]], # (2)
clientToken: NotRequired[str],- See TransitGatewayConfigurationUnionTypeDef
- See
Sequence[CustomDNSServerTypeDef]
CreateKxClusterRequestTypeDef#
# CreateKxClusterRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import CreateKxClusterRequestTypeDef
def get_value() -> CreateKxClusterRequestTypeDef:
return {
"environmentId": ...,
}
# CreateKxClusterRequestTypeDef definition
class CreateKxClusterRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
clusterType: KxClusterTypeType, # (1)
releaseLabel: str,
vpcConfiguration: VpcConfigurationUnionTypeDef, # (2)
azMode: KxAzModeType, # (3)
clientToken: NotRequired[str],
tickerplantLogConfiguration: NotRequired[TickerplantLogConfigurationUnionTypeDef], # (4)
databases: NotRequired[Sequence[KxDatabaseConfigurationUnionTypeDef]], # (5)
cacheStorageConfigurations: NotRequired[Sequence[KxCacheStorageConfigurationTypeDef]], # (6)
autoScalingConfiguration: NotRequired[AutoScalingConfigurationTypeDef], # (7)
clusterDescription: NotRequired[str],
capacityConfiguration: NotRequired[CapacityConfigurationTypeDef], # (8)
initializationScript: NotRequired[str],
commandLineArguments: NotRequired[Sequence[KxCommandLineArgumentTypeDef]], # (9)
code: NotRequired[CodeConfigurationTypeDef], # (10)
executionRole: NotRequired[str],
savedownStorageConfiguration: NotRequired[KxSavedownStorageConfigurationTypeDef], # (11)
availabilityZoneId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
scalingGroupConfiguration: NotRequired[KxScalingGroupConfigurationTypeDef], # (12)- See KxClusterTypeType
- See VpcConfigurationUnionTypeDef
- See KxAzModeType
- See TickerplantLogConfigurationUnionTypeDef
- See
Sequence[KxDatabaseConfigurationUnionTypeDef] - See
Sequence[KxCacheStorageConfigurationTypeDef] - See AutoScalingConfigurationTypeDef
- See CapacityConfigurationTypeDef
- See
Sequence[KxCommandLineArgumentTypeDef] - See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See KxScalingGroupConfigurationTypeDef
UpdateKxClusterDatabasesRequestTypeDef#
# UpdateKxClusterDatabasesRequestTypeDef TypedDict usage example
from mypy_boto3_finspace.type_defs import UpdateKxClusterDatabasesRequestTypeDef
def get_value() -> UpdateKxClusterDatabasesRequestTypeDef:
return {
"environmentId": ...,
}
# UpdateKxClusterDatabasesRequestTypeDef definition
class UpdateKxClusterDatabasesRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
databases: Sequence[KxDatabaseConfigurationUnionTypeDef], # (1)
clientToken: NotRequired[str],
deploymentConfiguration: NotRequired[KxDeploymentConfigurationTypeDef], # (2)- See
Sequence[KxDatabaseConfigurationUnionTypeDef] - See KxDeploymentConfigurationTypeDef