Skip to content

Type definitions#

Index > Finspace > Type definitions

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

TickerplantLogConfigurationUnionTypeDef#

# TickerplantLogConfigurationUnionTypeDef definition

TickerplantLogConfigurationUnionTypeDef = Union[
    TickerplantLogConfigurationTypeDef,  # (1)
    TickerplantLogConfigurationOutputTypeDef,  # (2)
]
  1. See TickerplantLogConfigurationTypeDef
  2. See TickerplantLogConfigurationOutputTypeDef

VpcConfigurationUnionTypeDef#

# VpcConfigurationUnionTypeDef definition

VpcConfigurationUnionTypeDef = Union[
    VpcConfigurationTypeDef,  # (1)
    VpcConfigurationOutputTypeDef,  # (2)
]
  1. See VpcConfigurationTypeDef
  2. See VpcConfigurationOutputTypeDef

FederationParametersUnionTypeDef#

# FederationParametersUnionTypeDef definition

FederationParametersUnionTypeDef = Union[
    FederationParametersTypeDef,  # (1)
    FederationParametersOutputTypeDef,  # (2)
]
  1. See FederationParametersTypeDef
  2. See FederationParametersOutputTypeDef

KxDataviewSegmentConfigurationUnionTypeDef#

# KxDataviewSegmentConfigurationUnionTypeDef definition

KxDataviewSegmentConfigurationUnionTypeDef = Union[
    KxDataviewSegmentConfigurationTypeDef,  # (1)
    KxDataviewSegmentConfigurationOutputTypeDef,  # (2)
]
  1. See KxDataviewSegmentConfigurationTypeDef
  2. See KxDataviewSegmentConfigurationOutputTypeDef

KxDatabaseConfigurationUnionTypeDef#

# KxDatabaseConfigurationUnionTypeDef definition

KxDatabaseConfigurationUnionTypeDef = Union[
    KxDatabaseConfigurationTypeDef,  # (1)
    KxDatabaseConfigurationOutputTypeDef,  # (2)
]
  1. See KxDatabaseConfigurationTypeDef
  2. See KxDatabaseConfigurationOutputTypeDef

TransitGatewayConfigurationUnionTypeDef#

# TransitGatewayConfigurationUnionTypeDef definition

TransitGatewayConfigurationUnionTypeDef = Union[
    TransitGatewayConfigurationTypeDef,  # (1)
    TransitGatewayConfigurationExtraOutputTypeDef,  # (2)
]
  1. See TransitGatewayConfigurationTypeDef
  2. See TransitGatewayConfigurationExtraOutputTypeDef

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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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

TickerplantLogConfigurationOutputTypeDef#

# TickerplantLogConfigurationOutputTypeDef definition

class TickerplantLogConfigurationOutputTypeDef(TypedDict):
    tickerplantLogVolumes: NotRequired[List[str]],

VolumeTypeDef#

# VolumeTypeDef definition

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

VpcConfigurationOutputTypeDef#

# VpcConfigurationOutputTypeDef definition

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

CreateKxDatabaseRequestRequestTypeDef#

# CreateKxDatabaseRequestRequestTypeDef definition

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

KxDataviewSegmentConfigurationOutputTypeDef#

# KxDataviewSegmentConfigurationOutputTypeDef definition

class KxDataviewSegmentConfigurationOutputTypeDef(TypedDict):
    dbPaths: List[str],
    volumeName: str,
    onDemand: NotRequired[bool],

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,

DeleteKxClusterNodeRequestRequestTypeDef#

# DeleteKxClusterNodeRequestRequestTypeDef definition

class DeleteKxClusterNodeRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    nodeId: 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],

FederationParametersOutputTypeDef#

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

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

KxDatabaseCacheConfigurationOutputTypeDef#

# KxDatabaseCacheConfigurationOutputTypeDef definition

class KxDatabaseCacheConfigurationOutputTypeDef(TypedDict):
    cacheType: str,
    dbPaths: List[str],
    dataviewName: NotRequired[str],

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

KxDataviewSegmentConfigurationTypeDef#

# KxDataviewSegmentConfigurationTypeDef definition

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

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],
    status: NotRequired[KxNodeStatusType],  # (1)
  1. See KxNodeStatusType

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#

# UpdateKxDatabaseRequestRequestTypeDef definition

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

UpdateKxEnvironmentRequestRequestTypeDef#

# UpdateKxEnvironmentRequestRequestTypeDef definition

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

UpdateKxUserRequestRequestTypeDef#

# UpdateKxUserRequestRequestTypeDef definition

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

CreateKxChangesetRequestRequestTypeDef#

# CreateKxChangesetRequestRequestTypeDef definition

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

UpdateEnvironmentRequestRequestTypeDef#

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

CreateEnvironmentResponseTypeDef#

# CreateEnvironmentResponseTypeDef definition

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

CreateKxDatabaseResponseTypeDef#

# CreateKxDatabaseResponseTypeDef definition

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

CreateKxEnvironmentResponseTypeDef#

# 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

CreateKxScalingGroupResponseTypeDef#

# CreateKxScalingGroupResponseTypeDef definition

class CreateKxScalingGroupResponseTypeDef(TypedDict):
    environmentId: str,
    scalingGroupName: str,
    hostType: str,
    availabilityZoneId: str,
    status: KxScalingGroupStatusType,  # (1)
    lastModifiedTimestamp: datetime,
    createdTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxScalingGroupStatusType
  2. See ResponseMetadataTypeDef

CreateKxUserResponseTypeDef#

# CreateKxUserResponseTypeDef definition

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

GetKxConnectionStringResponseTypeDef#

# GetKxConnectionStringResponseTypeDef definition

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

GetKxDatabaseResponseTypeDef#

# 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

GetKxScalingGroupResponseTypeDef#

# GetKxScalingGroupResponseTypeDef definition

class GetKxScalingGroupResponseTypeDef(TypedDict):
    scalingGroupName: str,
    scalingGroupArn: str,
    hostType: str,
    clusters: List[str],
    availabilityZoneId: str,
    status: KxScalingGroupStatusType,  # (1)
    statusReason: str,
    lastModifiedTimestamp: datetime,
    createdTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxScalingGroupStatusType
  2. See ResponseMetadataTypeDef

GetKxUserResponseTypeDef#

# GetKxUserResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

UpdateKxDatabaseResponseTypeDef#

# UpdateKxDatabaseResponseTypeDef definition

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

UpdateKxUserResponseTypeDef#

# UpdateKxUserResponseTypeDef definition

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

CreateKxChangesetResponseTypeDef#

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

KxClusterTypeDef#

# 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],
    createdTimestamp: NotRequired[datetime],
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See VolumeTypeDef
  4. See KxAzModeType

CreateKxDataviewResponseTypeDef#

# 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,
    lastModifiedTimestamp: datetime,
    status: KxDataviewStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationOutputTypeDef
  3. See KxDataviewStatusType
  4. See ResponseMetadataTypeDef

KxDataviewActiveVersionTypeDef#

# KxDataviewActiveVersionTypeDef definition

class KxDataviewActiveVersionTypeDef(TypedDict):
    changesetId: NotRequired[str],
    segmentConfigurations: NotRequired[List[KxDataviewSegmentConfigurationOutputTypeDef]],  # (1)
    attachedClusters: NotRequired[List[str]],
    createdTimestamp: NotRequired[datetime],
    versionId: NotRequired[str],
  1. See KxDataviewSegmentConfigurationOutputTypeDef

KxDataviewConfigurationOutputTypeDef#

# KxDataviewConfigurationOutputTypeDef definition

class KxDataviewConfigurationOutputTypeDef(TypedDict):
    dataviewName: NotRequired[str],
    dataviewVersionId: NotRequired[str],
    changesetId: NotRequired[str],
    segmentConfigurations: NotRequired[List[KxDataviewSegmentConfigurationOutputTypeDef]],  # (1)
  1. See KxDataviewSegmentConfigurationOutputTypeDef

