Skip to content

Type definitions#

Index > finspace > 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],
  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: KxSavedownStorageTypeType,  # (1)
    size: int,
  1. See KxSavedownStorageTypeType

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef definition

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

CreateKxDatabaseRequestRequestTypeDef#

# CreateKxDatabaseRequestRequestTypeDef 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)
  1. See ChangesetStatusType

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],
  1. See KxClusterStatusType
  2. See KxClusterTypeType
  3. 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],
  1. See KxClusterTypeType

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,
  1. See ChangeRequestTypeDef

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

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

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

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

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

UpdateKxEnvironmentNetworkRequestRequestTypeDef#

# UpdateKxEnvironmentNetworkRequestRequestTypeDef definition

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

UpdateKxEnvironmentNetworkResponseTypeDef#

# UpdateKxEnvironmentNetworkResponseTypeDef definition

class UpdateKxEnvironmentNetworkResponseTypeDef(TypedDict):
    name: str,
    environmentId: str,
    awsAccountId: str,
    status: EnvironmentStatusType,  # (1)
    tgwStatus: tgwStatusType,  # (2)
    dnsStatus: dnsStatusType,  # (3)
    errorMessage: str,
    description: str,
    environmentArn: str,
    kmsKeyId: str,
    dedicatedServiceAccountId: str,
    transitGatewayConfiguration: TransitGatewayConfigurationTypeDef,  # (4)
    customDNSConfiguration: List[CustomDNSServerTypeDef],  # (5)
    creationTimestamp: datetime,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

UpdateKxEnvironmentResponseTypeDef#

# UpdateKxEnvironmentResponseTypeDef definition

class UpdateKxEnvironmentResponseTypeDef(TypedDict):
    name: str,
    environmentId: str,
    awsAccountId: str,
    status: EnvironmentStatusType,  # (1)
    tgwStatus: tgwStatusType,  # (2)
    dnsStatus: dnsStatusType,  # (3)
    errorMessage: str,
    description: str,
    environmentArn: str,
    kmsKeyId: str,
    dedicatedServiceAccountId: str,
    transitGatewayConfiguration: TransitGatewayConfigurationTypeDef,  # (4)
    customDNSConfiguration: List[CustomDNSServerTypeDef],  # (5)
    creationTimestamp: datetime,
    updateTimestamp: datetime,
    availabilityZoneIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See EnvironmentStatusType
  2. See tgwStatusType
  3. See dnsStatusType
  4. See TransitGatewayConfigurationTypeDef
  5. See CustomDNSServerTypeDef
  6. See ResponseMetadataTypeDef

ListKxChangesetsResponseTypeDef#

# ListKxChangesetsResponseTypeDef definition

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

ListKxClustersResponseTypeDef#

# ListKxClustersResponseTypeDef definition

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

KxDatabaseConfigurationTypeDef#

# KxDatabaseConfigurationTypeDef definition

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

ListKxDatabasesResponseTypeDef#

# ListKxDatabasesResponseTypeDef definition

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

ListKxClusterNodesResponseTypeDef#

# ListKxClusterNodesResponseTypeDef definition

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

ListKxUsersResponseTypeDef#

# ListKxUsersResponseTypeDef definition

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

ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef#

# ListKxEnvironmentsRequestListKxEnvironmentsPaginateTypeDef definition

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

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

ListKxEnvironmentsResponseTypeDef#

# ListKxEnvironmentsResponseTypeDef definition

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

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]],
  1. See KxClusterTypeType
  2. See CapacityConfigurationTypeDef
  3. See KxAzModeType
  4. See KxDatabaseConfigurationTypeDef
  5. See KxCacheStorageConfigurationTypeDef
  6. See AutoScalingConfigurationTypeDef
  7. See VpcConfigurationTypeDef
  8. See KxCommandLineArgumentTypeDef
  9. See CodeConfigurationTypeDef
  10. See KxSavedownStorageConfigurationTypeDef

CreateKxClusterResponseTypeDef#

# CreateKxClusterResponseTypeDef definition

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

GetKxClusterResponseTypeDef#

# GetKxClusterResponseTypeDef definition

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

UpdateKxClusterDatabasesRequestRequestTypeDef#

# UpdateKxClusterDatabasesRequestRequestTypeDef definition

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