Class: Aws::FinSpaceData::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FinSpaceData::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb
Overview
An API client for FinSpaceData. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::FinSpaceData::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_user_to_permission_group(params = {}) ⇒ Types::AssociateUserToPermissionGroupResponse
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
-
#create_changeset(params = {}) ⇒ Types::CreateChangesetResponse
Creates a new Changeset in a FinSpace Dataset.
-
#create_data_view(params = {}) ⇒ Types::CreateDataViewResponse
Creates a Dataview for a Dataset.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new FinSpace Dataset.
-
#create_permission_group(params = {}) ⇒ Types::CreatePermissionGroupResponse
Creates a group of permissions for various actions that a user can perform in FinSpace.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new user in FinSpace.
-
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a FinSpace Dataset.
-
#delete_permission_group(params = {}) ⇒ Types::DeletePermissionGroupResponse
Deletes a permission group.
-
#disable_user(params = {}) ⇒ Types::DisableUserResponse
Denies access to the FinSpace web application and API for the specified user.
-
#disassociate_user_from_permission_group(params = {}) ⇒ Types::DisassociateUserFromPermissionGroupResponse
Removes a user from a permission group.
-
#enable_user(params = {}) ⇒ Types::EnableUserResponse
Allows the specified user to access the FinSpace web application and API.
-
#get_changeset(params = {}) ⇒ Types::GetChangesetResponse
Get information about a Changeset.
-
#get_data_view(params = {}) ⇒ Types::GetDataViewResponse
Gets information about a Dataview.
-
#get_dataset(params = {}) ⇒ Types::GetDatasetResponse
Returns information about a Dataset.
-
#get_external_data_view_access_details(params = {}) ⇒ Types::GetExternalDataViewAccessDetailsResponse
Returns the credentials to access the external Dataview from an S3 location.
-
#get_permission_group(params = {}) ⇒ Types::GetPermissionGroupResponse
Retrieves the details of a specific permission group.
-
#get_programmatic_access_credentials(params = {}) ⇒ Types::GetProgrammaticAccessCredentialsResponse
Request programmatic credentials to use with FinSpace SDK.
-
#get_user(params = {}) ⇒ Types::GetUserResponse
Retrieves details for a specific user.
-
#get_working_location(params = {}) ⇒ Types::GetWorkingLocationResponse
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.
-
#list_changesets(params = {}) ⇒ Types::ListChangesetsResponse
Lists the FinSpace Changesets for a Dataset.
-
#list_data_views(params = {}) ⇒ Types::ListDataViewsResponse
Lists all available Dataviews for a Dataset.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the active Datasets that a user has access to.
-
#list_permission_groups(params = {}) ⇒ Types::ListPermissionGroupsResponse
Lists all available permission groups in FinSpace.
-
#list_permission_groups_by_user(params = {}) ⇒ Types::ListPermissionGroupsByUserResponse
Lists all the permission groups that are associated with a specific user.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all available users in FinSpace.
-
#list_users_by_permission_group(params = {}) ⇒ Types::ListUsersByPermissionGroupResponse
Lists details of all the users in a specific permission group.
-
#reset_user_password(params = {}) ⇒ Types::ResetUserPasswordResponse
Resets the password for a specified user ID and generates a temporary one.
-
#update_changeset(params = {}) ⇒ Types::UpdateChangesetResponse
Updates a FinSpace Changeset.
-
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a FinSpace Dataset.
-
#update_permission_group(params = {}) ⇒ Types::UpdatePermissionGroupResponse
Modifies the details of a permission group.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Modifies the details of the specified user.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
442 443 444 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 442 def initialize(*args) super end |
Instance Method Details
#associate_user_to_permission_group(params = {}) ⇒ Types::AssociateUserToPermissionGroupResponse
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
483 484 485 486 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 483 def (params = {}, = {}) req = build_request(:associate_user_to_permission_group, params) req.send_request() end |
#create_changeset(params = {}) ⇒ Types::CreateChangesetResponse
Creates a new Changeset in a FinSpace Dataset.
594 595 596 597 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 594 def create_changeset(params = {}, = {}) req = build_request(:create_changeset, params) req.send_request() end |
#create_data_view(params = {}) ⇒ Types::CreateDataViewResponse
Creates a Dataview for a Dataset.
659 660 661 662 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 659 def create_data_view(params = {}, = {}) req = build_request(:create_data_view, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new FinSpace Dataset.
744 745 746 747 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 744 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_permission_group(params = {}) ⇒ Types::CreatePermissionGroupResponse
Creates a group of permissions for various actions that a user can perform in FinSpace.
814 815 816 817 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 814 def (params = {}, = {}) req = build_request(:create_permission_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new user in FinSpace.
887 888 889 890 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 887 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a FinSpace Dataset.
922 923 924 925 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 922 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_permission_group(params = {}) ⇒ Types::DeletePermissionGroupResponse
Deletes a permission group. This action is irreversible.
958 959 960 961 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 958 def (params = {}, = {}) req = build_request(:delete_permission_group, params) req.send_request() end |
#disable_user(params = {}) ⇒ Types::DisableUserResponse
Denies access to the FinSpace web application and API for the specified user.
994 995 996 997 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 994 def disable_user(params = {}, = {}) req = build_request(:disable_user, params) req.send_request() end |
#disassociate_user_from_permission_group(params = {}) ⇒ Types::DisassociateUserFromPermissionGroupResponse
Removes a user from a permission group.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1033 def (params = {}, = {}) req = build_request(:disassociate_user_from_permission_group, params) req.send_request() end |
#enable_user(params = {}) ⇒ Types::EnableUserResponse
Allows the specified user to access the FinSpace web application and API.
1069 1070 1071 1072 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1069 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#get_changeset(params = {}) ⇒ Types::GetChangesetResponse
Get information about a Changeset.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1129 def get_changeset(params = {}, = {}) req = build_request(:get_changeset, params) req.send_request() end |
#get_data_view(params = {}) ⇒ Types::GetDataViewResponse
Gets information about a Dataview.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1189 def get_data_view(params = {}, = {}) req = build_request(:get_data_view, params) req.send_request() end |
#get_dataset(params = {}) ⇒ Types::GetDatasetResponse
Returns information about a Dataset.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1240 def get_dataset(params = {}, = {}) req = build_request(:get_dataset, params) req.send_request() end |
#get_external_data_view_access_details(params = {}) ⇒ Types::GetExternalDataViewAccessDetailsResponse
Returns the credentials to access the external Dataview from an S3 location. To call this API:
You must retrieve the programmatic credentials.
You must be a member of a FinSpace user group, where the dataset that you want to access has
Read Dataset Data
permissions.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1284 def get_external_data_view_access_details(params = {}, = {}) req = build_request(:get_external_data_view_access_details, params) req.send_request() end |
#get_permission_group(params = {}) ⇒ Types::GetPermissionGroupResponse
Retrieves the details of a specific permission group.
1319 1320 1321 1322 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1319 def (params = {}, = {}) req = build_request(:get_permission_group, params) req.send_request() end |
#get_programmatic_access_credentials(params = {}) ⇒ Types::GetProgrammaticAccessCredentialsResponse
Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1361 def get_programmatic_access_credentials(params = {}, = {}) req = build_request(:get_programmatic_access_credentials, params) req.send_request() end |
#get_user(params = {}) ⇒ Types::GetUserResponse
Retrieves details for a specific user.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1413 def get_user(params = {}, = {}) req = build_request(:get_user, params) req.send_request() end |
#get_working_location(params = {}) ⇒ Types::GetWorkingLocationResponse
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.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1455 def get_working_location(params = {}, = {}) req = build_request(:get_working_location, params) req.send_request() end |
#list_changesets(params = {}) ⇒ Types::ListChangesetsResponse
Lists the FinSpace Changesets for a Dataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1512 def list_changesets(params = {}, = {}) req = build_request(:list_changesets, params) req.send_request() end |
#list_data_views(params = {}) ⇒ Types::ListDataViewsResponse
Lists all available Dataviews for a Dataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1570 1571 1572 1573 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1570 def list_data_views(params = {}, = {}) req = build_request(:list_data_views, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the active Datasets that a user has access to.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1623 1624 1625 1626 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1623 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_permission_groups(params = {}) ⇒ Types::ListPermissionGroupsResponse
Lists all available permission groups in FinSpace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1667 def (params = {}, = {}) req = build_request(:list_permission_groups, params) req.send_request() end |
#list_permission_groups_by_user(params = {}) ⇒ Types::ListPermissionGroupsByUserResponse
Lists all the permission groups that are associated with a specific user.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1709 def (params = {}, = {}) req = build_request(:list_permission_groups_by_user, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all available users in FinSpace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1758 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_users_by_permission_group(params = {}) ⇒ Types::ListUsersByPermissionGroupResponse
Lists details of all the users in a specific permission group.
1805 1806 1807 1808 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1805 def (params = {}, = {}) req = build_request(:list_users_by_permission_group, params) req.send_request() end |
#reset_user_password(params = {}) ⇒ Types::ResetUserPasswordResponse
Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1846 def reset_user_password(params = {}, = {}) req = build_request(:reset_user_password, params) req.send_request() end |
#update_changeset(params = {}) ⇒ Types::UpdateChangesetResponse
Updates a FinSpace Changeset.
1948 1949 1950 1951 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1948 def update_changeset(params = {}, = {}) req = build_request(:update_changeset, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a FinSpace Dataset.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2018 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_permission_group(params = {}) ⇒ Types::UpdatePermissionGroupResponse
Modifies the details of a permission group. You cannot modify a
permissionGroupID
.
2092 2093 2094 2095 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2092 def (params = {}, = {}) req = build_request(:update_permission_group, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Modifies the details of the specified user. You cannot update the
userId
for a user.
2163 2164 2165 2166 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2163 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |