FinspaceClient

Index > Finspace > FinspaceClient

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

FinspaceClient

Type annotations and code completion for boto3.client("finspace"). boto3 documentation

# FinspaceClient usage example

from boto3.session import Session
from types_boto3_finspace.client import FinspaceClient

def get_finspace_client() -> FinspaceClient:
    return Session().client("finspace")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("finspace").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("finspace")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_finspace.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("finspace").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("finspace").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_environment

Create a new FinSpace environment.

Type annotations and code completion for boto3.client("finspace").create_environment method. boto3 documentation

# create_environment method definition

def create_environment(
    self,
    *,
    name: str,
    description: str = ...,
    kmsKeyId: str = ...,
    tags: Mapping[str, str] = ...,
    federationMode: FederationModeType = ...,  # (1)
    federationParameters: FederationParametersUnionTypeDef = ...,  # (2)
    superuserParameters: SuperuserParametersTypeDef = ...,  # (3)
    dataBundles: Sequence[str] = ...,
) -> CreateEnvironmentResponseTypeDef:  # (4)
    ...

1. See FederationModeType
2. See FederationParametersUnionTypeDef
3. See SuperuserParametersTypeDef
4. See CreateEnvironmentResponseTypeDef

# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_environment(**kwargs)

1. See CreateEnvironmentRequestTypeDef

create_kx_changeset

Creates a changeset for a kdb database.

Type annotations and code completion for boto3.client("finspace").create_kx_changeset method. boto3 documentation

# create_kx_changeset method definition

def create_kx_changeset(
    self,
    *,
    environmentId: str,
    databaseName: str,
    changeRequests: Sequence[ChangeRequestTypeDef],  # (1)
    clientToken: str,
) -> CreateKxChangesetResponseTypeDef:  # (2)
    ...

1. See Sequence[ChangeRequestTypeDef]
2. See CreateKxChangesetResponseTypeDef

# create_kx_changeset method usage example with argument unpacking

kwargs: CreateKxChangesetRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "changeRequests": ...,
    "clientToken": ...,
}

parent.create_kx_changeset(**kwargs)

1. See CreateKxChangesetRequestTypeDef

create_kx_cluster

Creates a new kdb cluster.

Type annotations and code completion for boto3.client("finspace").create_kx_cluster method. boto3 documentation

# create_kx_cluster method definition

def create_kx_cluster(
    self,
    *,
    environmentId: str,
    clusterName: str,
    clusterType: KxClusterTypeType,  # (1)
    releaseLabel: str,
    vpcConfiguration: VpcConfigurationUnionTypeDef,  # (2)
    azMode: KxAzModeType,  # (3)
    clientToken: str = ...,
    tickerplantLogConfiguration: TickerplantLogConfigurationUnionTypeDef = ...,  # (4)
    databases: Sequence[KxDatabaseConfigurationUnionTypeDef] = ...,  # (5)
    cacheStorageConfigurations: Sequence[KxCacheStorageConfigurationTypeDef] = ...,  # (6)
    autoScalingConfiguration: AutoScalingConfigurationTypeDef = ...,  # (7)
    clusterDescription: str = ...,
    capacityConfiguration: CapacityConfigurationTypeDef = ...,  # (8)
    initializationScript: str = ...,
    commandLineArguments: Sequence[KxCommandLineArgumentTypeDef] = ...,  # (9)
    code: CodeConfigurationTypeDef = ...,  # (10)
    executionRole: str = ...,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef = ...,  # (11)
    availabilityZoneId: str = ...,
    tags: Mapping[str, str] = ...,
    scalingGroupConfiguration: KxScalingGroupConfigurationTypeDef = ...,  # (12)
) -> CreateKxClusterResponseTypeDef:  # (13)
    ...

1. See KxClusterTypeType
2. See VpcConfigurationUnionTypeDef
3. See KxAzModeType
4. See TickerplantLogConfigurationUnionTypeDef
5. See Sequence[KxDatabaseConfigurationUnionTypeDef]
6. See Sequence[KxCacheStorageConfigurationTypeDef]
7. See AutoScalingConfigurationTypeDef
8. See CapacityConfigurationTypeDef
9. See Sequence[KxCommandLineArgumentTypeDef]
10. See CodeConfigurationTypeDef
11. See KxSavedownStorageConfigurationTypeDef
12. See KxScalingGroupConfigurationTypeDef
13. See CreateKxClusterResponseTypeDef

