Skip to content

Typed dictionaries#

Index > finspace > Typed dictionaries

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

AutoScalingConfigurationTypeDef#

# AutoScalingConfigurationTypeDef 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],
  1. See AutoScalingMetricType

CapacityConfigurationTypeDef#

# CapacityConfigurationTypeDef 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 usage example

from mypy_boto3_finspace.type_defs import ChangeRequestTypeDef

def get_value() -> ChangeRequestTypeDef:
    return {
        "changeType": ...,
        "dbPath": ...,
    }
# ChangeRequestTypeDef definition

class ChangeRequestTypeDef(TypedDict):
    changeType: ChangeTypeType,  # (1)
    dbPath: str,
    s3Path: NotRequired[str],
  1. See ChangeTypeType

CodeConfigurationTypeDef#

# CodeConfigurationTypeDef 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],

FederationParametersTypeDef#

# FederationParametersTypeDef 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]],

SuperuserParametersTypeDef#

# SuperuserParametersTypeDef usage example

from mypy_boto3_finspace.type_defs import SuperuserParametersTypeDef

def get_value() -> SuperuserParametersTypeDef:
    return {
        "emailAddress": ...,
        "firstName": ...,
        "lastName": ...,
    }
# SuperuserParametersTypeDef definition

class SuperuserParametersTypeDef(TypedDict):
    emailAddress: str,
    firstName: str,
    lastName: str,

CreateEnvironmentResponseTypeDef#

# CreateEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateEnvironmentResponseTypeDef

def get_value() -> CreateEnvironmentResponseTypeDef:
    return {
        "environmentId": ...,
        "environmentArn": ...,
        "environmentUrl": ...,
        "ResponseMetadata": ...,
    }
# CreateEnvironmentResponseTypeDef definition

class CreateEnvironmentResponseTypeDef(TypedDict):
    environmentId: str,
    environmentArn: str,
    environmentUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ErrorInfoTypeDef#

# ErrorInfoTypeDef 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)
  1. See ErrorDetailsType

KxCacheStorageConfigurationTypeDef#

# KxCacheStorageConfigurationTypeDef usage example

from mypy_boto3_finspace.type_defs import KxCacheStorageConfigurationTypeDef

def get_value() -> KxCacheStorageConfigurationTypeDef:
    return {
        "type": ...,
        "size": ...,
    }
# KxCacheStorageConfigurationTypeDef definition

class KxCacheStorageConfigurationTypeDef(TypedDict):
    type: str,
    size: int,

KxCommandLineArgumentTypeDef#

# KxCommandLineArgumentTypeDef 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 usage example

from mypy_boto3_finspace.type_defs import KxSavedownStorageConfigurationTypeDef

def get_value() -> KxSavedownStorageConfigurationTypeDef:
    return {
        "type": ...,
        "size": ...,
    }
# KxSavedownStorageConfigurationTypeDef definition

class KxSavedownStorageConfigurationTypeDef(TypedDict):
    type: KxSavedownStorageTypeType,  # (1)
    size: int,
  1. See KxSavedownStorageTypeType

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef 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)
  1. See IPAddressTypeType

CreateKxDatabaseRequestRequestTypeDef#

# CreateKxDatabaseRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxDatabaseRequestRequestTypeDef

def get_value() -> CreateKxDatabaseRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
        "clientToken": ...,
    }
# CreateKxDatabaseRequestRequestTypeDef definition

class CreateKxDatabaseRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    clientToken: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateKxDatabaseResponseTypeDef#

# CreateKxDatabaseResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxDatabaseResponseTypeDef

def get_value() -> CreateKxDatabaseResponseTypeDef:
    return {
        "databaseName": ...,
        "databaseArn": ...,
        "environmentId": ...,
        "description": ...,
        "createdTimestamp": ...,
        "lastModifiedTimestamp": ...,
        "ResponseMetadata": ...,
    }
# CreateKxDatabaseResponseTypeDef definition

class CreateKxDatabaseResponseTypeDef(TypedDict):
    databaseName: str,
    databaseArn: str,
    environmentId: str,
    description: str,
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateKxEnvironmentRequestRequestTypeDef#

# CreateKxEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxEnvironmentRequestRequestTypeDef

def get_value() -> CreateKxEnvironmentRequestRequestTypeDef:
    return {
        "name": ...,
        "kmsKeyId": ...,
    }
# CreateKxEnvironmentRequestRequestTypeDef definition

class CreateKxEnvironmentRequestRequestTypeDef(TypedDict):
    name: str,
    kmsKeyId: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],

CreateKxEnvironmentResponseTypeDef#

# CreateKxEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxEnvironmentResponseTypeDef

def get_value() -> CreateKxEnvironmentResponseTypeDef:
    return {
        "name": ...,
        "status": ...,
        "environmentId": ...,
        "description": ...,
        "environmentArn": ...,
        "kmsKeyId": ...,
        "creationTimestamp": ...,
        "ResponseMetadata": ...,
    }
# CreateKxEnvironmentResponseTypeDef definition

class CreateKxEnvironmentResponseTypeDef(TypedDict):
    name: str,
    status: EnvironmentStatusType,  # (1)
    environmentId: str,
    description: str,
    environmentArn: str,
    kmsKeyId: str,
    creationTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentStatusType
  2. See ResponseMetadataTypeDef

CreateKxUserRequestRequestTypeDef#

# CreateKxUserRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxUserRequestRequestTypeDef

def get_value() -> CreateKxUserRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "userName": ...,
        "iamRole": ...,
    }
# CreateKxUserRequestRequestTypeDef definition

class CreateKxUserRequestRequestTypeDef(TypedDict):
    environmentId: str,
    userName: str,
    iamRole: str,
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],

CreateKxUserResponseTypeDef#

# CreateKxUserResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxUserResponseTypeDef

def get_value() -> CreateKxUserResponseTypeDef:
    return {
        "userName": ...,
        "userArn": ...,
        "environmentId": ...,
        "iamRole": ...,
        "ResponseMetadata": ...,
    }
# CreateKxUserResponseTypeDef definition

class CreateKxUserResponseTypeDef(TypedDict):
    userName: str,
    userArn: str,
    environmentId: str,
    iamRole: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CustomDNSServerTypeDef#

# CustomDNSServerTypeDef usage example

from mypy_boto3_finspace.type_defs import CustomDNSServerTypeDef

def get_value() -> CustomDNSServerTypeDef:
    return {
        "customDNSServerName": ...,
        "customDNSServerIP": ...,
    }
# CustomDNSServerTypeDef definition

class CustomDNSServerTypeDef(TypedDict):
    customDNSServerName: str,
    customDNSServerIP: str,

DeleteEnvironmentRequestRequestTypeDef#

# DeleteEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import DeleteEnvironmentRequestRequestTypeDef

def get_value() -> DeleteEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# DeleteEnvironmentRequestRequestTypeDef definition

class DeleteEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

DeleteKxClusterRequestRequestTypeDef#

# DeleteKxClusterRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import DeleteKxClusterRequestRequestTypeDef

def get_value() -> DeleteKxClusterRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "clusterName": ...,
    }
# DeleteKxClusterRequestRequestTypeDef definition

class DeleteKxClusterRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    clientToken: NotRequired[str],

DeleteKxDatabaseRequestRequestTypeDef#

# DeleteKxDatabaseRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import DeleteKxDatabaseRequestRequestTypeDef

def get_value() -> DeleteKxDatabaseRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
        "clientToken": ...,
    }
# DeleteKxDatabaseRequestRequestTypeDef definition

class DeleteKxDatabaseRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    clientToken: str,

DeleteKxEnvironmentRequestRequestTypeDef#

# DeleteKxEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import DeleteKxEnvironmentRequestRequestTypeDef

def get_value() -> DeleteKxEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# DeleteKxEnvironmentRequestRequestTypeDef definition

class DeleteKxEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

DeleteKxUserRequestRequestTypeDef#

# DeleteKxUserRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import DeleteKxUserRequestRequestTypeDef

def get_value() -> DeleteKxUserRequestRequestTypeDef:
    return {
        "userName": ...,
        "environmentId": ...,
    }
# DeleteKxUserRequestRequestTypeDef definition

class DeleteKxUserRequestRequestTypeDef(TypedDict):
    userName: str,
    environmentId: str,

GetEnvironmentRequestRequestTypeDef#

# GetEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetEnvironmentRequestRequestTypeDef

def get_value() -> GetEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# GetEnvironmentRequestRequestTypeDef definition

class GetEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

GetKxChangesetRequestRequestTypeDef#

# GetKxChangesetRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxChangesetRequestRequestTypeDef

def get_value() -> GetKxChangesetRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
        "changesetId": ...,
    }
# GetKxChangesetRequestRequestTypeDef definition

class GetKxChangesetRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    changesetId: str,

GetKxClusterRequestRequestTypeDef#

# GetKxClusterRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxClusterRequestRequestTypeDef

def get_value() -> GetKxClusterRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "clusterName": ...,
    }
# GetKxClusterRequestRequestTypeDef definition

class GetKxClusterRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,

GetKxConnectionStringRequestRequestTypeDef#

# GetKxConnectionStringRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxConnectionStringRequestRequestTypeDef

def get_value() -> GetKxConnectionStringRequestRequestTypeDef:
    return {
        "userArn": ...,
        "environmentId": ...,
        "clusterName": ...,
    }
# GetKxConnectionStringRequestRequestTypeDef definition

class GetKxConnectionStringRequestRequestTypeDef(TypedDict):
    userArn: str,
    environmentId: str,
    clusterName: str,

GetKxConnectionStringResponseTypeDef#

# GetKxConnectionStringResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxConnectionStringResponseTypeDef

def get_value() -> GetKxConnectionStringResponseTypeDef:
    return {
        "signedConnectionString": ...,
        "ResponseMetadata": ...,
    }
# GetKxConnectionStringResponseTypeDef definition

class GetKxConnectionStringResponseTypeDef(TypedDict):
    signedConnectionString: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetKxDatabaseRequestRequestTypeDef#

# GetKxDatabaseRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxDatabaseRequestRequestTypeDef

def get_value() -> GetKxDatabaseRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
    }
# GetKxDatabaseRequestRequestTypeDef definition

class GetKxDatabaseRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,

GetKxDatabaseResponseTypeDef#

# GetKxDatabaseResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxDatabaseResponseTypeDef

def get_value() -> GetKxDatabaseResponseTypeDef:
    return {
        "databaseName": ...,
        "databaseArn": ...,
        "environmentId": ...,
        "description": ...,
        "createdTimestamp": ...,
        "lastModifiedTimestamp": ...,
        "lastCompletedChangesetId": ...,
        "numBytes": ...,
        "numChangesets": ...,
        "numFiles": ...,
        "ResponseMetadata": ...,
    }
# GetKxDatabaseResponseTypeDef definition

class GetKxDatabaseResponseTypeDef(TypedDict):
    databaseName: str,
    databaseArn: str,
    environmentId: str,
    description: str,
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    lastCompletedChangesetId: str,
    numBytes: int,
    numChangesets: int,
    numFiles: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetKxEnvironmentRequestRequestTypeDef#

# GetKxEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxEnvironmentRequestRequestTypeDef

def get_value() -> GetKxEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# GetKxEnvironmentRequestRequestTypeDef definition

class GetKxEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

TransitGatewayConfigurationTypeDef#

# TransitGatewayConfigurationTypeDef usage example

from mypy_boto3_finspace.type_defs import TransitGatewayConfigurationTypeDef

def get_value() -> TransitGatewayConfigurationTypeDef:
    return {
        "transitGatewayID": ...,
        "routableCIDRSpace": ...,
    }
# TransitGatewayConfigurationTypeDef definition

class TransitGatewayConfigurationTypeDef(TypedDict):
    transitGatewayID: str,
    routableCIDRSpace: str,

GetKxUserRequestRequestTypeDef#

# GetKxUserRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxUserRequestRequestTypeDef

def get_value() -> GetKxUserRequestRequestTypeDef:
    return {
        "userName": ...,
        "environmentId": ...,
    }
# GetKxUserRequestRequestTypeDef definition

class GetKxUserRequestRequestTypeDef(TypedDict):
    userName: str,
    environmentId: str,

GetKxUserResponseTypeDef#

# GetKxUserResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxUserResponseTypeDef

def get_value() -> GetKxUserResponseTypeDef:
    return {
        "userName": ...,
        "userArn": ...,
        "environmentId": ...,
        "iamRole": ...,
        "ResponseMetadata": ...,
    }
# GetKxUserResponseTypeDef definition

class GetKxUserResponseTypeDef(TypedDict):
    userName: str,
    userArn: str,
    environmentId: str,
    iamRole: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

KxChangesetListEntryTypeDef#

# KxChangesetListEntryTypeDef 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],
    activeFromTimestamp: NotRequired[datetime],
    lastModifiedTimestamp: NotRequired[datetime],
    status: NotRequired[ChangesetStatusType],  # (1)
  1. See ChangesetStatusType

KxClusterTypeDef#

# KxClusterTypeDef 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],
    initializationScript: NotRequired[str],
    executionRole: NotRequired[str],
    azMode: NotRequired[KxAzModeType],  # (3)
    availabilityZoneId: NotRequired[str],
    lastModifiedTimestamp: NotRequired[datetime],
    createdTimestamp: NotRequired[datetime],
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See KxAzModeType

KxDatabaseCacheConfigurationTypeDef#

# KxDatabaseCacheConfigurationTypeDef usage example

from mypy_boto3_finspace.type_defs import KxDatabaseCacheConfigurationTypeDef

def get_value() -> KxDatabaseCacheConfigurationTypeDef:
    return {
        "cacheType": ...,
        "dbPaths": ...,
    }
# KxDatabaseCacheConfigurationTypeDef definition

class KxDatabaseCacheConfigurationTypeDef(TypedDict):
    cacheType: str,
    dbPaths: Sequence[str],

KxDatabaseListEntryTypeDef#

# KxDatabaseListEntryTypeDef 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],
    lastModifiedTimestamp: NotRequired[datetime],

KxNodeTypeDef#

# KxNodeTypeDef 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],

KxUserTypeDef#

# KxUserTypeDef 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],
    updateTimestamp: NotRequired[datetime],

ListEnvironmentsRequestRequestTypeDef#

# ListEnvironmentsRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListEnvironmentsRequestRequestTypeDef

