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)
    capacityConfiguration: CapacityConfigurationTypeDef,  # (2)
    releaseLabel: str,
    azMode: KxAzModeType,  # (3)
    clientToken: str = ...,
    databases: Sequence[KxDatabaseConfigurationTypeDef] = ...,  # (4)
    cacheStorageConfigurations: Sequence[KxCacheStorageConfigurationTypeDef] = ...,  # (5)
    autoScalingConfiguration: AutoScalingConfigurationTypeDef = ...,  # (6)
    clusterDescription: str = ...,
    vpcConfiguration: VpcConfigurationTypeDef = ...,  # (7)
    initializationScript: str = ...,
    commandLineArguments: Sequence[KxCommandLineArgumentTypeDef] = ...,  # (8)
    code: CodeConfigurationTypeDef = ...,  # (9)
    executionRole: str = ...,
    savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef = ...,  # (10)
    availabilityZoneId: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateKxClusterResponseTypeDef:  # (11)
    ...
  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
  11. See CreateKxClusterResponseTypeDef 
# create_kx_cluster method usage example with argument unpacking

kwargs: CreateKxClusterRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
    "clusterName": ...,
    "clusterType": ...,
    "capacityConfiguration": ...,
    "releaseLabel": ...,
    "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_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_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

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

parent.delete_environment(**kwargs)
  1. See DeleteEnvironmentRequestRequestTypeDef

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

parent.delete_kx_cluster(**kwargs)
  1. See DeleteKxClusterRequestRequestTypeDef

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

parent.delete_kx_database(**kwargs)
  1. See DeleteKxDatabaseRequestRequestTypeDef

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,
) -> Dict[str, Any]:
    ...
# delete_kx_environment method usage example with argument unpacking

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

parent.delete_kx_environment(**kwargs)
  1. See DeleteKxEnvironmentRequestRequestTypeDef

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,
) -> Dict[str, Any]:
    ...
# delete_kx_user method usage example with argument unpacking

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

parent.delete_kx_user(**kwargs)
  1. See DeleteKxUserRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

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

parent.get_environment(**kwargs)
  1. See GetEnvironmentRequestRequestTypeDef

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

parent.get_kx_changeset(**kwargs)
  1. See