Type definitions#
Auto-generated documentation for finspace type annotations stubs module types-aiobotocore-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],
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],
- 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)
- 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: KxSavedownStorageTypeType, # (1)
size: int,
VpcConfigurationTypeDef#
# VpcConfigurationTypeDef definition
class VpcConfigurationTypeDef(TypedDict):
vpcId: NotRequired[str],
securityGroupIds: NotRequired[Sequence[str]],
subnetIds: NotRequired[Sequence[str]],
ipAddressType: NotRequired[IPAddressTypeType], # (1)
CreateKxDatabaseRequestRequestTypeDef#
# CreateKxDatabaseRequestRequestTypeDef definition
class CreateKxDatabaseRequestRequestTypeDef(TypedDict):
environmentId: str,
databaseName: str,
clientToken: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateKxEnvironmentRequestRequestTypeDef#
# CreateKxEnvironmentRequestRequestTypeDef definition
class CreateKxEnvironmentRequestRequestTypeDef(TypedDict):
name: str,
kmsKeyId: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
CreateKxUserRequestRequestTypeDef#
# CreateKxUserRequestRequestTypeDef definition
class CreateKxUserRequestRequestTypeDef(TypedDict):
environmentId: str,
userName: str,
iamRole: str,
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
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,
DeleteKxEnvironmentRequestRequestTypeDef#
# DeleteKxEnvironmentRequestRequestTypeDef definition
class DeleteKxEnvironmentRequestRequestTypeDef(TypedDict):
environmentId: str,
DeleteKxUserRequestRequestTypeDef#
# DeleteKxUserRequestRequestTypeDef definition
class DeleteKxUserRequestRequestTypeDef(TypedDict):
userName: str,
environmentId: 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,
GetKxEnvironmentRequestRequestTypeDef#
# GetKxEnvironmentRequestRequestTypeDef definition
class GetKxEnvironmentRequestRequestTypeDef(TypedDict):
environmentId: str,
TransitGatewayConfigurationTypeDef#
# TransitGatewayConfigurationTypeDef definition
class TransitGatewayConfigurationTypeDef(TypedDict):
transitGatewayID: str,
routableCIDRSpace: str,
GetKxUserRequestRequestTypeDef#
# GetKxUserRequestRequestTypeDef definition
class GetKxUserRequestRequestTypeDef(TypedDict):
userName: str,
environmentId: str,
KxChangesetListEntryTypeDef#
# KxChangesetListEntryTypeDef definition
class KxChangesetListEntryTypeDef(TypedDict):
changesetId: NotRequired[str],
createdTimestamp: NotRequired[datetime],
activeFromTimestamp: NotRequired[datetime],
lastModifiedTimestamp: NotRequired[datetime],
status: NotRequired[ChangesetStatusType], # (1)
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],
initializationScript: NotRequired[str],
executionRole: NotRequired[str],
azMode: NotRequired[KxAzModeType], # (3)
availabilityZoneId: NotRequired[str],
lastModifiedTimestamp: NotRequired[datetime],
createdTimestamp: NotRequired[datetime],
- See KxClusterStatusType
- See KxClusterTypeType
- See KxAzModeType
KxDatabaseCacheConfigurationTypeDef#
# KxDatabaseCacheConfigurationTypeDef definition
class KxDatabaseCacheConfigurationTypeDef(TypedDict):
cacheType: str,
dbPaths: Sequence[str],
KxDatabaseListEntryTypeDef#
# KxDatabaseListEntryTypeDef definition
class KxDatabaseListEntryTypeDef(TypedDict):
databaseName: NotRequired[str],
createdTimestamp: NotRequired[datetime],
lastModifiedTimestamp: NotRequired[datetime],
KxNodeTypeDef#
# KxNodeTypeDef definition
class KxNodeTypeDef(TypedDict):
nodeId: NotRequired[str],
availabilityZoneId: NotRequired[str],
launchTime: NotRequired[datetime],
KxUserTypeDef#
# KxUserTypeDef definition
class KxUserTypeDef(TypedDict):
userArn: NotRequired[str],
userName: NotRequired[str],
iamRole: NotRequired[str],
createTimestamp: NotRequired[datetime],
updateTimestamp: NotRequired[datetime],
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],
ListKxDatabasesRequestRequestTypeDef#
# ListKxDatabasesRequestRequestTypeDef definition
class ListKxDatabasesRequestRequestTypeDef(TypedDict):
environmentId: 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],
ListKxUsersRequestRequestTypeDef#
# ListKxUsersRequestRequestTypeDef definition
class ListKxUsersRequestRequestTypeDef(TypedDict):
environmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
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,
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[FederationParametersTypeDef], # (3)
UpdateEnvironmentRequestRequestTypeDef#
# UpdateEnvironmentRequestRequestTypeDef definition
class UpdateEnvironmentRequestRequestTypeDef(TypedDict):
environmentId: str,
name: NotRequired[str],
description: NotRequired[str],
federationMode: NotRequired[FederationModeType], # (1)
federationParameters: NotRequired[FederationParametersTypeDef], # (2)
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]],
CreateEnvironmentResponseTypeDef#
# CreateEnvironmentResponseTypeDef definition
class CreateEnvironmentResponseTypeDef(TypedDict):
environmentId: str,
environmentArn: str,
environmentUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateKxDatabaseResponseTypeDef#
# CreateKxDatabaseResponseTypeDef definition
class CreateKxDatabaseResponseTypeDef(TypedDict):
databaseName: str,
databaseArn: str,
environmentId: str,
description: str,
createdTimestamp: datetime,
lastModifiedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateKxEnvironmentResponseTypeDef#
# CreateKxEnvironmentResponseTypeDef definition
class CreateKxEnvironmentResponseTypeDef(TypedDict):
name: str,
status: EnvironmentStatusType, # (1)
environmentId: str,
description: str,
environmentArn: str,
kmsKeyId: str,
creationTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateKxUserResponseTypeDef#
# CreateKxUserResponseTypeDef definition
class CreateKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetKxConnectionStringResponseTypeDef#
# GetKxConnectionStringResponseTypeDef definition
class GetKxConnectionStringResponseTypeDef(TypedDict):
signedConnectionString: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
GetKxUserResponseTypeDef#
# GetKxUserResponseTypeDef definition
class GetKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateKxDatabaseResponseTypeDef#
# UpdateKxDatabaseResponseTypeDef definition
class UpdateKxDatabaseResponseTypeDef(TypedDict):
databaseName: str,
environmentId: str,
description: str,
lastModifiedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateKxUserResponseTypeDef#
# UpdateKxUserResponseTypeDef definition
class UpdateKxUserResponseTypeDef(TypedDict):
userName: str,
userArn: str,
environmentId: str,
iamRole: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
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)
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: TransitGatewayConfigurationTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime,
updateTimestamp: datetime,
availabilityZoneIds: List[str],
certificateAuthorityArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See EnvironmentStatusType
- See tgwStatusType
- See dnsStatusType
- See TransitGatewayConfigurationTypeDef
- See CustomDNSServerTypeDef
- 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[TransitGatewayConfigurationTypeDef], # (4)
customDNSConfiguration: NotRequired[List[CustomDNSServerTypeDef]], # (5)
creationTimestamp: NotRequired[datetime],
updateTimestamp: NotRequired[datetime],
availabilityZoneIds: NotRequired[List[str]],
certificateAuthorityArn: NotRequired[str],
- See EnvironmentStatusType
- See tgwStatusType
- See dnsStatusType
- See TransitGatewayConfigurationTypeDef
- See CustomDNSServerTypeDef
UpdateKxEnvironmentNetworkRequestRequestTypeDef#
# UpdateKxEnvironmentNetworkRequestRequestTypeDef definition
class UpdateKxEnvironmentNetworkRequestRequestTypeDef(TypedDict):
environmentId: str,
transitGatewayConfiguration: NotRequired[TransitGatewayConfigurationTypeDef], # (1)
customDNSConfiguration: NotRequired[Sequence[CustomDNSServerTypeDef]], # (2)
clientToken: NotRequired[str],
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: TransitGatewayConfigurationTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime,
updateTimestamp: datetime,
availabilityZoneIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See EnvironmentStatusType
- See tgwStatusType
- See dnsStatusType
- See TransitGatewayConfigurationTypeDef
- See CustomDNSServerTypeDef
- 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: TransitGatewayConfigurationTypeDef, # (4)
customDNSConfiguration: List[CustomDNSServerTypeDef], # (5)
creationTimestamp: datetime,
updateTimestamp: datetime,
availabilityZoneIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See EnvironmentStatusType
- See tgwStatusType
- See dnsStatusType
- See TransitGatewayConfigurationTypeDef
- See CustomDNSServerTypeDef
- See ResponseMetadataTypeDef
ListKxChangesetsResponseTypeDef#
# ListKxChangesetsResponseTypeDef definition
class ListKxChangesetsResponseTypeDef(TypedDict):
kxChangesets: List[KxChangesetListEntryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKxClustersResponseTypeDef#
# ListKxClustersResponseTypeDef definition
class ListKxClustersResponseTypeDef(TypedDict):
kxClusterSummaries: List[KxClusterTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
KxDatabaseConfigurationTypeDef#
# KxDatabaseConfigurationTypeDef definition
class KxDatabaseConfigurationTypeDef(TypedDict):
databaseName: str,
cacheConfigurations: NotRequired[Sequence[KxDatabaseCacheConfigurationTypeDef]], # (1)
changesetId: NotRequired[str],
ListKxDatabasesResponseTypeDef#
# ListKxDatabasesResponseTypeDef definition
class ListKxDatabasesResponseTypeDef(TypedDict):
kxDatabases: List[KxDatabaseListEntryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKxClusterNodesResponseTypeDef#
# ListKxClusterNodesResponseTypeDef definition
class ListKxClusterNodesResponseTypeDef(TypedDict):
nodes: List[KxNodeTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KxNodeTypeDef
- See ResponseMetadataTypeDef
ListKxUsersResponseTypeDef#
# ListKxUsersResponseTypeDef definition
class ListKxUsersResponseTypeDef(TypedDict):
users: List[KxUserTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KxUserTypeDef
- See ResponseMetadataTypeDef
ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef#
# ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef definition
class ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetEnvironmentResponseTypeDef#
# GetEnvironmentResponseTypeDef definition
class GetEnvironmentResponseTypeDef(TypedDict):
environment: EnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEnvironmentsResponseTypeDef#
# ListEnvironmentsResponseTypeDef definition
class ListEnvironmentsResponseTypeDef(TypedDict):
environments: List[EnvironmentTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateEnvironmentResponseTypeDef#
# UpdateEnvironmentResponseTypeDef definition
class UpdateEnvironmentResponseTypeDef(TypedDict):
environment: EnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKxEnvironmentsResponseTypeDef#
# ListKxEnvironmentsResponseTypeDef definition
class ListKxEnvironmentsResponseTypeDef(TypedDict):
environments: List[KxEnvironmentTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateKxClusterRequestRequestTypeDef#
# 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]],
- See KxClusterTypeType
- See CapacityConfigurationTypeDef
- See KxAzModeType
- See KxDatabaseConfigurationTypeDef
- See KxCacheStorageConfigurationTypeDef
- See AutoScalingConfigurationTypeDef
- See VpcConfigurationTypeDef
- See KxCommandLineArgumentTypeDef
- See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
CreateKxClusterResponseTypeDef#
# 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)
- See KxClusterStatusType
- See KxClusterTypeType
- See KxDatabaseConfigurationTypeDef
- See KxCacheStorageConfigurationTypeDef
- See AutoScalingConfigurationTypeDef
- See CapacityConfigurationTypeDef
- See VpcConfigurationTypeDef
- See KxCommandLineArgumentTypeDef
- See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See KxAzModeType
- See ResponseMetadataTypeDef
GetKxClusterResponseTypeDef#
# 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)
- See KxClusterStatusType
- See KxClusterTypeType
- See KxDatabaseConfigurationTypeDef
- See KxCacheStorageConfigurationTypeDef
- See AutoScalingConfigurationTypeDef
- See CapacityConfigurationTypeDef
- See VpcConfigurationTypeDef
- See KxCommandLineArgumentTypeDef
- See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See KxAzModeType
- See ResponseMetadataTypeDef
UpdateKxClusterDatabasesRequestRequestTypeDef#
# UpdateKxClusterDatabasesRequestRequestTypeDef definition
class UpdateKxClusterDatabasesRequestRequestTypeDef(TypedDict):
environmentId: str,
clusterName: str,
databases: Sequence[KxDatabaseConfigurationTypeDef], # (1)
clientToken: NotRequired[str],