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
-
#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.
-
#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_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_users(params = {}) ⇒ Types::ListUsersResponse
Lists all available user accounts in FinSpace.
-
#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 account.
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.
350 351 352 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 350 def initialize(*args) super end |
Instance Method Details
#create_changeset(params = {}) ⇒ Types::CreateChangesetResponse
Creates a new Changeset in a FinSpace Dataset.
462 463 464 465 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 462 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.
527 528 529 530 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 527 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.
612 613 614 615 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 612 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.
675 676 677 678 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 675 def (params = {}, = {}) req = build_request(:create_permission_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new user in FinSpace.
748 749 750 751 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 748 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a FinSpace Dataset.
783 784 785 786 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 783 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.
819 820 821 822 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 819 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.
855 856 857 858 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 855 def disable_user(params = {}, = {}) req = build_request(:disable_user, params) req.send_request() end |
#enable_user(params = {}) ⇒ Types::EnableUserResponse
Allows the specified user to access the FinSpace web application and API.
891 892 893 894 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 891 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#get_changeset(params = {}) ⇒ Types::GetChangesetResponse
Get information about a Changeset.
951 952 953 954 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 951 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.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1011 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.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1062 def get_dataset(params = {}, = {}) req = build_request(:get_dataset, params) req.send_request() end |
#get_programmatic_access_credentials(params = {}) ⇒ Types::GetProgrammaticAccessCredentialsResponse
Request programmatic credentials to use with FinSpace SDK.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1098 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.
1150 1151 1152 1153 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1150 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.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1192 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.
1249 1250 1251 1252 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1249 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.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1307 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1360 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1403 def (params = {}, = {}) req = build_request(:list_permission_groups, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all available user accounts in FinSpace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1452 def list_users(params = {}, = {}) req = build_request(:list_users, 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.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1493 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1595 def update_changeset(params = {}, = {}) req = build_request(:update_changeset, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a FinSpace Dataset.
1665 1666 1667 1668 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1665 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
.
1732 1733 1734 1735 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1732 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 account. You cannot update
the userId
for a user.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1803 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |