Skip to content

Type definitions#

Index > finspace > Type definitions

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

AutoScalingConfigurationTypeDef#

# 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 definition

class CapacityConfigurationTypeDef(TypedDict):
    nodeType: NotRequired[str],
    nodeCount: NotRequired[int],

ChangeRequestTypeDef#

# ChangeRequestTypeDef definition

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

CodeConfigurationTypeDef#

# CodeConfigurationTypeDef definition

class CodeConfigurationTypeDef(TypedDict):
    s3Bucket: NotRequired[str],
    s3Key: NotRequired[str],
    s3ObjectVersion: NotRequired[str],

FederationParametersTypeDef#

# 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 definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ErrorInfoTypeDef#

# ErrorInfoTypeDef definition

class ErrorInfoTypeDef(TypedDict):
    errorMessage: NotRequired[str],
    errorType: NotRequired[ErrorDetailsType],  # (1)
  1. See ErrorDetailsType

KxCacheStorageConfigurationTypeDef#

# KxCacheStorageConfigurationTypeDef definition

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

KxCommandLineArgumentTypeDef#

# KxCommandLineArgumentTypeDef definition

class KxCommandLineArgumentTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],

KxSavedownStorageConfigurationTypeDef#

# KxSavedownStorageConfigurationTypeDef definition

class KxSavedownStorageConfigurationTypeDef(TypedDict):
    type: NotRequired[KxSavedownStorageTypeType],  # (1)
    size: NotRequired[int],
    volumeName: NotRequired[str],
  1. See KxSavedownStorageTypeType

KxScalingGroupConfigurationTypeDef#

# KxScalingGroupConfigurationTypeDef definition

class KxScalingGroupConfigurationTypeDef(TypedDict):
    scalingGroupName: str,
    memoryReservation: int,
    nodeCount: int,
    memoryLimit: NotRequired[int],
    cpu: NotRequired[float],

TickerplantLogConfigurationTypeDef#

# TickerplantLogConfigurationTypeDef definition

class TickerplantLogConfigurationTypeDef(TypedDict):
    tickerplantLogVolumes: NotRequired[Sequence[str]],

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef definition

class VpcConfigurationTypeDef(TypedDict):
    vpcId: NotRequired[str],
    securityGroupIds: NotRequired[Sequence[str]],
    subnetIds: NotRequired[Sequence[str]],
    ipAddressType: NotRequired[IPAddressTypeType],  # (1)
  1. See IPAddressTypeType

VolumeTypeDef#

# VolumeTypeDef definition

class VolumeTypeDef(TypedDict):
    volumeName: NotRequired[str],
    volumeType: NotRequired[VolumeTypeType],  # (1)
  1. See VolumeTypeType

CreateKxDatabaseRequestRequestTypeDef#

# CreateKxDatabaseRequestRequestTypeDef definition

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

KxDataviewSegmentConfigurationTypeDef#

# KxDataviewSegmentConfigurationTypeDef definition

class KxDataviewSegmentConfigurationTypeDef(TypedDict):
    dbPaths: Sequence[str],
    volumeName: str,

CreateKxEnvironmentRequestRequestTypeDef#

# CreateKxEnvironmentRequestRequestTypeDef definition

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

CreateKxScalingGroupRequestRequestTypeDef#

# CreateKxScalingGroupRequestRequestTypeDef definition

class CreateKxScalingGroupRequestRequestTypeDef(TypedDict):
    clientToken: str,
    environmentId: str,
    scalingGroupName: str,
    hostType: str,
    availabilityZoneId: str,
    tags: NotRequired[Mapping[str, str]],

CreateKxUserRequestRequestTypeDef#

# CreateKxUserRequestRequestTypeDef definition

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

KxNAS1ConfigurationTypeDef#

# KxNAS1ConfigurationTypeDef definition

class KxNAS1ConfigurationTypeDef(TypedDict):
    type: NotRequired[KxNAS1TypeType],  # (1)
    size: NotRequired[int],
  1. See KxNAS1TypeType

CustomDNSServerTypeDef#

# CustomDNSServerTypeDef definition

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

DeleteEnvironmentRequestRequestTypeDef#

# DeleteEnvironmentRequestRequestTypeDef definition

class DeleteEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

DeleteKxClusterRequestRequestTypeDef#

# DeleteKxClusterRequestRequestTypeDef definition

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

DeleteKxDatabaseRequestRequestTypeDef#

# DeleteKxDatabaseRequestRequestTypeDef definition

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

DeleteKxDataviewRequestRequestTypeDef#

# DeleteKxDataviewRequestRequestTypeDef definition

class DeleteKxDataviewRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    clientToken: str,

DeleteKxEnvironmentRequestRequestTypeDef#

# DeleteKxEnvironmentRequestRequestTypeDef definition

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

DeleteKxScalingGroupRequestRequestTypeDef#

# DeleteKxScalingGroupRequestRequestTypeDef definition

class DeleteKxScalingGroupRequestRequestTypeDef(TypedDict):
    environmentId: str,
    scalingGroupName: str,
    clientToken: NotRequired[str],

DeleteKxUserRequestRequestTypeDef#

# DeleteKxUserRequestRequestTypeDef definition

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

DeleteKxVolumeRequestRequestTypeDef#

# DeleteKxVolumeRequestRequestTypeDef definition

class DeleteKxVolumeRequestRequestTypeDef(TypedDict):
    environmentId: str,
    volumeName: str,
    clientToken: NotRequired[str],

GetEnvironmentRequestRequestTypeDef#

# GetEnvironmentRequestRequestTypeDef definition

class GetEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

GetKxChangesetRequestRequestTypeDef#

# GetKxChangesetRequestRequestTypeDef definition

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

GetKxClusterRequestRequestTypeDef#

# GetKxClusterRequestRequestTypeDef definition

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

GetKxConnectionStringRequestRequestTypeDef#

# GetKxConnectionStringRequestRequestTypeDef definition

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

GetKxDatabaseRequestRequestTypeDef#

# GetKxDatabaseRequestRequestTypeDef definition

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

GetKxDataviewRequestRequestTypeDef#

# GetKxDataviewRequestRequestTypeDef definition

class GetKxDataviewRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    dataviewName: str,

GetKxEnvironmentRequestRequestTypeDef#

# GetKxEnvironmentRequestRequestTypeDef definition

class GetKxEnvironmentRequestRequestTypeDef(TypedDict):
    environmentId: str,

GetKxScalingGroupRequestRequestTypeDef#

# GetKxScalingGroupRequestRequestTypeDef definition

class GetKxScalingGroupRequestRequestTypeDef(TypedDict):
    environmentId: str,
    scalingGroupName: str,

GetKxUserRequestRequestTypeDef#

# GetKxUserRequestRequestTypeDef definition

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

GetKxVolumeRequestRequestTypeDef#

# GetKxVolumeRequestRequestTypeDef definition

class GetKxVolumeRequestRequestTypeDef(TypedDict):
    environmentId: str,
    volumeName: str,

KxAttachedClusterTypeDef#

# KxAttachedClusterTypeDef definition

class KxAttachedClusterTypeDef(TypedDict):
    clusterName: NotRequired[str],
    clusterType: NotRequired[KxClusterTypeType],  # (1)
    clusterStatus: NotRequired[KxClusterStatusType],  # (2)
  1. See KxClusterTypeType
  2. See KxClusterStatusType

IcmpTypeCodeTypeDef#

# IcmpTypeCodeTypeDef definition

class IcmpTypeCodeTypeDef(TypedDict):
    type: int,
    code: int,

KxChangesetListEntryTypeDef#

# KxChangesetListEntryTypeDef definition

