Skip to content

finspaceClient#

Index > finspace > finspaceClient

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

finspaceClient#

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

# finspaceClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_finspace.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: FederationParametersTypeDef = ...,  # (2)
    superuserParameters: SuperuserParametersTypeDef = ...,  # (3)
    dataBundles: Sequence[str] = ...,
) -> CreateEnvironmentResponseTypeDef:  # (4)
    ...
  1. See FederationModeType
  2. See FederationParametersTypeDef
  3. See SuperuserParametersTypeDef
  4. See CreateEnvironmentResponseTypeDef
# create_environment method usage example with argument unpacking

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

parent.create_environment(**kwargs)
  1. See CreateEnvironmentRequestRequestTypeDef

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 ChangeRequestTypeDef
  2. See CreateKxChangesetResponseTypeDef
# create_kx_changeset method usage example with argument unpacking

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

parent.create_kx_changeset(**kwargs)
  1. See CreateKxChangesetRequestRequestTypeDef

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: VpcConfigurationTypeDef,  # (2)
    azMode: KxAzModeType,  # (3)
    clientToken: str = ...,
    tickerplantLogConfiguration: TickerplantLogConfigurationTypeDef = ...,  # (4)
    databases: Sequence[KxDatabaseConfigurationTypeDef] = ...,  # (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 VpcConfigurationTypeDef
  3. See KxAzModeType
  4. See TickerplantLogConfigurationTypeDef
  5. See KxDatabaseConfigurationTypeDef
  6. See KxCacheStorageConfigurationTypeDef
  7. See AutoScalingConfigurationTypeDef
  8. See CapacityConfigurationTypeDef
  9. See KxCommandLineArgumentTypeDef
  10. See CodeConfigurationTypeDef
  11. See KxSavedownStorageConfigurationTypeDef
  12. See KxScalingGroupConfigurationTypeDef
  13. See CreateKxClusterResponseTypeDef
# create_kx_cluster method usage example with argument unpacking

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

parent.create_kx_cluster(**kwargs)
  1. See CreateKxClusterRequestRequestTypeDef

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: CreateKxDatabaseRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
    "databaseName": ...,
    "clientToken": ...,
}

parent.create_kx_database(**kwargs)
  1. See CreateKxDatabaseRequestRequestTypeDef

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[KxDataviewSegmentConfigurationTypeDef] = ...,  # (2)
    autoUpdate: bool = ...,
    readWrite: bool = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKxDataviewResponseTypeDef:  # (3)
    ...
  1. See KxAzModeType
  2. See KxDataviewSegmentConfigurationTypeDef
  3. See CreateKxDataviewResponseTypeDef
# create_kx_dataview method usage example with argument unpacking

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

parent.create_kx_dataview(**kwargs)
  1. See CreateKxDataviewRequestRequestTypeDef

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: CreateKxEnvironmentRequestRequestTypeDef = {  # (1)
    "name": ...,
    "kmsKeyId": ...,
}

parent.create_kx_environment(**kwargs)
  1. See CreateKxEnvironmentRequestRequestTypeDef

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: CreateKxScalingGroupRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "environmentId": ...,
    "scalingGroupName": ...,
    "hostType": ...,
    "availabilityZoneId": ...,
}

parent.create_kx_scaling_group(**kwargs)
  1. See CreateKxScalingGroupRequestRequestTypeDef

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: CreateKxUserRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
    "userName": ...,
    "iamRole": ...,
}

parent.create_kx_user(**kwargs)
  1. See CreateKxUserRequestRequestTypeDef

create_kx_volume