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.
469 470 471 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 469 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.
510 511 512 513 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 510 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.
621 622 623 624 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 621 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.
686 687 688 689 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 686 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.
771 772 773 774 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 771 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.
841 842 843 844 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 841 def (params = {}, = {}) req = build_request(:create_permission_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new user in FinSpace.
914 915 916 917 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 914 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a FinSpace Dataset.
949 950 951 952 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 949 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.
985 986 987 988 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 985 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.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1021 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.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1060 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.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1096 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#get_changeset(params = {}) ⇒ Types::GetChangesetResponse
Get information about a Changeset.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1156 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.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1216 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.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1267 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.
1311 1312 1313 1314 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1311 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1346 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.
1388 1389 1390 1391 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1388 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.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1440 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.
1482 1483 1484 1485 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1482 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.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1539 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.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1597 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.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1650 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.
1694 1695 1696 1697 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1694 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.
1736 1737 1738 1739 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1736 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.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1785 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.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1832 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.
1873 1874 1875 1876 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1873 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.
1975 1976 1977 1978 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 1975 def update_changeset(params = {}, = {}) req = build_request(:update_changeset, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Updates a FinSpace Dataset.
2045 2046 2047 2048 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2045 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
.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2119 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.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/client.rb', line 2190 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |