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)
...
# associate_user_to_permission_group method usage example with argument unpacking
kwargs: AssociateUserToPermissionGroupRequestRequestTypeDef = { # (1)
"permissionGroupId": ...,
"userId": ...,
}
parent.associate_user_to_permission_group(**kwargs)
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)
...
# create_changeset method usage example with argument unpacking
kwargs: CreateChangesetRequestRequestTypeDef = { # (1)
"datasetId": ...,
"changeType": ...,
"sourceParams": ...,
"formatParams": ...,
}
parent.create_changeset(**kwargs)
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: DataViewDestinationTypeParamsTypeDef, # (1)
clientToken: str = ...,
autoUpdate: bool = ...,
sortColumns: Sequence[str] = ...,
partitionColumns: Sequence[str] = ...,
asOfTimestamp: int = ...,
) -> CreateDataViewResponseTypeDef: # (2)
...
# create_data_view method usage example with argument unpacking
kwargs: CreateDataViewRequestRequestTypeDef = { # (1)
"datasetId": ...,
"destinationTypeParams": ...,
}
parent.create_data_view(**kwargs)
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: SchemaUnionTypeDef = ..., # (4)
) -> CreateDatasetResponseTypeDef: # (5)
...
- See DatasetKindType
- See PermissionGroupParamsTypeDef
- See DatasetOwnerInfoTypeDef
- See SchemaUnionTypeDef
- See CreateDatasetResponseTypeDef
# create_dataset method usage example with argument unpacking
kwargs: CreateDatasetRequestRequestTypeDef = { # (1)
"datasetTitle": ...,
"kind": ...,
"permissionGroupParams": ...,
}
parent.create_dataset(**kwargs)
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.
boto3 documentation
# create_permission_group method definition
def create_permission_group(
self,
*,
name: str,
applicationPermissions: Sequence[ApplicationPermissionType], # (1)
description: str = ...,
clientToken: str = ...,
) -> CreatePermissionGroupResponseTypeDef: # (2)
...
# create_permission_group method usage example with argument unpacking
kwargs: CreatePermissionGroupRequestRequestTypeDef = { # (1)
"name": ...,
"applicationPermissions": ...,
}
parent.create_permission_group(**kwargs)
create_user#
Creates a new user in FinSpace.
Type annotations and code completion for boto3.client("finspace-data").create_user
method.
boto3 documentation
# create_user method definition
def create_user(
self,
*,
emailAddress: str,
type: UserTypeType, # (1)
firstName: str = ...,
lastName: str = ...,
apiAccess: ApiAccessType = ..., # (2)
apiAccessPrincipalArn: str = ...,
clientToken: str = ...,
) -> CreateUserResponseTypeDef: # (3)
...
- See UserTypeType
- See ApiAccessType
- See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"emailAddress": ...,
"type": ...,
}
parent.create_user(**kwargs)
delete_dataset#
Deletes a FinSpace Dataset.
Type annotations and code completion for boto3.client("finspace-data").delete_dataset
method.
boto3 documentation
# delete_dataset method definition
def delete_dataset(
self,
*,
datasetId: str,
clientToken: str = ...,
) -> DeleteDatasetResponseTypeDef: # (1)
...
# delete_dataset method usage example with argument unpacking
kwargs: DeleteDatasetRequestRequestTypeDef = { # (1)
"datasetId": ...,
}
parent.delete_dataset(**kwargs)
delete_permission_group#
Deletes a permission group.
Type annotations and code completion for boto3.client("finspace-data").delete_permission_group
method.
boto3 documentation
# delete_permission_group method definition
def delete_permission_group(
self,
*,
permissionGroupId: str,
clientToken: str = ...,
) -> DeletePermissionGroupResponseTypeDef: # (1)
...
# delete_permission_group method usage example with argument unpacking
kwargs: DeletePermissionGroupRequestRequestTypeDef = { # (1)
"permissionGroupId": ...,
}
parent.delete_permission_group(**kwargs)
disable_user#
Denies access to the FinSpace web application and API for the specified user.
Type annotations and code completion for boto3.client("finspace-data").disable_user
method.
boto3 documentation
# disable_user method definition
def disable_user(
self,
*,
userId: str,
clientToken: str = ...,
) -> DisableUserResponseTypeDef: # (1)
...
# disable_user method usage example with argument unpacking
kwargs: DisableUserRequestRequestTypeDef = { # (1)
"userId": ...,
}
parent.disable_user(**kwargs)
disassociate_user_from_permission_group#
Removes a user from a permission group.
Type annotations and code completion for boto3.client("finspace-data").disassociate_user_from_permission_group
method.
boto3 documentation
# disassociate_user_from_permission_group method definition
def disassociate_user_from_permission_group(
self,
*,
permissionGroupId: str,
userId: str,
clientToken: str = ...,
) -> DisassociateUserFromPermissionGroupResponseTypeDef: # (1)
...
# disassociate_user_from_permission_group method usage example with argument unpacking
kwargs: DisassociateUserFromPermissionGroupRequestRequestTypeDef = { # (1)
"permissionGroupId": ...,
"userId": ...,
}
parent.disassociate_user_from_permission_group(**kwargs)
enable_user#
Allows the specified user to access the FinSpace web application and API.
Type annotations and code completion for boto3.client("finspace-data").enable_user
method.
boto3 documentation
# enable_user method definition
def enable_user(
self,
*,
userId: str,
clientToken: str = ...,
) -> EnableUserResponseTypeDef: # (1)
...
# enable_user method usage example with argument unpacking
kwargs: EnableUserRequestRequestTypeDef = { # (1)
"userId": ...,
}
parent.enable_user(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("finspace-data").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_changeset#
Get information about a Changeset.
Type annotations and code completion for boto3.client("finspace-data").get_changeset
method.
boto3 documentation
# get_changeset method definition
def get_changeset(
self,
*,
datasetId: str,
changesetId: str,
) -> GetChangesetResponseTypeDef: # (1)
...
# get_changeset method usage example with argument unpacking
kwargs: GetChangesetRequestRequestTypeDef = { # (1)
"datasetId": ...,
"changesetId": ...,
}
parent.get_changeset(**kwargs)
get_data_view#
Gets information about a Dataview.
Type annotations and code completion for boto3.client("finspace-data").get_data_view
method.
boto3 documentation
# get_data_view method definition
def get_data_view(
self,
*,
dataViewId: str,
datasetId: str,
) -> GetDataViewResponseTypeDef: # (1)
...
# get_data_view method usage example with argument unpacking
kwargs: GetDataViewRequestRequestTypeDef = { # (1)
"dataViewId": ...,
"datasetId": ...,
}
parent.get_data_view(**kwargs)
get_dataset#
Returns information about a Dataset.
Type annotations and code completion for boto3.client("finspace-data").get_dataset
method.