# create_kx_cluster method usage example with argument unpacking

kwargs: CreateKxClusterRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
    "clusterType": ...,
    "releaseLabel": ...,
    "vpcConfiguration": ...,
    "azMode": ...,
}

parent.create_kx_cluster(**kwargs)

1. See CreateKxClusterRequestTypeDef

create_kx_database

Creates a new kdb database in the environment.

Type annotations and code completion for boto3.client("finspace").create_kx_database method. boto3 documentation

# create_kx_database method definition

def create_kx_database(
    self,
    *,
    environmentId: str,
    databaseName: str,
    clientToken: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKxDatabaseResponseTypeDef:  # (1)
    ...

1. See CreateKxDatabaseResponseTypeDef

# create_kx_database method usage example with argument unpacking

kwargs: CreateKxDatabaseRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "clientToken": ...,
}

parent.create_kx_database(**kwargs)

1. See CreateKxDatabaseRequestTypeDef

create_kx_dataview

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.

Type annotations and code completion for boto3.client("finspace").create_kx_dataview method. boto3 documentation

# create_kx_dataview method definition

def create_kx_dataview(
    self,
    *,
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    azMode: KxAzModeType,  # (1)
    clientToken: str,
    availabilityZoneId: str = ...,
    changesetId: str = ...,
    segmentConfigurations: Sequence[KxDataviewSegmentConfigurationUnionTypeDef] = ...,  # (2)
    autoUpdate: bool = ...,
    readWrite: bool = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKxDataviewResponseTypeDef:  # (3)
    ...

1. See KxAzModeType
2. See Sequence[KxDataviewSegmentConfigurationUnionTypeDef]
3. See CreateKxDataviewResponseTypeDef

# create_kx_dataview method usage example with argument unpacking

kwargs: CreateKxDataviewRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "dataviewName": ...,
    "azMode": ...,
    "clientToken": ...,
}

parent.create_kx_dataview(**kwargs)

1. See CreateKxDataviewRequestTypeDef

create_kx_environment

Creates a managed kdb environment for the account.

Type annotations and code completion for boto3.client("finspace").create_kx_environment method. boto3 documentation

# create_kx_environment method definition

