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

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.

Usage example

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

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

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 account 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

Method definition

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

1. See AssociateUserToPermissionGroupResponseTypeDef

Usage example with kwargs

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

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

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

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

Usage example with kwargs

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

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

1. See DataViewDestinationTypeParamsTypeDef
2. See CreateDataViewResponseTypeDef

Usage example with kwargs

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

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

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

Usage example with kwargs

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. boto3 documentation

Method definition

def create_permission_group(
    self,
    *,
    name: str,
    applicationPermissions: Sequence[ApplicationPermissionType],  # (1)
    description: str = ...,
    clientToken: str = ...,
) -> CreatePermissionGroupResponseTypeDef:  # (2)
    ...

1. See ApplicationPermissionType
2. See CreatePermissionGroupResponseTypeDef

Usage example with kwargs

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

parent.create_permission_group(**kwargs)

1. See CreatePermissionGroupRequestRequestTypeDef

create_user

Creates a new user in FinSpace.

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

Method definition

def create_user(
    self,
    *,
    emailAddress: str,
    type: UserTypeType,  # (1)
    firstName: str = ...,
    lastName: str = ...,
    ApiAccess: ApiAccessType = ...,  # (2)
    apiAccessPrincipalArn: str = ...,
    clientToken: str = ...,
) -> CreateUserResponseTypeDef:  # (3)
    ...

1. See UserTypeType
2. See ApiAccessType
3. See CreateUserResponseTypeDef

Usage example with kwargs

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "emailAddress": ...,
    "type": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestRequestTypeDef

delete_dataset

Deletes a FinSpace Dataset.

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

Method definition

def delete_dataset(
    self,
    *,
    datasetId: str,
    clientToken: str = ...,
) -> DeleteDatasetResponseTypeDef:  # (1)
    ...

1. See DeleteDatasetResponseTypeDef

Usage example with kwargs

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

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestRequestTypeDef

delete_permission_group

Deletes a permission group.

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

Method definition

def delete_permission_group(
    self,
    *,
    permissionGroupId: str,
    clientToken: str = ...,
) -> DeletePermissionGroupResponseTypeDef:  # (1)
    ...

1. See DeletePermissionGroupResponseTypeDef

Usage example with kwargs

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

parent.delete_permission_group(**kwargs)

1. See DeletePermissionGroupRequestRequestTypeDef

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

Method definition

def disable_user(
    self,
    *,
    userId: str,
    clientToken: str = ...,
) -> DisableUserResponseTypeDef:  # (1)
    ...

1. See DisableUserResponseTypeDef

Usage example with kwargs

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

parent.disable_user(**kwargs)

1. See DisableUserRequestRequestTypeDef

disassociate_user_from_permission_group

Removes a user account from a permission group.

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

Method definition

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

1. See DisassociateUserFromPermissionGroupResponseTypeDef

Usage example with kwargs

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

parent.disassociate_user_from_permission_group(**kwargs)

1. See DisassociateUserFromPermissionGroupRequestRequestTypeDef

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

Method definition

def enable_user(
    self,
    *,
    userId: str,
    clientToken: str = ...,
) -> EnableUserResponseTypeDef:  # (1)
    ...

1. See EnableUserResponseTypeDef

Usage example with kwargs

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

parent.enable_user(**kwargs)

1. See EnableUserRequestRequestTypeDef

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

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

Method definition

def get_changeset(
    self,
    *,
    datasetId: str,
    changesetId: str,
) -> GetChangesetResponseTypeDef:  # (1)
    ...

1. See GetChangesetResponseTypeDef

Usage example with kwargs

kwargs: GetChangesetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "changesetId": ...,
}

parent.get_changeset(**kwargs)

1. See GetChangesetRequestRequestTypeDef

get_data_view

Gets information about a Dataview.

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

Method definition

def get_data_view(
    self,
    *,
    dataViewId: str,
    datasetId: str,
) -> GetDataViewResponseTypeDef:  # (1)
    ...

1. See GetDataViewResponseTypeDef

Usage example with kwargs

kwargs: GetDataViewRequestRequestTypeDef = {  # (1)
    "dataViewId": ...,
    "datasetId": ...,
}

parent.get_data_view(**kwargs)

