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.
387 388 389 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 387 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.
428 429 430 431 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 428 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.
539 540 541 542 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 539 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.
604 605 606 607 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 604 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.
689 690 691 692 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 689 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.
759 760 761 762 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 759 def (params = {}, = {}) req = build_request(:create_permission_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new user in FinSpace.
832 833 834 835 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 832 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a FinSpace Dataset.
867 868 869 870 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 867 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.
903 904 905 906 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 903 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.
939 940 941 942 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 939 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.
978 979 980 981 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 978 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1014 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#get_changeset(params = {}) ⇒ Types::GetChangesetResponse
Get information about a Changeset.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1074 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.
1134 1135 1136 1137 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1134 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.
1185 1186 1187 1188 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1185 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1229 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.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1264 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.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1306 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.
1358 1359 1360 1361 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1358 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1400 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1457 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.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1515 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.
1568 1569 1570 1571 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1568 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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1612 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.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1654 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.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1703 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.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1750 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.
1791 1792 1793 1794 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1791 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.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1893 def update_changeset(params = {}, = {}) req = build_request(:update_changeset, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a FinSpace Dataset.
1963 1964 1965 1966 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1963 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
.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2037 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2108 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |