FinSpaceDataClient#
Index > FinSpaceData > FinSpaceDataClient
Auto-generated documentation for FinSpaceData type annotations stubs module types-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 types_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 types_boto3_finspace_data.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
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:
    ...generate_presigned_url#
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:
    ...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: AssociateUserToPermissionGroupRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
    "userId": ...,
}
parent.associate_user_to_permission_group(**kwargs)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: CreateChangesetRequestTypeDef = {  # (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: DataViewDestinationTypeParamsUnionTypeDef,  # (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: CreateDataViewRequestTypeDef = {  # (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: SchemaUnionUnionTypeDef = ...,  # (4)
) -> CreateDatasetResponseTypeDef:  # (5)
    ...- See DatasetKindType
- See PermissionGroupParamsTypeDef
- See DatasetOwnerInfoTypeDef
- See SchemaUnionUnionTypeDef
- See CreateDatasetResponseTypeDef
# create_dataset method usage example with argument unpacking
kwargs: CreateDatasetRequestTypeDef = {  # (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)
    ...- See Sequence[ApplicationPermissionType]
- See CreatePermissionGroupResponseTypeDef
# create_permission_group method usage example with argument unpacking
kwargs: CreatePermissionGroupRequestTypeDef = {  # (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: CreateUserRequestTypeDef = {  # (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: DeleteDatasetRequestTypeDef = {  # (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: DeletePermissionGroupRequestTypeDef = {  # (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: DisableUserRequestTypeDef = {  # (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: DisassociateUserFromPermissionGroupRequestTypeDef = {  # (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: EnableUserRequestTypeDef = {  # (1)
    "userId": ...,
}
parent.enable_user(**kwargs)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: GetChangesetRequestTypeDef = {  # (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: GetDataViewRequestTypeDef = {  # (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.
 boto3 documentation
# get_dataset method definition
def get_dataset(
    self,
    *,
    datasetId: str,
) -> GetDatasetResponseTypeDef:  # (1)
    ...# get_dataset method usage example with argument unpacking
kwargs: GetDatasetRequestTypeDef = {  # (1)
    "datasetId": ...,
}
parent.get_dataset(**kwargs)get_external_data_view_access_details#
Returns the credentials to access the external Dataview from an S3 location.
Type annotations and code completion for boto3.client("finspace-data").get_external_data_view_access_details method.
 boto3 documentation
# get_external_data_view_access_details method definition
def get_external_data_view_access_details(
    self,
    *,
    dataViewId: str,
    datasetId: str,
) -> GetExternalDataViewAccessDetailsResponseTypeDef:  # (1)
    ...# get_external_data_view_access_details method usage example with argument unpacking
kwargs: GetExternalDataViewAccessDetailsRequestTypeDef = {  # (1)
    "dataViewId": ...,
    "datasetId": ...,
}
parent.get_external_data_view_access_details(**kwargs)get_permission_group#
Retrieves the details of a specific permission group.
Type annotations and code completion for boto3.client("finspace-data").get_permission_group method.
 boto3 documentation
# get_permission_group method definition
def get_permission_group(
    self,
    *,
    permissionGroupId: str,
) -> GetPermissionGroupResponseTypeDef:  # (1)
    ...# get_permission_group method usage example with argument unpacking
kwargs: GetPermissionGroupRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
}
parent.get_permission_group(**kwargs)get_programmatic_access_credentials#
Request programmatic credentials to use with FinSpace SDK.
Type annotations and code completion for boto3.client("finspace-data").get_programmatic_access_credentials method.
 boto3 documentation
# get_programmatic_access_credentials method definition
def get_programmatic_access_credentials(
    self,
    *,
    environmentId: str,
    durationInMinutes: int = ...,
) -> GetProgrammaticAccessCredentialsResponseTypeDef:  # (1)
    ...# get_programmatic_access_credentials method usage example with argument unpacking
kwargs: GetProgrammaticAccessCredentialsRequestTypeDef = {  # (1)
    "environmentId": ...,
}
parent.get_programmatic_access_credentials(**kwargs)get_user#
Retrieves details for a specific user.
Type annotations and code completion for boto3.client("finspace-data").get_user method.
 boto3 documentation
# get_user method definition
def get_user(
    self,
    *,
    userId: str,
) -> GetUserResponseTypeDef:  # (1)
    ...# get_user method usage example with argument unpacking
kwargs: GetUserRequestTypeDef = {  # (1)
    "userId": ...,
}
parent.get_user(**kwargs)get_working_location#
A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.
Type annotations and code completion for boto3.client("finspace-data").get_working_location method.
 boto3 documentation
# get_working_location method definition
def get_working_location(
    self,
    *,
    locationType: LocationTypeType = ...,  # (1)
) -> GetWorkingLocationResponseTypeDef:  # (2)
    ...# get_working_location method usage example with argument unpacking
kwargs: GetWorkingLocationRequestTypeDef = {  # (1)
    "locationType": ...,
}
parent.get_working_location(**kwargs)list_changesets#
Lists the FinSpace Changesets for a Dataset.
Type annotations and code completion for boto3.client("finspace-data").list_changesets method.
 boto3 documentation
# list_changesets method definition
def list_changesets(
    self,
    *,
    datasetId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListChangesetsResponseTypeDef:  # (1)
    ...# list_changesets method usage example with argument unpacking
kwargs: ListChangesetsRequestTypeDef = {  # (1)
    "datasetId": ...,
}
parent.list_changesets(**kwargs)list_data_views#
Lists all available Dataviews for a Dataset.
Type annotations and code completion for boto3.client("finspace-data").list_data_views method.
 boto3 documentation
# list_data_views method definition
def list_data_views(
    self,
    *,
    datasetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataViewsResponseTypeDef:  # (1)
    ...# list_data_views method usage example with argument unpacking
kwargs: ListDataViewsRequestTypeDef = {  # (1)
    "datasetId": ...,
}
parent.list_data_views(**kwargs)list_datasets#
Lists all of the active Datasets that a user has access to.
Type annotations and code completion for boto3.client("finspace-data").list_datasets method.
 boto3 documentation
# list_datasets method definition
def list_datasets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...# list_datasets method usage example with argument unpacking
kwargs: ListDatasetsRequestTypeDef = {  # (1)
    "nextToken": ...,
}
parent.list_datasets(**kwargs)list_permission_groups#
Lists all available permission groups in FinSpace.
Type annotations and code completion for boto3.client("finspace-data").list_permission_groups method.
 boto3 documentation
# list_permission_groups method definition
def list_permission_groups(
    self,
    *,
    maxResults: int,
    nextToken: str = ...,
) -> ListPermissionGroupsResponseTypeDef:  # (1)
    ...# list_permission_groups method usage example with argument unpacking
kwargs: ListPermissionGroupsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_permission_groups(**kwargs)list_permission_groups_by_user#
Lists all the permission groups that are associated with a specific user.
Type annotations and code completion for boto3.client("finspace-data").list_permission_groups_by_user method.
 boto3 documentation
# list_permission_groups_by_user method definition
def list_permission_groups_by_user(
    self,
    *,
    userId: str,
    maxResults: int,
    nextToken: str = ...,
) -> ListPermissionGroupsByUserResponseTypeDef:  # (1)
    ...# list_permission_groups_by_user method usage example with argument unpacking
kwargs: ListPermissionGroupsByUserRequestTypeDef = {  # (1)
    "userId": ...,
    "maxResults": ...,
}
parent.list_permission_groups_by_user(**kwargs)list_users#
Lists all available users in FinSpace.
Type annotations and code completion for boto3.client("finspace-data").list_users method.
 boto3 documentation
# list_users method definition
def list_users(
    self,
    *,
    maxResults: int,
    nextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...# list_users method usage example with argument unpacking
kwargs: ListUsersRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_users(**kwargs)list_users_by_permission_group#
Lists details of all the users in a specific permission group.
Type annotations and code completion for boto3.client("finspace-data").list_users_by_permission_group method.
 boto3 documentation
# list_users_by_permission_group method definition
def list_users_by_permission_group(
    self,
    *,
    permissionGroupId: str,
    maxResults: int,
    nextToken: str = ...,
) -> ListUsersByPermissionGroupResponseTypeDef:  # (1)
    ...# list_users_by_permission_group method usage example with argument unpacking
kwargs: ListUsersByPermissionGroupRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
    "maxResults": ...,
}
parent.list_users_by_permission_group(**kwargs)reset_user_password#
Resets the password for a specified user ID and generates a temporary one.
Type annotations and code completion for boto3.client("finspace-data").reset_user_password method.
 boto3 documentation
# reset_user_password method definition
def reset_user_password(
    self,
    *,
    userId: str,
    clientToken: str = ...,
) -> ResetUserPasswordResponseTypeDef:  # (1)
    ...# reset_user_password method usage example with argument unpacking
kwargs: ResetUserPasswordRequestTypeDef = {  # (1)
    "userId": ...,
}
parent.reset_user_password(**kwargs)update_changeset#
Updates a FinSpace Changeset.
Type annotations and code completion for boto3.client("finspace-data").update_changeset method.
 boto3 documentation
# update_changeset method definition
def update_changeset(
    self,
    *,
    datasetId: str,
    changesetId: str,
    sourceParams: Mapping[str, str],
    formatParams: Mapping[str, str],
    clientToken: str = ...,
) -> UpdateChangesetResponseTypeDef:  # (1)
    ...# update_changeset method usage example with argument unpacking
kwargs: UpdateChangesetRequestTypeDef = {  # (1)
    "datasetId": ...,
    "changesetId": ...,
    "sourceParams": ...,
    "formatParams": ...,
}
parent.update_changeset(**kwargs)update_dataset#
Updates a FinSpace Dataset.
Type annotations and code completion for boto3.client("finspace-data").update_dataset method.
 boto3 documentation
# update_dataset method definition
def update_dataset(
    self,
    *,
    datasetId: str,
    datasetTitle: str,
    kind: DatasetKindType,  # (1)
    clientToken: str = ...,
    datasetDescription: str = ...,
    alias: str = ...,
    schemaDefinition: SchemaUnionUnionTypeDef = ...,  # (2)
) -> UpdateDatasetResponseTypeDef:  # (3)
    ...# update_dataset method usage example with argument unpacking
kwargs: UpdateDatasetRequestTypeDef = {  # (1)
    "datasetId": ...,
    "datasetTitle": ...,
    "kind": ...,
}
parent.update_dataset(**kwargs)update_permission_group#
Modifies the details of a permission group.
Type annotations and code completion for boto3.client("finspace-data").update_permission_group method.
 boto3 documentation
# update_permission_group method definition
def update_permission_group(
    self,
    *,
    permissionGroupId: str,
    name: str = ...,
    description: str = ...,
    applicationPermissions: Sequence[ApplicationPermissionType] = ...,  # (1)
    clientToken: str = ...,
) -> UpdatePermissionGroupResponseTypeDef:  # (2)
    ...- See Sequence[ApplicationPermissionType]
- See UpdatePermissionGroupResponseTypeDef
# update_permission_group method usage example with argument unpacking
kwargs: UpdatePermissionGroupRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
}
parent.update_permission_group(**kwargs)update_user#
Modifies the details of the specified user.
Type annotations and code completion for boto3.client("finspace-data").update_user method.
 boto3 documentation
# update_user method definition
def update_user(
    self,
    *,
    userId: str,
    type: UserTypeType = ...,  # (1)
    firstName: str = ...,
    lastName: str = ...,
    apiAccess: ApiAccessType = ...,  # (2)
    apiAccessPrincipalArn: str = ...,
    clientToken: str = ...,
) -> UpdateUserResponseTypeDef:  # (3)
    ...- See UserTypeType
- See ApiAccessType
- See UpdateUserResponseTypeDef
# update_user method usage example with argument unpacking
kwargs: UpdateUserRequestTypeDef = {  # (1)
    "userId": ...,
}
parent.update_user(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("finspace-data").get_paginator method with overloads.
- client.get_paginator("list_changesets")-> ListChangesetsPaginator
- client.get_paginator("list_data_views")-> ListDataViewsPaginator
- client.get_paginator("list_datasets")-> ListDatasetsPaginator
- client.get_paginator("list_permission_groups")-> ListPermissionGroupsPaginator
- client.get_paginator("list_users")-> ListUsersPaginator