1. See GetDataViewRequestRequestTypeDef

get_dataset

Returns information about a Dataset.

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

Method definition

def get_dataset(
    self,
    *,
    datasetId: str,
) -> GetDatasetResponseTypeDef:  # (1)
    ...

1. See GetDatasetResponseTypeDef

Usage example with kwargs

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

parent.get_dataset(**kwargs)

1. See GetDatasetRequestRequestTypeDef

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

Method definition

def get_external_data_view_access_details(
    self,
    *,
    dataViewId: str,
    datasetId: str,
) -> GetExternalDataViewAccessDetailsResponseTypeDef:  # (1)
    ...

1. See GetExternalDataViewAccessDetailsResponseTypeDef

Usage example with kwargs

kwargs: GetExternalDataViewAccessDetailsRequestRequestTypeDef = {  # (1)
    "dataViewId": ...,
    "datasetId": ...,
}

parent.get_external_data_view_access_details(**kwargs)

1. See GetExternalDataViewAccessDetailsRequestRequestTypeDef

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

Method definition

def get_permission_group(
    self,
    *,
    permissionGroupId: str,
) -> GetPermissionGroupResponseTypeDef:  # (1)
    ...

1. See GetPermissionGroupResponseTypeDef

Usage example with kwargs

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

parent.get_permission_group(**kwargs)

1. See GetPermissionGroupRequestRequestTypeDef

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

Method definition

def get_programmatic_access_credentials(
    self,
    *,
    environmentId: str,
    durationInMinutes: int = ...,
) -> GetProgrammaticAccessCredentialsResponseTypeDef:  # (1)
    ...

1. See GetProgrammaticAccessCredentialsResponseTypeDef

Usage example with kwargs

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

parent.get_programmatic_access_credentials(**kwargs)

1. See GetProgrammaticAccessCredentialsRequestRequestTypeDef

get_user

Retrieves details for a specific user.

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

Method definition

def get_user(
    self,
    *,
    userId: str,
) -> GetUserResponseTypeDef:  # (1)
    ...

1. See GetUserResponseTypeDef

Usage example with kwargs

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

parent.get_user(**kwargs)

1. See GetUserRequestRequestTypeDef

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

Method definition

def get_working_location(
    self,
    *,
    locationType: locationTypeType = ...,  # (1)
) -> GetWorkingLocationResponseTypeDef:  # (2)
    ...

1. See locationTypeType
2. See GetWorkingLocationResponseTypeDef

Usage example with kwargs

kwargs: GetWorkingLocationRequestRequestTypeDef = {  # (1)
    "locationType": ...,
}

parent.get_working_location(**kwargs)

1. See GetWorkingLocationRequestRequestTypeDef

list_changesets

Lists the FinSpace Changesets for a Dataset.

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

Method definition