class KxChangesetListEntryTypeDef(TypedDict):
    changesetId: NotRequired[str],
    createdTimestamp: NotRequired[datetime],
    activeFromTimestamp: NotRequired[datetime],
    lastModifiedTimestamp: NotRequired[datetime],
    status: NotRequired[ChangesetStatusType],  # (1)
  1. See ChangesetStatusType

KxClusterCodeDeploymentConfigurationTypeDef#

# KxClusterCodeDeploymentConfigurationTypeDef definition

class KxClusterCodeDeploymentConfigurationTypeDef(TypedDict):
    deploymentStrategy: KxClusterCodeDeploymentStrategyType,  # (1)
  1. See KxClusterCodeDeploymentStrategyType

KxDatabaseCacheConfigurationTypeDef#

# KxDatabaseCacheConfigurationTypeDef definition

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

KxDatabaseListEntryTypeDef#

# KxDatabaseListEntryTypeDef definition

class KxDatabaseListEntryTypeDef(TypedDict):
    databaseName: NotRequired[str],
    createdTimestamp: NotRequired[datetime],
    lastModifiedTimestamp: NotRequired[datetime],

KxDeploymentConfigurationTypeDef#

# KxDeploymentConfigurationTypeDef definition

class KxDeploymentConfigurationTypeDef(TypedDict):
    deploymentStrategy: KxDeploymentStrategyType,  # (1)
  1. See KxDeploymentStrategyType

KxNodeTypeDef#

# KxNodeTypeDef definition

class KxNodeTypeDef(TypedDict):
    nodeId: NotRequired[str],
    availabilityZoneId: NotRequired[str],
    launchTime: NotRequired[datetime],

KxScalingGroupTypeDef#

# 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],
    createdTimestamp: NotRequired[datetime],
  1. See KxScalingGroupStatusType

KxUserTypeDef#

# KxUserTypeDef definition

class KxUserTypeDef(TypedDict):
    userArn: NotRequired[str],
    userName: NotRequired[str],
    iamRole: NotRequired[str],
    createTimestamp: NotRequired[datetime],
    updateTimestamp: NotRequired[datetime],

KxVolumeTypeDef#

# 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],
    lastModifiedTimestamp: NotRequired[datetime],
  1. See KxVolumeTypeType
  2. See KxVolumeStatusType
  3. See KxAzModeType

ListEnvironmentsRequestRequestTypeDef#

# ListEnvironmentsRequestRequestTypeDef definition

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

ListKxChangesetsRequestRequestTypeDef#

# ListKxChangesetsRequestRequestTypeDef definition

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

ListKxClusterNodesRequestRequestTypeDef#

# ListKxClusterNodesRequestRequestTypeDef definition

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

ListKxClustersRequestRequestTypeDef#

# ListKxClustersRequestRequestTypeDef definition

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

ListKxDatabasesRequestRequestTypeDef#

# ListKxDatabasesRequestRequestTypeDef definition

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

ListKxDataviewsRequestRequestTypeDef#

# ListKxDataviewsRequestRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListKxEnvironmentsRequestRequestTypeDef#

# ListKxEnvironmentsRequestRequestTypeDef definition

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

ListKxScalingGroupsRequestRequestTypeDef#

# ListKxScalingGroupsRequestRequestTypeDef definition

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

ListKxUsersRequestRequestTypeDef#

# ListKxUsersRequestRequestTypeDef definition

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

ListKxVolumesRequestRequestTypeDef#

# ListKxVolumesRequestRequestTypeDef definition

class ListKxVolumesRequestRequestTypeDef(TypedDict):
    environmentId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    volumeType: NotRequired[KxVolumeTypeType],  # (1)
  1. See KxVolumeTypeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

PortRangeTypeDef#

# PortRangeTypeDef definition

class PortRangeTypeDef(TypedDict):
    from: int,
    to: int,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateKxDatabaseRequestRequestTypeDef#