FinSpaceDataClient

Index > FinSpaceData > FinSpaceDataClient

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

FinSpaceDataClient

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

# FinSpaceDataClient usage example

from boto3.session import Session
from mypy_boto3_finspace_data.client import FinSpaceDataClient

def get_finspace-data_client() -> FinSpaceDataClient:
    return Session().client("finspace-data")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("finspace-data")

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

# Exceptions.exceptions type checking example

from mypy_boto3_finspace_data.client import Exceptions

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

Methods

associate_user_to_permission_group

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

Type annotations and code completion for boto3.client("finspace-data").associate_user_to_permission_group method. boto3 documentation

# associate_user_to_permission_group method definition

def associate_user_to_permission_group(
    self,
    *,
    permissionGroupId: str,
    userId: str,
    clientToken: str = ...,
) -> AssociateUserToPermissionGroupResponseTypeDef:  # (1)
    ...

1. See AssociateUserToPermissionGroupResponseTypeDef

# associate_user_to_permission_group method usage example with argument unpacking

kwargs: AssociateUserToPermissionGroupRequestRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
    "userId": ...,
}

parent.associate_user_to_permission_group(**kwargs)

1. See AssociateUserToPermissionGroupRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("finspace-data").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-data").close method. boto3 documentation

# close method definition

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

create_changeset

Creates a new Changeset in a FinSpace Dataset.

Type annotations and code completion for boto3.client("finspace-data").create_changeset method. boto3 documentation

# create_changeset method definition

def create_changeset(
    self,
    *,
    datasetId: str,
    changeType: ChangeTypeType,  # (1)
    sourceParams: Mapping[str, str],
    formatParams: Mapping[str, str],
    clientToken: str = ...,
) -> CreateChangesetResponseTypeDef:  # (2)
    ...

1. See ChangeTypeType
2. See CreateChangesetResponseTypeDef

# create_changeset method usage example with argument unpacking

kwargs: CreateChangesetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "changeType": ...,
    "sourceParams": ...,
    "formatParams": ...,
}

parent.create_changeset(**kwargs)

1. See CreateChangesetRequestRequestTypeDef

create_data_view

Creates a Dataview for a Dataset.

Type annotations and code completion for boto3.client("finspace-data").create_data_view method. boto3 documentation

# create_data_view method definition

def create_data_view(
    self,
    *,
    datasetId: str,
    destinationTypeParams: Union[DataViewDestinationTypeParamsTypeDef, DataViewDestinationTypeParamsExtraOutputTypeDef],  # (1)
    clientToken: str = ...,
    autoUpdate: bool = ...,
    sortColumns: Sequence[str] = ...,
    partitionColumns: Sequence[str] = ...,
    asOfTimestamp: int = ...,
) -> CreateDataViewResponseTypeDef:  # (2)
    ...

1. See DataViewDestinationTypeParamsTypeDef DataViewDestinationTypeParamsExtraOutputTypeDef
2. See CreateDataViewResponseTypeDef

# create_data_view method usage example with argument unpacking

kwargs: CreateDataViewRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "destinationTypeParams": ...,
}

parent.create_data_view(**kwargs)

1. See CreateDataViewRequestRequestTypeDef

create_dataset

Creates a new FinSpace Dataset.

Type annotations and code completion for boto3.client("finspace-data").create_dataset method. boto3 documentation

# create_dataset method definition

def create_dataset(
    self,
    *,
    datasetTitle: str,
    kind: DatasetKindType,  # (1)
    permissionGroupParams: PermissionGroupParamsTypeDef,  # (2)
    clientToken: str = ...,
    datasetDescription: str = ...,
    ownerInfo: DatasetOwnerInfoTypeDef = ...,  # (3)
    alias: str = ...,
    schemaDefinition: Union[SchemaUnionTypeDef, SchemaUnionExtraOutputTypeDef] = ...,  # (4)
) -> CreateDatasetResponseTypeDef:  # (5)
    ...

1. See DatasetKindType
2. See PermissionGroupParamsTypeDef
3. See DatasetOwnerInfoTypeDef
4. See SchemaUnionTypeDef SchemaUnionExtraOutputTypeDef
5. See CreateDatasetResponseTypeDef

# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "datasetTitle": ...,
    "kind": ...,
    "permissionGroupParams": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestRequestTypeDef

create_permission_group

Creates a group of permissions for various actions that a user can perform in FinSpace.

Type annotations and code completion for boto3.client("finspace-data").create_permission_group method. bot