def list_changesets(
    self,
    *,
    datasetId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListChangesetsResponseTypeDef:  # (1)
    ...

1. See ListChangesetsResponseTypeDef

Usage example with kwargs

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

parent.list_changesets(**kwargs)

1. See ListChangesetsRequestRequestTypeDef

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

Method definition

def list_data_views(
    self,
    *,
    datasetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataViewsResponseTypeDef:  # (1)
    ...

1. See ListDataViewsResponseTypeDef

Usage example with kwargs

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

parent.list_data_views(**kwargs)

1. See ListDataViewsRequestRequestTypeDef

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

Method definition

def list_datasets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...

1. See ListDatasetsResponseTypeDef

Usage example with kwargs

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_datasets(**kwargs)

1. See ListDatasetsRequestRequestTypeDef

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

Method definition

def list_permission_groups(
    self,
    *,
    maxResults: int,
    nextToken: str = ...,
) -> ListPermissionGroupsResponseTypeDef:  # (1)
    ...

1. See ListPermissionGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListPermissionGroupsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_permission_groups(**kwargs)

1. See ListPermissionGroupsRequestRequestTypeDef

list_permission_groups_by_user

Lists all the permission groups that are associated with a specific user account.

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

Method definition

def list_permission_groups_by_user(
    self,
    *,
    userId: str,
    maxResults: int,
    nextToken: str = ...,
) -> ListPermissionGroupsByUserResponseTypeDef:  # (1)
    ...

1. See ListPermissionGroupsByUserResponseTypeDef

Usage example with kwargs

kwargs: ListPermissionGroupsByUserRequestRequestTypeDef = {  # (1)
    "userId": ...,
    "maxResults": ...,
}

parent.list_permission_groups_by_user(**kwargs)

1. See ListPermissionGroupsByUserRequestRequestTypeDef

list_users

Lists all available user accounts in FinSpace.

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

Method definition

def list_users(
    self,
    *,
    maxResults: int,
    nextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...

1. See ListUsersResponseTypeDef

Usage example with kwargs

kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestRequestTypeDef

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

Method definition

def list_users_by_permission_group(
    self,
    *,
    permissionGroupId: str,
    maxResults: int,
    nextToken: str = ...,
) -> ListUsersByPermissionGroupResponseTypeDef:  # (1)
    ...

1. See ListUsersByPermissionGroupResponseTypeDef

Usage example with kwargs

kwargs: ListUsersByPermissionGroupRequestRequestTypeDef = {  # (1)
    "permissionGroupId": ...,
    "maxResults": ...,
}

parent.list_users_by_permission_group(**kwargs)

1. See ListUsersByPermissionGroupRequestRequestTypeDef

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

Method definition

def reset_user_password(
    self,
    *,
    userId: str,
    clientToken: str = ...,
) -> ResetUserPasswordResponseTypeDef:  # (1)
    ...

1. See ResetUserPasswordResponseTypeDef

Usage example with kwargs

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

parent.reset_user_password(**kwargs)

1. See ResetUserPasswordRequestRequestTypeDef

update_changeset

Updates a FinSpace Changeset.

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

Method definition

def update_changeset(
    self,
    *,
    datasetId: str,
    changesetId: str,
    sourceParams: Mapping[str, str],
    formatParams: Mapping[str, str],
    clientToken: str = ...,
) -> UpdateChangesetResponseTypeDef:  # (1)
    ...

1. See UpdateChangesetResponseTypeDef

Usage example with kwargs

kwargs: UpdateChangesetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "changesetId": ...,
    "sourceParams": ...,
    "formatParams": ...,
}

parent.update_changeset(**kwargs)

1. See UpdateChangesetRequestRequestTypeDef

update_dataset

Updates a FinSpace Dataset.

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

Method definition

def update_dataset(
    self,
    *,
    datasetId: str,
    datasetTitle: str,
    kind: DatasetKindType,  # (1)
    clientToken: str = ...,
    datasetDescription: str = ...,
    alias: str = ...,
    schemaDefinition: SchemaUnionTypeDef = ...,  # (2)
) -> UpdateDatasetResponseTypeDef:  # (3)
    ...

1. See DatasetKindType
2. See SchemaUnionTypeDef
3. See UpdateDatasetResponseTypeDef

Usage example with kwargs

kwargs: UpdateDatasetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "datasetTitle": ...,
    "kind": ...,
}

parent.update_dataset(**kwargs)

1. See UpdateDatasetRequestRequestTypeDef

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

Method definition

def update_permission_group(
    self,
    *,
    permissionGroupId: str,
    name: str = ...,
    description: str = ...,
    applicationPermissions: Sequence[ApplicationPermissionType] = ...,  # (1)
    clientToken: str = ...,
) -> UpdatePermissionGroupResponseTypeDef:  # (2)
    ...

1. See ApplicationPermissionType
2. See UpdatePermissionGroupResponseTypeDef

Usage example with kwargs

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

parent.update_permission_group(**kwargs)

1. See UpdatePermissionGroupRequestRequestTypeDef

update_user

Modifies the details of the specified user account.

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

Method definition

def update_user(
    self,
    *,
    userId: str,
    type: UserTypeType = ...,  # (1)
    firstName: str = ...,
    lastName: str = ...,
    apiAccess: ApiAccessType = ...,  # (2)
    apiAccessPrincipalArn: str = ...,
    clientToken: str = ...,
) -> UpdateUserResponseTypeDef:  # (3)
    ...

1. See UserTypeType
2. See ApiAccessType
3. See UpdateUserResponseTypeDef

Usage example with kwargs

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

parent.update_user(**kwargs)

1. See UpdateUserRequestRequestTypeDef

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