def create_kx_environment(
    self,
    *,
    name: str,
    kmsKeyId: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateKxEnvironmentResponseTypeDef:  # (1)
    ...

1. See CreateKxEnvironmentResponseTypeDef

# create_kx_environment method usage example with argument unpacking

kwargs: CreateKxEnvironmentRequestTypeDef = {  # (1)
    "name": ...,
    "kmsKeyId": ...,
}

parent.create_kx_environment(**kwargs)

1. See CreateKxEnvironmentRequestTypeDef

create_kx_scaling_group

Creates a new scaling group.

Type annotations and code completion for boto3.client("finspace").create_kx_scaling_group method. boto3 documentation

# create_kx_scaling_group method definition

def create_kx_scaling_group(
    self,
    *,
    clientToken: str,
    environmentId: str,
    scalingGroupName: str,
    hostType: str,
    availabilityZoneId: str,
    tags: Mapping[str, str] = ...,
) -> CreateKxScalingGroupResponseTypeDef:  # (1)
    ...

1. See CreateKxScalingGroupResponseTypeDef

# create_kx_scaling_group method usage example with argument unpacking

kwargs: CreateKxScalingGroupRequestTypeDef = {  # (1)
    "clientToken": ...,
    "environmentId": ...,
    "scalingGroupName": ...,
    "hostType": ...,
    "availabilityZoneId": ...,
}

parent.create_kx_scaling_group(**kwargs)

1. See CreateKxScalingGroupRequestTypeDef

create_kx_user

Creates a user in FinSpace kdb environment with an associated IAM role.

Type annotations and code completion for boto3.client("finspace").create_kx_user method. boto3 documentation

# create_kx_user method definition

def create_kx_user(
    self,
    *,
    environmentId: str,
    userName: str,
    iamRole: str,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateKxUserResponseTypeDef:  # (1)
    ...

1. See CreateKxUserResponseTypeDef

# create_kx_user method usage example with argument unpacking

kwargs: CreateKxUserRequestTypeDef = {  # (1)
    "environmentId": ...,
    "userName": ...,
    "iamRole": ...,
}

parent.create_kx_user(**kwargs)

1. See CreateKxUserRequestTypeDef

create_kx_volume

Creates a new volume with a specific amount of throughput and storage capacity.

Type annotations and code completion for boto3.client("finspace").create_kx_volume method. boto3 documentation

# create_kx_volume method definition

def create_kx_volume(
    self,
    *,
    environmentId: str,
    volumeType: KxVolumeTypeType,  # (1)
    volumeName: str,
    azMode: KxAzModeType,  # (2)
    availabilityZoneIds: Sequence[str],
    clientToken: str = ...,
    description: str = ...,
    nas1Configuration: KxNAS1ConfigurationTypeDef = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> CreateKxVolumeResponseTypeDef:  # (4)
    ...

1. See KxVolumeTypeType
2. See KxAzModeType
3. See KxNAS1ConfigurationTypeDef
4. See CreateKxVolumeResponseTypeDef

# create_kx_volume method usage example with argument unpacking

kwargs: CreateKxVolumeRequestTypeDef = {  # (1)
    "environmentId": ...,
    "volumeType": ...,
    "volumeName": ...,
    "azMode": ...,
    "availabilityZoneIds": ...,
}

parent.create_kx_volume(**kwargs)

1. See CreateKxVolumeRequestTypeDef

delete_environment

Delete an FinSpace environment.

Type annotations and code completion for boto3.client("finspace").delete_environment method. boto3 documentation

# delete_environment method definition

def delete_environment(
    self,
    *,
    environmentId: str,
) -> Dict[str, Any]:
    ...

# delete_environment method usage example with argument unpacking

kwargs: DeleteEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.delete_environment(**kwargs)

1. See DeleteEnvironmentRequestTypeDef

delete_kx_cluster

Deletes a kdb cluster.

Type annotations and code completion for boto3.client("finspace").delete_kx_cluster method. boto3 documentation

# delete_kx_cluster method definition

def delete_kx_cluster(
    self,
    *,
    environmentId: str,
    clusterName: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_kx_cluster method usage example with argument unpacking

kwargs: DeleteKxClusterRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
}

parent.delete_kx_cluster(**kwargs)

1. See DeleteKxClusterRequestTypeDef

delete_kx_cluster_node

Deletes the specified nodes from a cluster.

Type annotations and code completion for boto3.client("finspace").delete_kx_cluster_node method. boto3 documentation

# delete_kx_cluster_node method definition

def delete_kx_cluster_node(
    self,
    *,
    environmentId: str,
    clusterName: str,
    nodeId: str,
) -> Dict[str, Any]:
    ...

# delete_kx_cluster_node method usage example with argument unpacking

kwargs: DeleteKxClusterNodeRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
    "nodeId": ...,
}

parent.delete_kx_cluster_node(**kwargs)

1. See DeleteKxClusterNodeRequestTypeDef

delete_kx_database

Deletes the specified database and all of its associated data.

Type annotations and code completion for boto3.client("finspace").delete_kx_database method. boto3 documentation

# delete_kx_database method definition

def delete_kx_database(
    self,
    *,
    environmentId: str,
    databaseName: str,
    clientToken: str,
) -> Dict[str, Any]:
    ...

# delete_kx_database method usage example with argument unpacking

kwargs: DeleteKxDatabaseRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "clientToken": ...,
}

parent.delete_kx_database(**kwargs)

1. See DeleteKxDatabaseRequestTypeDef

delete_kx_dataview

Deletes the specified dataview.

Type annotations and code completion for boto3.client("finspace").delete_kx_dataview method. boto3 documentation

# delete_kx_dataview method definition

def delete_kx_dataview(
    self,
    *,
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    clientToken: str,
) -> Dict[str, Any]:
    ...

# delete_kx_dataview method usage example with argument unpacking

kwargs: DeleteKxDataviewRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "dataviewName": ...,
    "clientToken": ...,
}

parent.delete_kx_dataview(**kwargs)

1. See DeleteKxDataviewRequestTypeDef

delete_kx_environment

Deletes the kdb environment.

Type annotations and code completion for boto3.client("finspace").delete_kx_environment method. boto3 documentation

# delete_kx_environment method definition