CreateKxVolumeRequestRequestTypeDef#

# CreateKxVolumeRequestRequestTypeDef definition

class CreateKxVolumeRequestRequestTypeDef(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]],
  1. See KxVolumeTypeType
  2. See KxAzModeType
  3. See KxNAS1ConfigurationTypeDef

CreateKxVolumeResponseTypeDef#

# 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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See KxVolumeTypeType
  2. See KxNAS1ConfigurationTypeDef
  3. See KxVolumeStatusType
  4. See KxAzModeType
  5. See ResponseMetadataTypeDef

UpdateKxVolumeRequestRequestTypeDef#

# UpdateKxVolumeRequestRequestTypeDef definition

class UpdateKxVolumeRequestRequestTypeDef(TypedDict):
    environmentId: str,
    volumeName: str,
    description: NotRequired[str],
    clientToken: NotRequired[str],
    nas1Configuration: NotRequired[KxNAS1ConfigurationTypeDef],  # (1)
  1. See KxNAS1ConfigurationTypeDef

EnvironmentTypeDef#

# 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)
  1. See EnvironmentStatusType
  2. See FederationModeType
  3. See FederationParametersOutputTypeDef

GetKxVolumeResponseTypeDef#

# GetKxVolumeResponseTypeDef definition

class GetKxVolumeResponseTypeDef(TypedDict):
    environmentId: str,
    volumeName: str,
    volumeType: KxVolumeTypeType,  # (1)
    volumeArn: str,
    nas1Configuration: KxNAS1ConfigurationTypeDef,  # (2)
    status: KxVolumeStatusType,  # (3)
    statusReason: str,
    createdTimestamp: datetime,
    description: str,
    azMode: KxAzModeType,  # (4)
    availabilityZoneIds: List[str],
    lastModifiedTimestamp: datetime,
    attachedClusters: List[KxAttachedClusterTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See KxVolumeTypeType
  2. See KxNAS1ConfigurationTypeDef
  3. See KxVolumeStatusType
  4. See KxAzModeType
  5. See KxAttachedClusterTypeDef
  6. See ResponseMetadataTypeDef

UpdateKxVolumeResponseTypeDef#

# 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,
    azMode: KxAzModeType,  # (4)
    availabilityZoneIds: List[str],
    lastModifiedTimestamp: datetime,
    attachedClusters: List[KxAttachedClusterTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See KxVolumeTypeType
  2. See KxNAS1ConfigurationTypeDef
  3. See KxVolumeStatusType
  4. See KxAzModeType
  5. See KxAttachedClusterTypeDef
  6. See ResponseMetadataTypeDef

ListKxChangesetsResponseTypeDef#

# ListKxChangesetsResponseTypeDef definition

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

UpdateKxClusterCodeConfigurationRequestRequestTypeDef#

# UpdateKxClusterCodeConfigurationRequestRequestTypeDef definition

class UpdateKxClusterCodeConfigurationRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    code: CodeConfigurationTypeDef,  # (1)
    clientToken: NotRequired[str],
    initializationScript: NotRequired[str],
    commandLineArguments: NotRequired[Sequence[KxCommandLineArgumentTypeDef]],  # (2)
    deploymentConfiguration: NotRequired[KxClusterCodeDeploymentConfigurationTypeDef],  # (3)
  1. See CodeConfigurationTypeDef
  2. See KxCommandLineArgumentTypeDef
  3. See KxClusterCodeDeploymentConfigurationTypeDef

ListKxDatabasesResponseTypeDef#

# ListKxDatabasesResponseTypeDef definition

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

KxDataviewConfigurationTypeDef#

# KxDataviewConfigurationTypeDef definition

class KxDataviewConfigurationTypeDef(TypedDict):
    dataviewName: NotRequired[str],
    dataviewVersionId: NotRequired[str],
    changesetId: NotRequired[str],
    segmentConfigurations: NotRequired[Sequence[KxDataviewSegmentConfigurationTypeDef]],  # (1)
  1. See KxDataviewSegmentConfigurationTypeDef

ListKxClusterNodesResponseTypeDef#

# ListKxClusterNodesResponseTypeDef definition

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

ListKxScalingGroupsResponseTypeDef#

# ListKxScalingGroupsResponseTypeDef definition

class ListKxScalingGroupsResponseTypeDef(TypedDict):
    scalingGroups: List[KxScalingGroupTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxScalingGroupTypeDef
  2. See ResponseMetadataTypeDef

ListKxUsersResponseTypeDef#

# ListKxUsersResponseTypeDef definition

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

ListKxVolumesResponseTypeDef#

# ListKxVolumesResponseTypeDef definition

class ListKxVolumesResponseTypeDef(TypedDict):
    kxVolumeSummaries: List[KxVolumeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxVolumeTypeDef
  2. See ResponseMetadataTypeDef

ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef#

# ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef definition

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

NetworkACLEntryTypeDef#

# NetworkACLEntryTypeDef definition

class NetworkACLEntryTypeDef(TypedDict):
    ruleNumber: int,
    protocol: str,
    ruleAction: RuleActionType,  # (1)
    cidrBlock: str,
    portRange: NotRequired[PortRangeTypeDef],  # (2)
    icmpTypeCode: NotRequired[IcmpTypeCodeTypeDef],  # (3)
  1. See RuleActionType
  2. See PortRangeTypeDef
  3. See IcmpTypeCodeTypeDef

ListKxClustersResponseTypeDef#

# ListKxClustersResponseTypeDef definition

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

GetKxDataviewResponseTypeDef#

# 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,
    lastModifiedTimestamp: datetime,
    status: KxDataviewStatusType,  # (4)
    statusReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationOutputTypeDef
  3. See KxDataviewActiveVersionTypeDef
  4. See KxDataviewStatusType
  5. See ResponseMetadataTypeDef

KxDataviewListEntryTypeDef#

# 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],
    lastModifiedTimestamp: NotRequired[datetime],
    statusReason: NotRequired[str],
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationOutputTypeDef
  3. See KxDataviewActiveVersionTypeDef
  4. See KxDataviewStatusType

UpdateKxDataviewResponseTypeDef#

# 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,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationOutputTypeDef
  3. See KxDataviewActiveVersionTypeDef
  4. See KxDataviewStatusType
  5. See ResponseMetadataTypeDef

KxDatabaseConfigurationOutputTypeDef#

# KxDatabaseConfigurationOutputTypeDef definition

class KxDatabaseConfigurationOutputTypeDef(TypedDict):
    databaseName: str,
    cacheConfigurations: NotRequired[List[KxDatabaseCacheConfigurationOutputTypeDef]],  # (1)
    changesetId: NotRequired[str],
    dataviewName: NotRequired[str],
    dataviewConfiguration: NotRequired[KxDataviewConfigurationOutputTypeDef],  # (2)
  1. See KxDatabaseCacheConfigurationOutputTypeDef
  2. See KxDataviewConfigurationOutputTypeDef

GetEnvironmentResponseTypeDef#

# GetEnvironmentResponseTypeDef definition

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

ListEnvironmentsResponseTypeDef#

# ListEnvironmentsResponseTypeDef definition

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

UpdateEnvironmentResponseTypeDef#

# UpdateEnvironmentResponseTypeDef definition

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

KxDatabaseConfigurationTypeDef#

# KxDatabaseConfigurationTypeDef definition

class KxDatabaseConfigurationTypeDef(TypedDict):
    databaseName: str,
    cacheConfigurations: NotRequired[Sequence[KxDatabaseCacheConfigurationTypeDef]],  # (1)
    changesetId: NotRequired[str],
    dataviewName: NotRequired[str],
    dataviewConfiguration: NotRequired[KxDataviewConfigurationTypeDef],  # (2)
  1. See KxDatabaseCacheConfigurationTypeDef
  2. See KxDataviewConfigurationTypeDef

CreateKxDataviewRequestRequestTypeDef#

# CreateKxDataviewRequestRequestTypeDef definition

class CreateKxDataviewRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    azMode: KxAzModeType,  # (1)
    clientToken: str,
    availabilityZoneId: NotRequired[str],
    changesetId: NotRequired[str],
    segmentConfigurations: NotRequired[Sequence[Union[KxDataviewSegmentConfigurationTypeDef, KxDataviewSegmentConfigurationOutputTypeDef]]],  # (2)
    autoUpdate: NotRequired[bool],
    readWrite: NotRequired[bool],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationTypeDef KxDataviewSegmentConfigurationOutputTypeDef

UpdateKxDataviewRequestRequestTypeDef#

# UpdateKxDataviewRequestRequestTypeDef definition

class UpdateKxDataviewRequestRequestTypeDef(TypedDict):
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    clientToken: str,
    description: NotRequired[str],
    changesetId: NotRequired[str],
    segmentConfigurations: NotRequired[Sequence[Union[KxDataviewSegmentConfigurationTypeDef, KxDataviewSegmentConfigurationOutputTypeDef]]],  # (1)
  1. See KxDataviewSegmentConfigurationTypeDef KxDataviewSegmentConfigurationOutputTypeDef

TransitGatewayConfigurationExtraOutputTypeDef#

# TransitGatewayConfigurationExtraOutputTypeDef definition

class TransitGatewayConfigurationExtraOutputTypeDef(TypedDict):
    transitGatewayID: str,
    routableCIDRSpace: str,
    attachmentNetworkAclConfiguration: NotRequired[List[NetworkACLEntryTypeDef]],  # (1)
  1. See NetworkACLEntryTypeDef

TransitGatewayConfigurationOutputTypeDef#

# TransitGatewayConfigurationOutputTypeDef definition

class TransitGatewayConfigurationOutputTypeDef(TypedDict):
    transitGatewayID: str,
    routableCIDRSpace: str,
    attachmentNetworkAclConfiguration: NotRequired[List[NetworkACLEntryTypeDef]],  # (1)
  1. See NetworkACLEntryTypeDef

TransitGatewayConfigurationTypeDef#

# TransitGatewayConfigurationTypeDef definition

class TransitGatewayConfigurationTypeDef(TypedDict):
    transitGatewayID: str,
    routableCIDRSpace: str,
    attachmentNetworkAclConfiguration: NotRequired[Sequence[NetworkACLEntryTypeDef]],  # (1)
  1. See NetworkACLEntryTypeDef

ListKxDataviewsResponseTypeDef#

# ListKxDataviewsResponseTypeDef definition

class ListKxDataviewsResponseTypeDef(TypedDict):
    kxDataviews: List[KxDataviewListEntryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KxDataviewListEntryTypeDef
  2. See ResponseMetadataTypeDef

CreateKxClusterResponseTypeDef#

# 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,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef,  # (12)
    azMode: KxAzModeType,  # (13)
    availabilityZoneId: str,
    createdTimestamp: datetime,
    scalingGroupConfiguration: KxScalingGroupConfigurationTypeDef,  # (14)
    ResponseMetadata: ResponseMetadataTypeDef,  # (15)
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See TickerplantLogConfigurationOutputTypeDef
  4. See VolumeTypeDef
  5. See KxDatabaseConfigurationOutputTypeDef
  6. See KxCacheStorageConfigurationTypeDef
  7. See AutoScalingConfigurationTypeDef
  8. See CapacityConfigurationTypeDef
  9. See VpcConfigurationOutputTypeDef
  10. See KxCommandLineArgumentTypeDef
  11. See CodeConfigurationTypeDef
  12. See KxSavedownStorageConfigurationTypeDef
  13. See KxAzModeType
  14. See KxScalingGroupConfigurationTypeDef
  15. See ResponseMetadataTypeDef

GetKxClusterResponseTypeDef#

# 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,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef,  # (12)
    azMode: KxAzModeType,  # (13)
    availabilityZoneId: str,
    createdTimestamp: datetime,
    scalingGroupConfiguration: KxScalingGroupConfigurationTypeDef,  # (14)
    ResponseMetadata: ResponseMetadataTypeDef,  # (15)
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. See TickerplantLogConfigurationOutputTypeDef
  4. See VolumeTypeDef
  5. See KxDatabaseConfigurationOutputTypeDef
  6. See KxCacheStorageConfigurationTypeDef
  7. See AutoScalingConfigurationTypeDef
  8. See CapacityConfigurationTypeDef
  9. See VpcConfigurationOutputTypeDef
  10. See KxCommandLineArgumentTypeDef
  11. See CodeConfigurationTypeDef
  12. See KxSavedownStorageConfigurationTypeDef
  13. See KxAzModeType
  14. See KxScalingGroupConfigurationTypeDef
  15. See ResponseMetadataTypeDef

GetKxEnvironmentResponseTypeDef#

# 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,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    certificateAuthorityArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See TgwStatusType
  3. See DnsStatusType
  4. See TransitGatewayConfigurationOutputTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

KxEnvironmentTypeDef#

# 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],
    updateTimestamp: NotRequired[datetime],
    availabilityZoneIds: NotRequired[List[str]],
    certificateAuthorityArn: NotRequired[str],
  1. See EnvironmentStatusType
  2. See TgwStatusType
  3. See DnsStatusType
  4. See TransitGatewayConfigurationOutputTypeDef
  5. See CustomDNSServerTypeDef

UpdateKxEnvironmentNetworkResponseTypeDef#

# 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,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See TgwStatusType
  3. See DnsStatusType
  4. See TransitGatewayConfigurationOutputTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

UpdateKxEnvironmentResponseTypeDef#

# 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,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See TgwStatusType
  3. See DnsStatusType
  4. See TransitGatewayConfigurationOutputTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

UpdateKxEnvironmentNetworkRequestRequestTypeDef#

# 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

CreateKxClusterRequestRequestTypeDef#

# CreateKxClusterRequestRequestTypeDef definition

class CreateKxClusterRequestRequestTypeDef(TypedDict):
    environmentId: str,
    clusterName: str,
    clusterType: KxClusterTypeType,  # (1)
    releaseLabel: str,
    vpcConfiguration: VpcConfigurationTypeDef,  # (2)
    azMode: KxAzModeType,  # (3)
    clientToken: NotRequired[str],
    tickerplantLogConfiguration: NotRequired[TickerplantLogConfigurationTypeDef],  # (4)
    databases: NotRequired[Sequence[Union[KxDatabaseConfigurationTypeDef, KxDatabaseConfigurationOutputTypeDef]]],  # (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)
  1. See KxClusterTypeType
  2. See VpcConfigurationTypeDef
  3. See KxAzModeType
  4. See TickerplantLogConfigurationTypeDef
  5. See KxDatabaseConfigurationTypeDef KxDatabaseConfigurationOutputTypeDef
  6. See KxCacheStorageConfigurationTypeDef
  7. See AutoScalingConfigurationTypeDef
  8. See CapacityConfigurationTypeDef
  9. See KxCommandLineArgumentTypeDef
  10. See CodeConfigurationTypeDef
  11. See KxSavedownStorageConfigurationTypeDef
  12. See KxScalingGroupConfigurationTypeDef

UpdateKxClusterDatabasesRequestRequestTypeDef#

# UpdateKxClusterDatabasesRequestRequestTypeDef definition

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

ListKxEnvironmentsResponseTypeDef#

# ListKxEnvironmentsResponseTypeDef definition

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