def get_value() -> ListEnvironmentsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
# ListEnvironmentsRequestRequestTypeDef definition

class ListEnvironmentsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListKxChangesetsRequestRequestTypeDef#

# ListKxChangesetsRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxChangesetsRequestRequestTypeDef

def get_value() -> ListKxChangesetsRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
    }
# ListKxChangesetsRequestRequestTypeDef definition

class ListKxChangesetsRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListKxClusterNodesRequestRequestTypeDef#

# ListKxClusterNodesRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxClusterNodesRequestRequestTypeDef

def get_value() -> ListKxClusterNodesRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "clusterName": ...,
    }
# ListKxClusterNodesRequestRequestTypeDef definition

class ListKxClusterNodesRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListKxClustersRequestRequestTypeDef#

# ListKxClustersRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxClustersRequestRequestTypeDef

def get_value() -> ListKxClustersRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# ListKxClustersRequestRequestTypeDef definition

class ListKxClustersRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterType: NotRequired[KxClusterTypeType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See KxClusterTypeType

ListKxDatabasesRequestRequestTypeDef#

# ListKxDatabasesRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxDatabasesRequestRequestTypeDef

def get_value() -> ListKxDatabasesRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# ListKxDatabasesRequestRequestTypeDef definition

class ListKxDatabasesRequestRequestTypeDef(TypedDict):
    environmentId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef#

# ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef

def get_value() -> ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef definition

class ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListKxEnvironmentsRequestRequestTypeDef#

# ListKxEnvironmentsRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxEnvironmentsRequestRequestTypeDef

def get_value() -> ListKxEnvironmentsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
# ListKxEnvironmentsRequestRequestTypeDef definition

class ListKxEnvironmentsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListKxUsersRequestRequestTypeDef#

# ListKxUsersRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxUsersRequestRequestTypeDef

def get_value() -> ListKxUsersRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# ListKxUsersRequestRequestTypeDef definition

class ListKxUsersRequestRequestTypeDef(TypedDict):
    environmentId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef 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],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_finspace.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateKxDatabaseRequestRequestTypeDef#

# UpdateKxDatabaseRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxDatabaseRequestRequestTypeDef

def get_value() -> UpdateKxDatabaseRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
        "clientToken": ...,
    }
# UpdateKxDatabaseRequestRequestTypeDef definition

class UpdateKxDatabaseRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    clientToken: str,
    description: NotRequired[str],

UpdateKxDatabaseResponseTypeDef#

# UpdateKxDatabaseResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxDatabaseResponseTypeDef

def get_value() -> UpdateKxDatabaseResponseTypeDef:
    return {
        "databaseName": ...,
        "environmentId": ...,
        "description": ...,
        "lastModifiedTimestamp": ...,
        "ResponseMetadata": ...,
    }
# UpdateKxDatabaseResponseTypeDef definition

class UpdateKxDatabaseResponseTypeDef(TypedDict):
    databaseName: str,
    environmentId: str,
    description: str,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateKxEnvironmentRequestRequestTypeDef#

# UpdateKxEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentRequestRequestTypeDef

def get_value() -> UpdateKxEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# UpdateKxEnvironmentRequestRequestTypeDef definition

class UpdateKxEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,
    name: NotRequired[str],
    description: NotRequired[str],
    clientToken: NotRequired[str],

UpdateKxUserRequestRequestTypeDef#

# UpdateKxUserRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxUserRequestRequestTypeDef

def get_value() -> UpdateKxUserRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "userName": ...,
        "iamRole": ...,
    }
# UpdateKxUserRequestRequestTypeDef definition

class UpdateKxUserRequestRequestTypeDef(TypedDict):
    environmentId: str,
    userName: str,
    iamRole: str,
    clientToken: NotRequired[str],

UpdateKxUserResponseTypeDef#

# UpdateKxUserResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxUserResponseTypeDef

def get_value() -> UpdateKxUserResponseTypeDef:
    return {
        "userName": ...,
        "userArn": ...,
        "environmentId": ...,
        "iamRole": ...,
        "ResponseMetadata": ...,
    }
# UpdateKxUserResponseTypeDef definition

class UpdateKxUserResponseTypeDef(TypedDict):
    userName: str,
    userArn: str,
    environmentId: str,
    iamRole: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateKxChangesetRequestRequestTypeDef#

# CreateKxChangesetRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxChangesetRequestRequestTypeDef

def get_value() -> CreateKxChangesetRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "databaseName": ...,
        "changeRequests": ...,
        "clientToken": ...,
    }
# CreateKxChangesetRequestRequestTypeDef definition

class CreateKxChangesetRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    changeRequests: Sequence[ChangeRequestTypeDef],  # (1)
    clientToken: str,
  1. See ChangeRequestTypeDef

EnvironmentTypeDef#

# EnvironmentTypeDef 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[FederationParametersTypeDef],  # (3)
  1. See EnvironmentStatusType
  2. See FederationModeType
  3. See FederationParametersTypeDef

UpdateEnvironmentRequestRequestTypeDef#

# UpdateEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateEnvironmentRequestRequestTypeDef

def get_value() -> UpdateEnvironmentRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# UpdateEnvironmentRequestRequestTypeDef definition

class UpdateEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,
    name: NotRequired[str],
    description: NotRequired[str],
    federationMode: NotRequired[FederationModeType],  # (1)
    federationParameters: NotRequired[FederationParametersTypeDef],  # (2)
  1. See FederationModeType
  2. See FederationParametersTypeDef

CreateEnvironmentRequestRequestTypeDef#

# CreateEnvironmentRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateEnvironmentRequestRequestTypeDef

def get_value() -> CreateEnvironmentRequestRequestTypeDef:
    return {
        "name": ...,
    }
# CreateEnvironmentRequestRequestTypeDef definition

class CreateEnvironmentRequestRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    federationMode: NotRequired[FederationModeType],  # (1)
    federationParameters: NotRequired[FederationParametersTypeDef],  # (2)
    superuserParameters: NotRequired[SuperuserParametersTypeDef],  # (3)
    dataBundles: NotRequired[Sequence[str]],
  1. See FederationModeType
  2. See FederationParametersTypeDef
  3. See SuperuserParametersTypeDef

CreateKxChangesetResponseTypeDef#

# CreateKxChangesetResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxChangesetResponseTypeDef

def get_value() -> CreateKxChangesetResponseTypeDef:
    return {
        "changesetId": ...,
        "databaseName": ...,
        "environmentId": ...,
        "changeRequests": ...,
        "createdTimestamp": ...,
        "lastModifiedTimestamp": ...,
        "status": ...,
        "errorInfo": ...,
        "ResponseMetadata": ...,
    }
# CreateKxChangesetResponseTypeDef definition

class CreateKxChangesetResponseTypeDef(TypedDict):
    changesetId: str,
    databaseName: str,
    environmentId: str,
    changeRequests: List[ChangeRequestTypeDef],  # (1)
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    status: ChangesetStatusType,  # (2)
    errorInfo: ErrorInfoTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ChangeRequestTypeDef
  2. See ChangesetStatusType
  3. See ErrorInfoTypeDef
  4. See ResponseMetadataTypeDef

GetKxChangesetResponseTypeDef#

# GetKxChangesetResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxChangesetResponseTypeDef

def get_value() -> GetKxChangesetResponseTypeDef:
    return {
        "changesetId": ...,
        "databaseName": ...,
        "environmentId": ...,
        "changeRequests": ...,
        "createdTimestamp": ...,
        "activeFromTimestamp": ...,
        "lastModifiedTimestamp": ...,
        "status": ...,
        "errorInfo": ...,
        "ResponseMetadata": ...,
    }
# GetKxChangesetResponseTypeDef definition

class GetKxChangesetResponseTypeDef(TypedDict):
    changesetId: str,
    databaseName: str,
    environmentId: str,
    changeRequests: List[ChangeRequestTypeDef],  # (1)
    createdTimestamp: datetime,
    activeFromTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    status: ChangesetStatusType,  # (2)
    errorInfo: ErrorInfoTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ChangeRequestTypeDef
  2. See ChangesetStatusType
  3. See ErrorInfoTypeDef
  4. See ResponseMetadataTypeDef

GetKxEnvironmentResponseTypeDef#

# GetKxEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxEnvironmentResponseTypeDef

def get_value() -> GetKxEnvironmentResponseTypeDef:
    return {
        "name": ...,
        "environmentId": ...,
        "awsAccountId": ...,
        "status": ...,
        "tgwStatus": ...,
        "dnsStatus": ...,
        "errorMessage": ...,
        "description": ...,
        "environmentArn": ...,
        "kmsKeyId": ...,
        "dedicatedServiceAccountId": ...,
        "transitGatewayConfiguration": ...,
        "customDNSConfiguration": ...,
        "creationTimestamp": ...,
        "updateTimestamp": ...,
        "availabilityZoneIds": ...,
        "certificateAuthorityArn": ...,
        "ResponseMetadata": ...,
    }
# 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: TransitGatewayConfigurationTypeDef,  # (4)
    customDNSConfiguration: List[CustomDNSServerTypeDef],  # (5)
    creationTimestamp: datetime,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    certificateAuthorityArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

KxEnvironmentTypeDef#

# KxEnvironmentTypeDef 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[TransitGatewayConfigurationTypeDef],  # (4)
    customDNSConfiguration: NotRequired[List[CustomDNSServerTypeDef]],  # (5)
    creationTimestamp: NotRequired[datetime],
    updateTimestamp: NotRequired[datetime],
    availabilityZoneIds: NotRequired[List[str]],
    certificateAuthorityArn: NotRequired[str],
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef

UpdateKxEnvironmentNetworkRequestRequestTypeDef#

# UpdateKxEnvironmentNetworkRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentNetworkRequestRequestTypeDef

def get_value() -> UpdateKxEnvironmentNetworkRequestRequestTypeDef:
    return {
        "environmentId": ...,
    }
# UpdateKxEnvironmentNetworkRequestRequestTypeDef definition

class UpdateKxEnvironmentNetworkRequestRequestTypeDef(TypedDict):
    environmentId: str,
    transitGatewayConfiguration: NotRequired[TransitGatewayConfigurationTypeDef],  # (1)
    customDNSConfiguration: NotRequired[Sequence[CustomDNSServerTypeDef]],  # (2)
    clientToken: NotRequired[str],
  1. See TransitGatewayConfigurationTypeDef
  2. See CustomDNSServerTypeDef

UpdateKxEnvironmentNetworkResponseTypeDef#

# UpdateKxEnvironmentNetworkResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentNetworkResponseTypeDef

def get_value() -> UpdateKxEnvironmentNetworkResponseTypeDef:
    return {
        "name": ...,
        "environmentId": ...,
        "awsAccountId": ...,
        "status": ...,
        "tgwStatus": ...,
        "dnsStatus": ...,
        "errorMessage": ...,
        "description": ...,
        "environmentArn": ...,
        "kmsKeyId": ...,
        "dedicatedServiceAccountId": ...,
        "transitGatewayConfiguration": ...,
        "customDNSConfiguration": ...,
        "creationTimestamp": ...,
        "updateTimestamp": ...,
        "availabilityZoneIds": ...,
        "ResponseMetadata": ...,
    }
# 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: TransitGatewayConfigurationTypeDef,  # (4)
    customDNSConfiguration: List[CustomDNSServerTypeDef],  # (5)
    creationTimestamp: datetime,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

UpdateKxEnvironmentResponseTypeDef#

# UpdateKxEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxEnvironmentResponseTypeDef

def get_value() -> UpdateKxEnvironmentResponseTypeDef:
    return {
        "name": ...,
        "environmentId": ...,
        "awsAccountId": ...,
        "status": ...,
        "tgwStatus": ...,
        "dnsStatus": ...,
        "errorMessage": ...,
        "description": ...,
        "environmentArn": ...,
        "kmsKeyId": ...,
        "dedicatedServiceAccountId": ...,
        "transitGatewayConfiguration": ...,
        "customDNSConfiguration": ...,
        "creationTimestamp": ...,
        "updateTimestamp": ...,
        "availabilityZoneIds": ...,
        "ResponseMetadata": ...,
    }
# 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: TransitGatewayConfigurationTypeDef,  # (4)
    customDNSConfiguration: List[CustomDNSServerTypeDef],  # (5)
    creationTimestamp: datetime,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

ListKxChangesetsResponseTypeDef#

# ListKxChangesetsResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxChangesetsResponseTypeDef

def get_value() -> ListKxChangesetsResponseTypeDef:
    return {
        "kxChangesets": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxChangesetsResponseTypeDef definition

class ListKxChangesetsResponseTypeDef(TypedDict):
    kxChangesets: List[KxChangesetListEntryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxChangesetListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListKxClustersResponseTypeDef#

# ListKxClustersResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxClustersResponseTypeDef

def get_value() -> ListKxClustersResponseTypeDef:
    return {
        "kxClusterSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxClustersResponseTypeDef definition

class ListKxClustersResponseTypeDef(TypedDict):
    kxClusterSummaries: List[KxClusterTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxClusterTypeDef
  2. See ResponseMetadataTypeDef

KxDatabaseConfigurationTypeDef#

# KxDatabaseConfigurationTypeDef 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[KxDatabaseCacheConfigurationTypeDef]],  # (1)
    changesetId: NotRequired[str],
  1. See KxDatabaseCacheConfigurationTypeDef

ListKxDatabasesResponseTypeDef#

# ListKxDatabasesResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxDatabasesResponseTypeDef

def get_value() -> ListKxDatabasesResponseTypeDef:
    return {
        "kxDatabases": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxDatabasesResponseTypeDef definition

class ListKxDatabasesResponseTypeDef(TypedDict):
    kxDatabases: List[KxDatabaseListEntryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxDatabaseListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListKxClusterNodesResponseTypeDef#

# ListKxClusterNodesResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxClusterNodesResponseTypeDef

def get_value() -> ListKxClusterNodesResponseTypeDef:
    return {
        "nodes": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxClusterNodesResponseTypeDef definition

class ListKxClusterNodesResponseTypeDef(TypedDict):
    nodes: List[KxNodeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxNodeTypeDef
  2. See ResponseMetadataTypeDef

ListKxUsersResponseTypeDef#

# ListKxUsersResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxUsersResponseTypeDef

def get_value() -> ListKxUsersResponseTypeDef:
    return {
        "users": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxUsersResponseTypeDef definition

class ListKxUsersResponseTypeDef(TypedDict):
    users: List[KxUserTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxUserTypeDef
  2. See ResponseMetadataTypeDef

GetEnvironmentResponseTypeDef#

# GetEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetEnvironmentResponseTypeDef

def get_value() -> GetEnvironmentResponseTypeDef:
    return {
        "environment": ...,
        "ResponseMetadata": ...,
    }
# GetEnvironmentResponseTypeDef definition

class GetEnvironmentResponseTypeDef(TypedDict):
    environment: EnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentTypeDef
  2. See ResponseMetadataTypeDef

ListEnvironmentsResponseTypeDef#

# ListEnvironmentsResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListEnvironmentsResponseTypeDef

def get_value() -> ListEnvironmentsResponseTypeDef:
    return {
        "environments": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListEnvironmentsResponseTypeDef definition

class ListEnvironmentsResponseTypeDef(TypedDict):
    environments: List[EnvironmentTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentTypeDef
  2. See ResponseMetadataTypeDef

UpdateEnvironmentResponseTypeDef#

# UpdateEnvironmentResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateEnvironmentResponseTypeDef

def get_value() -> UpdateEnvironmentResponseTypeDef:
    return {
        "environment": ...,
        "ResponseMetadata": ...,
    }
# UpdateEnvironmentResponseTypeDef definition

class UpdateEnvironmentResponseTypeDef(TypedDict):
    environment: EnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentTypeDef
  2. See ResponseMetadataTypeDef

ListKxEnvironmentsResponseTypeDef#

# ListKxEnvironmentsResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import ListKxEnvironmentsResponseTypeDef

def get_value() -> ListKxEnvironmentsResponseTypeDef:
    return {
        "environments": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListKxEnvironmentsResponseTypeDef definition

class ListKxEnvironmentsResponseTypeDef(TypedDict):
    environments: List[KxEnvironmentTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxEnvironmentTypeDef
  2. See ResponseMetadataTypeDef

CreateKxClusterRequestRequestTypeDef#

# CreateKxClusterRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxClusterRequestRequestTypeDef

def get_value() -> CreateKxClusterRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "clusterName": ...,
        "clusterType": ...,
        "capacityConfiguration": ...,
        "releaseLabel": ...,
        "azMode": ...,
    }
# CreateKxClusterRequestRequestTypeDef definition

class CreateKxClusterRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    clusterType: KxClusterTypeType,  # (1)
    capacityConfiguration: CapacityConfigurationTypeDef,  # (2)
    releaseLabel: str,
    azMode: KxAzModeType,  # (3)
    clientToken: NotRequired[str],
    databases: NotRequired[Sequence[KxDatabaseConfigurationTypeDef]],  # (4)
    cacheStorageConfigurations: NotRequired[Sequence[KxCacheStorageConfigurationTypeDef]],  # (5)
    autoScalingConfiguration: NotRequired[AutoScalingConfigurationTypeDef],  # (6)
    clusterDescription: NotRequired[str],
    vpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (7)
    initializationScript: NotRequired[str],
    commandLineArguments: NotRequired[Sequence[KxCommandLineArgumentTypeDef]],  # (8)
    code: NotRequired[CodeConfigurationTypeDef],  # (9)
    executionRole: NotRequired[str],
    savedownStorageConfiguration: NotRequired[KxSavedownStorageConfigurationTypeDef],  # (10)
    availabilityZoneId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See KxClusterTypeType
  2. See CapacityConfigurationTypeDef
  3. See KxAzModeType
  4. See KxDatabaseConfigurationTypeDef
  5. See KxCacheStorageConfigurationTypeDef
  6. See AutoScalingConfigurationTypeDef
  7. See VpcConfigurationTypeDef
  8. See KxCommandLineArgumentTypeDef
  9. See CodeConfigurationTypeDef
  10. See KxSavedownStorageConfigurationTypeDef

CreateKxClusterResponseTypeDef#

# CreateKxClusterResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import CreateKxClusterResponseTypeDef

def get_value() -> CreateKxClusterResponseTypeDef:
    return {
        "environmentId": ...,
        "status": ...,
        "statusReason": ...,
        "clusterName": ...,
        "clusterType": ...,
        "databases": ...,
        "cacheStorageConfigurations": ...,
        "autoScalingConfiguration": ...,
        "clusterDescription": ...,
        "capacityConfiguration": ...,
        "releaseLabel": ...,
        "vpcConfiguration": ...,
        "initializationScript": ...,
        "commandLineArguments": ...,
        "code": ...,
        "executionRole": ...,
        "lastModifiedTimestamp": ...,
        "savedownStorageConfiguration": ...,
        "azMode": ...,
        "availabilityZoneId": ...,
        "createdTimestamp": ...,
        "ResponseMetadata": ...,
    }
# CreateKxClusterResponseTypeDef definition

class CreateKxClusterResponseTypeDef(TypedDict):
    environmentId: str,
    status: KxClusterStatusType,  # (1)
    statusReason: str,
    clusterName: str,
    clusterType: KxClusterTypeType,  # (2)
    databases: List[KxDatabaseConfigurationTypeDef],  # (3)
    cacheStorageConfigurations: List[KxCacheStorageConfigurationTypeDef],  # (4)
    autoScalingConfiguration: AutoScalingConfigurationTypeDef,  # (5)
    clusterDescription: str,
    capacityConfiguration: CapacityConfigurationTypeDef,  # (6)
    releaseLabel: str,
    vpcConfiguration: VpcConfigurationTypeDef,  # (7)
    initializationScript: str,
    commandLineArguments: List[KxCommandLineArgumentTypeDef],  # (8)
    code: CodeConfigurationTypeDef,  # (9)
    executionRole: str,
    lastModifiedTimestamp: datetime,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef,  # (10)
    azMode: KxAzModeType,  # (11)
    availabilityZoneId: str,
    createdTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See KxDatabaseConfigurationTypeDef
  4. See KxCacheStorageConfigurationTypeDef
  5. See AutoScalingConfigurationTypeDef
  6. See CapacityConfigurationTypeDef
  7. See VpcConfigurationTypeDef
  8. See KxCommandLineArgumentTypeDef
  9. See CodeConfigurationTypeDef
  10. See KxSavedownStorageConfigurationTypeDef
  11. See KxAzModeType
  12. See ResponseMetadataTypeDef

GetKxClusterResponseTypeDef#

# GetKxClusterResponseTypeDef usage example

from mypy_boto3_finspace.type_defs import GetKxClusterResponseTypeDef

def get_value() -> GetKxClusterResponseTypeDef:
    return {
        "status": ...,
        "statusReason": ...,
        "clusterName": ...,
        "clusterType": ...,
        "databases": ...,
        "cacheStorageConfigurations": ...,
        "autoScalingConfiguration": ...,
        "clusterDescription": ...,
        "capacityConfiguration": ...,
        "releaseLabel": ...,
        "vpcConfiguration": ...,
        "initializationScript": ...,
        "commandLineArguments": ...,
        "code": ...,
        "executionRole": ...,
        "lastModifiedTimestamp": ...,
        "savedownStorageConfiguration": ...,
        "azMode": ...,
        "availabilityZoneId": ...,
        "createdTimestamp": ...,
        "ResponseMetadata": ...,
    }
# GetKxClusterResponseTypeDef definition

class GetKxClusterResponseTypeDef(TypedDict):
    status: KxClusterStatusType,  # (1)
    statusReason: str,
    clusterName: str,
    clusterType: KxClusterTypeType,  # (2)
    databases: List[KxDatabaseConfigurationTypeDef],  # (3)
    cacheStorageConfigurations: List[KxCacheStorageConfigurationTypeDef],  # (4)
    autoScalingConfiguration: AutoScalingConfigurationTypeDef,  # (5)
    clusterDescription: str,
    capacityConfiguration: CapacityConfigurationTypeDef,  # (6)
    releaseLabel: str,
    vpcConfiguration: VpcConfigurationTypeDef,  # (7)
    initializationScript: str,
    commandLineArguments: List[KxCommandLineArgumentTypeDef],  # (8)
    code: CodeConfigurationTypeDef,  # (9)
    executionRole: str,
    lastModifiedTimestamp: datetime,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef,  # (10)
    azMode: KxAzModeType,  # (11)
    availabilityZoneId: str,
    createdTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See KxDatabaseConfigurationTypeDef
  4. See KxCacheStorageConfigurationTypeDef
  5. See AutoScalingConfigurationTypeDef
  6. See CapacityConfigurationTypeDef
  7. See VpcConfigurationTypeDef
  8. See KxCommandLineArgumentTypeDef
  9. See CodeConfigurationTypeDef
  10. See KxSavedownStorageConfigurationTypeDef
  11. See KxAzModeType
  12. See ResponseMetadataTypeDef

UpdateKxClusterDatabasesRequestRequestTypeDef#

# UpdateKxClusterDatabasesRequestRequestTypeDef usage example

from mypy_boto3_finspace.type_defs import UpdateKxClusterDatabasesRequestRequestTypeDef

def get_value() -> UpdateKxClusterDatabasesRequestRequestTypeDef:
    return {
        "environmentId": ...,
        "clusterName": ...,
        "databases": ...,
    }
# UpdateKxClusterDatabasesRequestRequestTypeDef definition

class UpdateKxClusterDatabasesRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    databases: Sequence[KxDatabaseConfigurationTypeDef],  # (1)
    clientToken: NotRequired[str],
  1. See KxDatabaseConfigurationTypeDef