def delete_kx_environment(
    self,
    *,
    environmentId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_kx_environment method usage example with argument unpacking

kwargs: DeleteKxEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.delete_kx_environment(**kwargs)

1. See DeleteKxEnvironmentRequestTypeDef

delete_kx_scaling_group

Deletes the specified scaling group.

Type annotations and code completion for boto3.client("finspace").delete_kx_scaling_group method. boto3 documentation

# delete_kx_scaling_group method definition

def delete_kx_scaling_group(
    self,
    *,
    environmentId: str,
    scalingGroupName: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_kx_scaling_group method usage example with argument unpacking

kwargs: DeleteKxScalingGroupRequestTypeDef = {  # (1)
    "environmentId": ...,
    "scalingGroupName": ...,
}

parent.delete_kx_scaling_group(**kwargs)

1. See DeleteKxScalingGroupRequestTypeDef

delete_kx_user

Deletes a user in the specified kdb environment.

Type annotations and code completion for boto3.client("finspace").delete_kx_user method. boto3 documentation

# delete_kx_user method definition

def delete_kx_user(
    self,
    *,
    userName: str,
    environmentId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_kx_user method usage example with argument unpacking

kwargs: DeleteKxUserRequestTypeDef = {  # (1)
    "userName": ...,
    "environmentId": ...,
}

parent.delete_kx_user(**kwargs)

1. See DeleteKxUserRequestTypeDef

delete_kx_volume

Deletes a volume.

Type annotations and code completion for boto3.client("finspace").delete_kx_volume method. boto3 documentation

# delete_kx_volume method definition

def delete_kx_volume(
    self,
    *,
    environmentId: str,
    volumeName: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_kx_volume method usage example with argument unpacking

kwargs: DeleteKxVolumeRequestTypeDef = {  # (1)
    "environmentId": ...,
    "volumeName": ...,
}

parent.delete_kx_volume(**kwargs)

1. See DeleteKxVolumeRequestTypeDef

get_environment

Returns the FinSpace environment object.

Type annotations and code completion for boto3.client("finspace").get_environment method. boto3 documentation

# get_environment method definition

def get_environment(
    self,
    *,
    environmentId: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...

1. See GetEnvironmentResponseTypeDef

# get_environment method usage example with argument unpacking

kwargs: GetEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.get_environment(**kwargs)

1. See GetEnvironmentRequestTypeDef

get_kx_changeset

Returns information about a kdb changeset.

Type annotations and code completion for boto3.client("finspace").get_kx_changeset method. boto3 documentation

# get_kx_changeset method definition

def get_kx_changeset(
    self,
    *,
    environmentId: str,
    databaseName: str,
    changesetId: str,
) -> GetKxChangesetResponseTypeDef:  # (1)
    ...

1. See GetKxChangesetResponseTypeDef

# get_kx_changeset method usage example with argument unpacking

kwargs: GetKxChangesetRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "changesetId": ...,
}

parent.get_kx_changeset(**kwargs)

1. See GetKxChangesetRequestTypeDef

get_kx_cluster

Retrieves information about a kdb cluster.

Type annotations and code completion for boto3.client("finspace").get_kx_cluster method. boto3 documentation

# get_kx_cluster method definition

def get_kx_cluster(
    self,
    *,
    environmentId: str,
    clusterName: str,
) -> GetKxClusterResponseTypeDef:  # (1)
    ...

1. See GetKxClusterResponseTypeDef

# get_kx_cluster method usage example with argument unpacking

kwargs: GetKxClusterRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
}

parent.get_kx_cluster(**kwargs)

1. See GetKxClusterRequestTypeDef

get_kx_connection_string

Retrieves a connection string for a user to connect to a kdb cluster.

Type annotations and code completion for boto3.client("finspace").get_kx_connection_string method. boto3 documentation

# get_kx_connection_string method definition

def get_kx_connection_string(
    self,
    *,
    userArn: str,
    environmentId: str,
    clusterName: str,
) -> GetKxConnectionStringResponseTypeDef:  # (1)
    ...

1. See GetKxConnectionStringResponseTypeDef

# get_kx_connection_string method usage example with argument unpacking

kwargs: GetKxConnectionStringRequestTypeDef = {  # (1)
    "userArn": ...,
    "environmentId": ...,
    "clusterName": ...,
}

parent.get_kx_connection_string(**kwargs)

1. See GetKxConnectionStringRequestTypeDef

get_kx_database

Returns database information for the specified environment ID.

Type annotations and code completion for boto3.client("finspace").get_kx_database method. boto3 documentation

# get_kx_database method definition

def get_kx_database(
    self,
    *,
    environmentId: str,
    databaseName: str,
) -> GetKxDatabaseResponseTypeDef:  # (1)
    ...

1. See GetKxDatabaseResponseTypeDef

# get_kx_database method usage example with argument unpacking

kwargs: GetKxDatabaseRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
}

parent.get_kx_database(**kwargs)

1. See GetKxDatabaseRequestTypeDef

get_kx_dataview

Retrieves details of the dataview.

Type annotations and code completion for boto3.client("finspace").get_kx_dataview method. boto3 documentation

# get_kx_dataview method definition

def get_kx_dataview(
    self,
    *,
    environmentId: str,
    databaseName: str,
    dataviewName: str,
) -> GetKxDataviewResponseTypeDef:  # (1)
    ...

1. See GetKxDataviewResponseTypeDef

# get_kx_dataview method usage example with argument unpacking

kwargs: GetKxDataviewRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "dataviewName": ...,
}

parent.get_kx_dataview(**kwargs)

1. See GetKxDataviewRequestTypeDef

get_kx_environment

Retrieves all the information for the specified kdb environment.

Type annotations and code completion for boto3.client("finspace").get_kx_environment method. boto3 documentation

# get_kx_environment method definition

def get_kx_environment(
    self,
    *,
    environmentId: str,
) -> GetKxEnvironmentResponseTypeDef:  # (1)
    ...

1. See GetKxEnvironmentResponseTypeDef

# get_kx_environment method usage example with argument unpacking

kwargs: GetKxEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.get_kx_environment(**kwargs)

1. See GetKxEnvironmentRequestTypeDef

get_kx_scaling_group

Retrieves details of a scaling group.

Type annotations and code completion for boto3.client("finspace").get_kx_scaling_group method. boto3 documentation

# get_kx_scaling_group method definition

def get_kx_scaling_group(
    self,
    *,
    environmentId: str,
    scalingGroupName: str,
) -> GetKxScalingGroupResponseTypeDef:  # (1)
    ...

1. See GetKxScalingGroupResponseTypeDef

# get_kx_scaling_group method usage example with argument unpacking

kwargs: GetKxScalingGroupRequestTypeDef = {  # (1)
    "environmentId": ...,
    "scalingGroupName": ...,
}

parent.get_kx_scaling_group(**kwargs)

1. See GetKxScalingGroupRequestTypeDef

get_kx_user

Retrieves information about the specified kdb user.

Type annotations and code completion for boto3.client("finspace").get_kx_user method. boto3 documentation

# get_kx_user method definition

def get_kx_user(
    self,
    *,
    userName: str,
    environmentId: str,
) -> GetKxUserResponseTypeDef:  # (1)
    ...

1. See GetKxUserResponseTypeDef

# get_kx_user method usage example with argument unpacking

kwargs: GetKxUserRequestTypeDef = {  # (1)
    "userName": ...,
    "environmentId": ...,
}

parent.get_kx_user(**kwargs)

1. See GetKxUserRequestTypeDef

get_kx_volume

Retrieves the information about the volume.

Type annotations and code completion for boto3.client("finspace").get_kx_volume method. boto3 documentation

# get_kx_volume method definition

def get_kx_volume(
    self,
    *,
    environmentId: str,
    volumeName: str,
) -> GetKxVolumeResponseTypeDef:  # (1)
    ...

1. See GetKxVolumeResponseTypeDef

# get_kx_volume method usage example with argument unpacking

kwargs: GetKxVolumeRequestTypeDef = {  # (1)
    "environmentId": ...,
    "volumeName": ...,
}

parent.get_kx_volume(**kwargs)

1. See GetKxVolumeRequestTypeDef

list_environments

A list of all of your FinSpace environments.

Type annotations and code completion for boto3.client("finspace").list_environments method. boto3 documentation

# list_environments method definition

def list_environments(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentsResponseTypeDef:  # (1)
    ...

1. See ListEnvironmentsResponseTypeDef

# list_environments method usage example with argument unpacking

kwargs: ListEnvironmentsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_environments(**kwargs)

1. See ListEnvironmentsRequestTypeDef

list_kx_changesets

Returns a list of all the changesets for a database.

Type annotations and code completion for boto3.client("finspace").list_kx_changesets method. boto3 documentation

# list_kx_changesets method definition

def list_kx_changesets(
    self,
    *,
    environmentId: str,
    databaseName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxChangesetsResponseTypeDef:  # (1)
    ...

1. See ListKxChangesetsResponseTypeDef

# list_kx_changesets method usage example with argument unpacking

kwargs: ListKxChangesetsRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
}

parent.list_kx_changesets(**kwargs)

1. See ListKxChangesetsRequestTypeDef

list_kx_cluster_nodes

Lists all the nodes in a kdb cluster.

Type annotations and code completion for boto3.client("finspace").list_kx_cluster_nodes method. boto3 documentation

# list_kx_cluster_nodes method definition

def list_kx_cluster_nodes(
    self,
    *,
    environmentId: str,
    clusterName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxClusterNodesResponseTypeDef:  # (1)
    ...

1. See ListKxClusterNodesResponseTypeDef

# list_kx_cluster_nodes method usage example with argument unpacking

kwargs: ListKxClusterNodesRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
}

parent.list_kx_cluster_nodes(**kwargs)

1. See ListKxClusterNodesRequestTypeDef

list_kx_clusters

Returns a list of clusters.

Type annotations and code completion for boto3.client("finspace").list_kx_clusters method. boto3 documentation

# list_kx_clusters method definition

def list_kx_clusters(
    self,
    *,
    environmentId: str,
    clusterType: KxClusterTypeType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListKxClustersResponseTypeDef:  # (2)
    ...

1. See KxClusterTypeType
2. See ListKxClustersResponseTypeDef

# list_kx_clusters method usage example with argument unpacking

kwargs: ListKxClustersRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_kx_clusters(**kwargs)

1. See ListKxClustersRequestTypeDef

list_kx_databases

Returns a list of all the databases in the kdb environment.

Type annotations and code completion for boto3.client("finspace").list_kx_databases method. boto3 documentation

# list_kx_databases method definition

def list_kx_databases(
    self,
    *,
    environmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxDatabasesResponseTypeDef:  # (1)
    ...

1. See ListKxDatabasesResponseTypeDef

# list_kx_databases method usage example with argument unpacking

kwargs: ListKxDatabasesRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_kx_databases(**kwargs)

1. See ListKxDatabasesRequestTypeDef

list_kx_dataviews

Returns a list of all the dataviews in the database.

Type annotations and code completion for boto3.client("finspace").list_kx_dataviews method. boto3 documentation

# list_kx_dataviews method definition

def list_kx_dataviews(
    self,
    *,
    environmentId: str,
    databaseName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxDataviewsResponseTypeDef:  # (1)
    ...

1. See ListKxDataviewsResponseTypeDef

# list_kx_dataviews method usage example with argument unpacking

kwargs: ListKxDataviewsRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
}

parent.list_kx_dataviews(**kwargs)

1. See ListKxDataviewsRequestTypeDef

list_kx_environments

Returns a list of kdb environments created in an account.

Type annotations and code completion for boto3.client("finspace").list_kx_environments method. boto3 documentation

# list_kx_environments method definition

def list_kx_environments(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxEnvironmentsResponseTypeDef:  # (1)
    ...

1. See ListKxEnvironmentsResponseTypeDef

# list_kx_environments method usage example with argument unpacking

kwargs: ListKxEnvironmentsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_kx_environments(**kwargs)

1. See ListKxEnvironmentsRequestTypeDef

list_kx_scaling_groups

Returns a list of scaling groups in a kdb environment.

Type annotations and code completion for boto3.client("finspace").list_kx_scaling_groups method. boto3 documentation

# list_kx_scaling_groups method definition

def list_kx_scaling_groups(
    self,
    *,
    environmentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListKxScalingGroupsResponseTypeDef:  # (1)
    ...

1. See ListKxScalingGroupsResponseTypeDef

# list_kx_scaling_groups method usage example with argument unpacking

kwargs: ListKxScalingGroupsRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_kx_scaling_groups(**kwargs)

1. See ListKxScalingGroupsRequestTypeDef

list_kx_users

Lists all the users in a kdb environment.

Type annotations and code completion for boto3.client("finspace").list_kx_users method. boto3 documentation

# list_kx_users method definition

def list_kx_users(
    self,
    *,
    environmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKxUsersResponseTypeDef:  # (1)
    ...

1. See ListKxUsersResponseTypeDef

# list_kx_users method usage example with argument unpacking

kwargs: ListKxUsersRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_kx_users(**kwargs)

1. See ListKxUsersRequestTypeDef

list_kx_volumes

Lists all the volumes in a kdb environment.

Type annotations and code completion for boto3.client("finspace").list_kx_volumes method. boto3 documentation

# list_kx_volumes method definition

def list_kx_volumes(
    self,
    *,
    environmentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    volumeType: KxVolumeTypeType = ...,  # (1)
) -> ListKxVolumesResponseTypeDef:  # (2)
    ...

1. See KxVolumeTypeType
2. See ListKxVolumesResponseTypeDef

# list_kx_volumes method usage example with argument unpacking

kwargs: ListKxVolumesRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_kx_volumes(**kwargs)

1. See ListKxVolumesRequestTypeDef

list_tags_for_resource

A list of all tags for a resource.

Type annotations and code completion for boto3.client("finspace").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

tag_resource

Adds metadata tags to a FinSpace resource.

Type annotations and code completion for boto3.client("finspace").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes metadata tags from a FinSpace resource.

Type annotations and code completion for boto3.client("finspace").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_environment

Update your FinSpace environment.

Type annotations and code completion for boto3.client("finspace").update_environment method. boto3 documentation

# update_environment method definition

def update_environment(
    self,
    *,
    environmentId: str,
    name: str = ...,
    description: str = ...,
    federationMode: FederationModeType = ...,  # (1)
    federationParameters: FederationParametersUnionTypeDef = ...,  # (2)
) -> UpdateEnvironmentResponseTypeDef:  # (3)
    ...

1. See FederationModeType
2. See FederationParametersUnionTypeDef
3. See UpdateEnvironmentResponseTypeDef

# update_environment method usage example with argument unpacking

kwargs: UpdateEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.update_environment(**kwargs)

1. See UpdateEnvironmentRequestTypeDef

update_kx_cluster_code_configuration

Allows you to update code configuration on a running cluster.

Type annotations and code completion for boto3.client("finspace").update_kx_cluster_code_configuration method. boto3 documentation

# update_kx_cluster_code_configuration method definition

def update_kx_cluster_code_configuration(
    self,
    *,
    environmentId: str,
    clusterName: str,
    code: CodeConfigurationTypeDef,  # (1)
    clientToken: str = ...,
    initializationScript: str = ...,
    commandLineArguments: Sequence[KxCommandLineArgumentTypeDef] = ...,  # (2)
    deploymentConfiguration: KxClusterCodeDeploymentConfigurationTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...

1. See CodeConfigurationTypeDef
2. See Sequence[KxCommandLineArgumentTypeDef]
3. See KxClusterCodeDeploymentConfigurationTypeDef

# update_kx_cluster_code_configuration method usage example with argument unpacking

kwargs: UpdateKxClusterCodeConfigurationRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
    "code": ...,
}

parent.update_kx_cluster_code_configuration(**kwargs)

1. See UpdateKxClusterCodeConfigurationRequestTypeDef

update_kx_cluster_databases

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.

Type annotations and code completion for boto3.client("finspace").update_kx_cluster_databases method. boto3 documentation

# update_kx_cluster_databases method definition

def update_kx_cluster_databases(
    self,
    *,
    environmentId: str,
    clusterName: str,
    databases: Sequence[KxDatabaseConfigurationUnionTypeDef],  # (1)
    clientToken: str = ...,
    deploymentConfiguration: KxDeploymentConfigurationTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See Sequence[KxDatabaseConfigurationUnionTypeDef]
2. See KxDeploymentConfigurationTypeDef

# update_kx_cluster_databases method usage example with argument unpacking

kwargs: UpdateKxClusterDatabasesRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
    "databases": ...,
}

parent.update_kx_cluster_databases(**kwargs)

1. See UpdateKxClusterDatabasesRequestTypeDef

update_kx_database

Updates information for the given kdb database.

Type annotations and code completion for boto3.client("finspace").update_kx_database method. boto3 documentation

# update_kx_database method definition

def update_kx_database(
    self,
    *,
    environmentId: str,
    databaseName: str,
    clientToken: str,
    description: str = ...,
) -> UpdateKxDatabaseResponseTypeDef:  # (1)
    ...

1. See UpdateKxDatabaseResponseTypeDef

# update_kx_database method usage example with argument unpacking

kwargs: UpdateKxDatabaseRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "clientToken": ...,
}

parent.update_kx_database(**kwargs)

1. See UpdateKxDatabaseRequestTypeDef

update_kx_dataview

Updates the specified dataview.

Type annotations and code completion for boto3.client("finspace").update_kx_dataview method. boto3 documentation

# update_kx_dataview method definition

def update_kx_dataview(
    self,
    *,
    environmentId: str,
    databaseName: str,
    dataviewName: str,
    clientToken: str,
    description: str = ...,
    changesetId: str = ...,
    segmentConfigurations: Sequence[KxDataviewSegmentConfigurationUnionTypeDef] = ...,  # (1)
) -> UpdateKxDataviewResponseTypeDef:  # (2)
    ...

1. See Sequence[KxDataviewSegmentConfigurationUnionTypeDef]
2. See UpdateKxDataviewResponseTypeDef

# update_kx_dataview method usage example with argument unpacking

kwargs: UpdateKxDataviewRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "dataviewName": ...,
    "clientToken": ...,
}

parent.update_kx_dataview(**kwargs)

1. See UpdateKxDataviewRequestTypeDef

update_kx_environment

Updates information for the given kdb environment.

Type annotations and code completion for boto3.client("finspace").update_kx_environment method. boto3 documentation

# update_kx_environment method definition

def update_kx_environment(
    self,
    *,
    environmentId: str,
    name: str = ...,
    description: str = ...,
    clientToken: str = ...,
) -> UpdateKxEnvironmentResponseTypeDef:  # (1)
    ...

1. See UpdateKxEnvironmentResponseTypeDef

# update_kx_environment method usage example with argument unpacking

kwargs: UpdateKxEnvironmentRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.update_kx_environment(**kwargs)

1. See UpdateKxEnvironmentRequestTypeDef

update_kx_environment_network

Updates environment network to connect to your internal network by using a transit gateway.

Type annotations and code completion for boto3.client("finspace").update_kx_environment_network method. boto3 documentation

# update_kx_environment_network method definition

def update_kx_environment_network(
    self,
    *,
    environmentId: str,
    transitGatewayConfiguration: TransitGatewayConfigurationUnionTypeDef = ...,  # (1)
    customDNSConfiguration: Sequence[CustomDNSServerTypeDef] = ...,  # (2)
    clientToken: str = ...,
) -> UpdateKxEnvironmentNetworkResponseTypeDef:  # (3)
    ...

1. See TransitGatewayConfigurationUnionTypeDef
2. See Sequence[CustomDNSServerTypeDef]
3. See UpdateKxEnvironmentNetworkResponseTypeDef

# update_kx_environment_network method usage example with argument unpacking

kwargs: UpdateKxEnvironmentNetworkRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.update_kx_environment_network(**kwargs)

1. See UpdateKxEnvironmentNetworkRequestTypeDef

update_kx_user

Updates the user details.

Type annotations and code completion for boto3.client("finspace").update_kx_user method. boto3 documentation

# update_kx_user method definition

def update_kx_user(
    self,
    *,
    environmentId: str,
    userName: str,
    iamRole: str,
    clientToken: str = ...,
) -> UpdateKxUserResponseTypeDef:  # (1)
    ...

1. See UpdateKxUserResponseTypeDef

# update_kx_user method usage example with argument unpacking

kwargs: UpdateKxUserRequestTypeDef = {  # (1)
    "environmentId": ...,
    "userName": ...,
    "iamRole": ...,
}

parent.update_kx_user(**kwargs)

1. See UpdateKxUserRequestTypeDef

update_kx_volume

Updates the throughput or capacity of a volume.

Type annotations and code completion for boto3.client("finspace").update_kx_volume method. boto3 documentation

# update_kx_volume method definition

def update_kx_volume(
    self,
    *,
    environmentId: str,
    volumeName: str,
    description: str = ...,
    clientToken: str = ...,
    nas1Configuration: KxNAS1ConfigurationTypeDef = ...,  # (1)
) -> UpdateKxVolumeResponseTypeDef:  # (2)
    ...

1. See KxNAS1ConfigurationTypeDef
2. See UpdateKxVolumeResponseTypeDef

# update_kx_volume method usage example with argument unpacking

kwargs: UpdateKxVolumeRequestTypeDef = {  # (1)
    "environmentId": ...,
    "volumeName": ...,
}

parent.update_kx_volume(**kwargs)

1. See UpdateKxVolumeRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("finspace").get_paginator method with overloads.

• client.get_paginator("list_kx_environments") -> ListKxEnvironmentsPaginator