aws-sdk-finspacedata 1.13.0 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-finspacedata/client.rb +591 -24
- data/lib/aws-sdk-finspacedata/client_api.rb +339 -0
- data/lib/aws-sdk-finspacedata/errors.rb +15 -0
- data/lib/aws-sdk-finspacedata/types.rb +991 -118
- data/lib/aws-sdk-finspacedata.rb +1 -1
- metadata +2 -2
@@ -366,15 +366,15 @@ module Aws::FinSpaceData
|
|
366
366
|
# will be created.
|
367
367
|
#
|
368
368
|
# @option params [required, String] :change_type
|
369
|
-
#
|
369
|
+
# The option to indicate how a Changeset will be applied to a Dataset.
|
370
370
|
#
|
371
|
-
# * `REPLACE`
|
371
|
+
# * `REPLACE` – Changeset will be considered as a replacement to all
|
372
372
|
# prior loaded Changesets.
|
373
373
|
#
|
374
|
-
# * `APPEND`
|
374
|
+
# * `APPEND` – Changeset will be considered as an addition to the end of
|
375
375
|
# all prior loaded Changesets.
|
376
376
|
#
|
377
|
-
# * `MODIFY`
|
377
|
+
# * `MODIFY` – Changeset is considered as a replacement to a specific
|
378
378
|
# prior ingested Changeset.
|
379
379
|
#
|
380
380
|
# @option params [required, Hash<String,String>] :source_params
|
@@ -392,7 +392,7 @@ module Aws::FinSpaceData
|
|
392
392
|
# The S3 path that you specify must allow the FinSpace role access. To
|
393
393
|
# do that, you first need to configure the IAM policy on S3 bucket. For
|
394
394
|
# more information, see [Loading data from an Amazon S3 Bucket using the
|
395
|
-
# FinSpace API][1]section.
|
395
|
+
# FinSpace API][1] section.
|
396
396
|
#
|
397
397
|
#
|
398
398
|
#
|
@@ -406,13 +406,13 @@ module Aws::FinSpaceData
|
|
406
406
|
# `formatType` is a required attribute and can have the following
|
407
407
|
# values:
|
408
408
|
#
|
409
|
-
# * `PARQUET`
|
409
|
+
# * `PARQUET` – Parquet source file format.
|
410
410
|
#
|
411
|
-
# * `CSV`
|
411
|
+
# * `CSV` – CSV source file format.
|
412
412
|
#
|
413
|
-
# * `JSON`
|
413
|
+
# * `JSON` – JSON source file format.
|
414
414
|
#
|
415
|
-
# * `XML`
|
415
|
+
# * `XML` – XML source file format.
|
416
416
|
#
|
417
417
|
# Here is an example of how you could specify the `formatParams`\:
|
418
418
|
#
|
@@ -486,7 +486,7 @@ module Aws::FinSpaceData
|
|
486
486
|
#
|
487
487
|
# @option params [Integer] :as_of_timestamp
|
488
488
|
# Beginning time to use for the Dataview. The value is determined as
|
489
|
-
#
|
489
|
+
# epoch time in milliseconds. For example, the value for Monday,
|
490
490
|
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
491
491
|
#
|
492
492
|
# @option params [required, Types::DataViewDestinationTypeParams] :destination_type_params
|
@@ -543,9 +543,9 @@ module Aws::FinSpaceData
|
|
543
543
|
# @option params [required, String] :kind
|
544
544
|
# The format in which Dataset data is structured.
|
545
545
|
#
|
546
|
-
# * `TABULAR`
|
546
|
+
# * `TABULAR` – Data is structured in a tabular format.
|
547
547
|
#
|
548
|
-
# * `NON_TABULAR`
|
548
|
+
# * `NON_TABULAR` – Data is structured in a non-tabular format.
|
549
549
|
#
|
550
550
|
# @option params [String] :dataset_description
|
551
551
|
# Description of a Dataset.
|
@@ -614,6 +614,142 @@ module Aws::FinSpaceData
|
|
614
614
|
req.send_request(options)
|
615
615
|
end
|
616
616
|
|
617
|
+
# Creates a group of permissions for various actions that a user can
|
618
|
+
# perform in FinSpace.
|
619
|
+
#
|
620
|
+
# @option params [required, String] :name
|
621
|
+
# The name of the permission group.
|
622
|
+
#
|
623
|
+
# @option params [String] :description
|
624
|
+
# A brief description for the permission group.
|
625
|
+
#
|
626
|
+
# @option params [required, Array<String>] :application_permissions
|
627
|
+
# The option to indicate FinSpace application permissions that are
|
628
|
+
# granted to a specific group.
|
629
|
+
#
|
630
|
+
# * `CreateDataset` – Group members can create new datasets.
|
631
|
+
#
|
632
|
+
# * `ManageClusters` – Group members can manage Apache Spark clusters
|
633
|
+
# from FinSpace notebooks.
|
634
|
+
#
|
635
|
+
# * `ManageUsersAndGroups` – Group members can manage users and
|
636
|
+
# permission groups.
|
637
|
+
#
|
638
|
+
# * `ManageAttributeSets` – Group members can manage attribute sets.
|
639
|
+
#
|
640
|
+
# * `ViewAuditData` – Group members can view audit data.
|
641
|
+
#
|
642
|
+
# * `AccessNotebooks` – Group members will have access to FinSpace
|
643
|
+
# notebooks.
|
644
|
+
#
|
645
|
+
# * `GetTemporaryCredentials` – Group members can get temporary API
|
646
|
+
# credentials.
|
647
|
+
#
|
648
|
+
# @option params [String] :client_token
|
649
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
650
|
+
#
|
651
|
+
# **A suitable default value is auto-generated.** You should normally
|
652
|
+
# not need to pass this option.**
|
653
|
+
#
|
654
|
+
# @return [Types::CreatePermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
655
|
+
#
|
656
|
+
# * {Types::CreatePermissionGroupResponse#permission_group_id #permission_group_id} => String
|
657
|
+
#
|
658
|
+
# @example Request syntax with placeholder values
|
659
|
+
#
|
660
|
+
# resp = client.create_permission_group({
|
661
|
+
# name: "PermissionGroupName", # required
|
662
|
+
# description: "PermissionGroupDescription",
|
663
|
+
# application_permissions: ["CreateDataset"], # required, accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
|
664
|
+
# client_token: "ClientToken",
|
665
|
+
# })
|
666
|
+
#
|
667
|
+
# @example Response structure
|
668
|
+
#
|
669
|
+
# resp.permission_group_id #=> String
|
670
|
+
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroup AWS API Documentation
|
672
|
+
#
|
673
|
+
# @overload create_permission_group(params = {})
|
674
|
+
# @param [Hash] params ({})
|
675
|
+
def create_permission_group(params = {}, options = {})
|
676
|
+
req = build_request(:create_permission_group, params)
|
677
|
+
req.send_request(options)
|
678
|
+
end
|
679
|
+
|
680
|
+
# Creates a new user in FinSpace.
|
681
|
+
#
|
682
|
+
# @option params [required, String] :email_address
|
683
|
+
# The email address of the user that you want to register. The email
|
684
|
+
# address serves as a uniquer identifier for each user and cannot be
|
685
|
+
# changed after it's created.
|
686
|
+
#
|
687
|
+
# @option params [required, String] :type
|
688
|
+
# The option to indicate the type of user. Use one of the following
|
689
|
+
# options to specify this parameter:
|
690
|
+
#
|
691
|
+
# * `SUPER_USER` – A user with permission to all the functionality and
|
692
|
+
# data in FinSpace.
|
693
|
+
#
|
694
|
+
# * `APP_USER` – A user with specific permissions in FinSpace. The users
|
695
|
+
# are assigned permissions by adding them to a permission group.
|
696
|
+
#
|
697
|
+
# @option params [String] :first_name
|
698
|
+
# The first name of the user that you want to register.
|
699
|
+
#
|
700
|
+
# @option params [String] :last_name
|
701
|
+
# The last name of the user that you want to register.
|
702
|
+
#
|
703
|
+
# @option params [String] :api_access
|
704
|
+
# The option to indicate whether the user can use the
|
705
|
+
# `GetProgrammaticAccessCredentials` API to obtain credentials that can
|
706
|
+
# then be used to access other FinSpace Data API operations.
|
707
|
+
#
|
708
|
+
# * `ENABLED` – The user has permissions to use the APIs.
|
709
|
+
#
|
710
|
+
# * `DISABLED` – The user does not have permissions to use any APIs.
|
711
|
+
#
|
712
|
+
# @option params [String] :api_access_principal_arn
|
713
|
+
# The ARN identifier of an AWS user or role that is allowed to call the
|
714
|
+
# `GetProgrammaticAccessCredentials` API to obtain a credentials token
|
715
|
+
# for a specific FinSpace user. This must be an IAM role within your
|
716
|
+
# FinSpace account.
|
717
|
+
#
|
718
|
+
# @option params [String] :client_token
|
719
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
720
|
+
#
|
721
|
+
# **A suitable default value is auto-generated.** You should normally
|
722
|
+
# not need to pass this option.**
|
723
|
+
#
|
724
|
+
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
725
|
+
#
|
726
|
+
# * {Types::CreateUserResponse#user_id #user_id} => String
|
727
|
+
#
|
728
|
+
# @example Request syntax with placeholder values
|
729
|
+
#
|
730
|
+
# resp = client.create_user({
|
731
|
+
# email_address: "Email", # required
|
732
|
+
# type: "SUPER_USER", # required, accepts SUPER_USER, APP_USER
|
733
|
+
# first_name: "FirstName",
|
734
|
+
# last_name: "LastName",
|
735
|
+
# api_access: "ENABLED", # accepts ENABLED, DISABLED
|
736
|
+
# api_access_principal_arn: "RoleArn",
|
737
|
+
# client_token: "ClientToken",
|
738
|
+
# })
|
739
|
+
#
|
740
|
+
# @example Response structure
|
741
|
+
#
|
742
|
+
# resp.user_id #=> String
|
743
|
+
#
|
744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUser AWS API Documentation
|
745
|
+
#
|
746
|
+
# @overload create_user(params = {})
|
747
|
+
# @param [Hash] params ({})
|
748
|
+
def create_user(params = {}, options = {})
|
749
|
+
req = build_request(:create_user, params)
|
750
|
+
req.send_request(options)
|
751
|
+
end
|
752
|
+
|
617
753
|
# Deletes a FinSpace Dataset.
|
618
754
|
#
|
619
755
|
# @option params [String] :client_token
|
@@ -649,6 +785,114 @@ module Aws::FinSpaceData
|
|
649
785
|
req.send_request(options)
|
650
786
|
end
|
651
787
|
|
788
|
+
# Deletes a permission group. This action is irreversible.
|
789
|
+
#
|
790
|
+
# @option params [required, String] :permission_group_id
|
791
|
+
# The unique identifier for the permission group that you want to
|
792
|
+
# delete.
|
793
|
+
#
|
794
|
+
# @option params [String] :client_token
|
795
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
796
|
+
#
|
797
|
+
# **A suitable default value is auto-generated.** You should normally
|
798
|
+
# not need to pass this option.**
|
799
|
+
#
|
800
|
+
# @return [Types::DeletePermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
801
|
+
#
|
802
|
+
# * {Types::DeletePermissionGroupResponse#permission_group_id #permission_group_id} => String
|
803
|
+
#
|
804
|
+
# @example Request syntax with placeholder values
|
805
|
+
#
|
806
|
+
# resp = client.delete_permission_group({
|
807
|
+
# permission_group_id: "PermissionGroupId", # required
|
808
|
+
# client_token: "ClientToken",
|
809
|
+
# })
|
810
|
+
#
|
811
|
+
# @example Response structure
|
812
|
+
#
|
813
|
+
# resp.permission_group_id #=> String
|
814
|
+
#
|
815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroup AWS API Documentation
|
816
|
+
#
|
817
|
+
# @overload delete_permission_group(params = {})
|
818
|
+
# @param [Hash] params ({})
|
819
|
+
def delete_permission_group(params = {}, options = {})
|
820
|
+
req = build_request(:delete_permission_group, params)
|
821
|
+
req.send_request(options)
|
822
|
+
end
|
823
|
+
|
824
|
+
# Denies access to the FinSpace web application and API for the
|
825
|
+
# specified user.
|
826
|
+
#
|
827
|
+
# @option params [required, String] :user_id
|
828
|
+
# The unique identifier for the user account that you want to disable.
|
829
|
+
#
|
830
|
+
# @option params [String] :client_token
|
831
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
832
|
+
#
|
833
|
+
# **A suitable default value is auto-generated.** You should normally
|
834
|
+
# not need to pass this option.**
|
835
|
+
#
|
836
|
+
# @return [Types::DisableUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
837
|
+
#
|
838
|
+
# * {Types::DisableUserResponse#user_id #user_id} => String
|
839
|
+
#
|
840
|
+
# @example Request syntax with placeholder values
|
841
|
+
#
|
842
|
+
# resp = client.disable_user({
|
843
|
+
# user_id: "UserId", # required
|
844
|
+
# client_token: "ClientToken",
|
845
|
+
# })
|
846
|
+
#
|
847
|
+
# @example Response structure
|
848
|
+
#
|
849
|
+
# resp.user_id #=> String
|
850
|
+
#
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser AWS API Documentation
|
852
|
+
#
|
853
|
+
# @overload disable_user(params = {})
|
854
|
+
# @param [Hash] params ({})
|
855
|
+
def disable_user(params = {}, options = {})
|
856
|
+
req = build_request(:disable_user, params)
|
857
|
+
req.send_request(options)
|
858
|
+
end
|
859
|
+
|
860
|
+
# Allows the specified user to access the FinSpace web application and
|
861
|
+
# API.
|
862
|
+
#
|
863
|
+
# @option params [required, String] :user_id
|
864
|
+
# The unique identifier for the user account that you want to enable.
|
865
|
+
#
|
866
|
+
# @option params [String] :client_token
|
867
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
868
|
+
#
|
869
|
+
# **A suitable default value is auto-generated.** You should normally
|
870
|
+
# not need to pass this option.**
|
871
|
+
#
|
872
|
+
# @return [Types::EnableUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
873
|
+
#
|
874
|
+
# * {Types::EnableUserResponse#user_id #user_id} => String
|
875
|
+
#
|
876
|
+
# @example Request syntax with placeholder values
|
877
|
+
#
|
878
|
+
# resp = client.enable_user({
|
879
|
+
# user_id: "UserId", # required
|
880
|
+
# client_token: "ClientToken",
|
881
|
+
# })
|
882
|
+
#
|
883
|
+
# @example Response structure
|
884
|
+
#
|
885
|
+
# resp.user_id #=> String
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUser AWS API Documentation
|
888
|
+
#
|
889
|
+
# @overload enable_user(params = {})
|
890
|
+
# @param [Hash] params ({})
|
891
|
+
def enable_user(params = {}, options = {})
|
892
|
+
req = build_request(:enable_user, params)
|
893
|
+
req.send_request(options)
|
894
|
+
end
|
895
|
+
|
652
896
|
# Get information about a Changeset.
|
653
897
|
#
|
654
898
|
# @option params [required, String] :dataset_id
|
@@ -856,6 +1100,58 @@ module Aws::FinSpaceData
|
|
856
1100
|
req.send_request(options)
|
857
1101
|
end
|
858
1102
|
|
1103
|
+
# Retrieves details for a specific user.
|
1104
|
+
#
|
1105
|
+
# @option params [required, String] :user_id
|
1106
|
+
# The unique identifier of the user to get data for.
|
1107
|
+
#
|
1108
|
+
# @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1109
|
+
#
|
1110
|
+
# * {Types::GetUserResponse#user_id #user_id} => String
|
1111
|
+
# * {Types::GetUserResponse#status #status} => String
|
1112
|
+
# * {Types::GetUserResponse#first_name #first_name} => String
|
1113
|
+
# * {Types::GetUserResponse#last_name #last_name} => String
|
1114
|
+
# * {Types::GetUserResponse#email_address #email_address} => String
|
1115
|
+
# * {Types::GetUserResponse#type #type} => String
|
1116
|
+
# * {Types::GetUserResponse#api_access #api_access} => String
|
1117
|
+
# * {Types::GetUserResponse#api_access_principal_arn #api_access_principal_arn} => String
|
1118
|
+
# * {Types::GetUserResponse#create_time #create_time} => Integer
|
1119
|
+
# * {Types::GetUserResponse#last_enabled_time #last_enabled_time} => Integer
|
1120
|
+
# * {Types::GetUserResponse#last_disabled_time #last_disabled_time} => Integer
|
1121
|
+
# * {Types::GetUserResponse#last_modified_time #last_modified_time} => Integer
|
1122
|
+
# * {Types::GetUserResponse#last_login_time #last_login_time} => Integer
|
1123
|
+
#
|
1124
|
+
# @example Request syntax with placeholder values
|
1125
|
+
#
|
1126
|
+
# resp = client.get_user({
|
1127
|
+
# user_id: "UserId", # required
|
1128
|
+
# })
|
1129
|
+
#
|
1130
|
+
# @example Response structure
|
1131
|
+
#
|
1132
|
+
# resp.user_id #=> String
|
1133
|
+
# resp.status #=> String, one of "CREATING", "ENABLED", "DISABLED"
|
1134
|
+
# resp.first_name #=> String
|
1135
|
+
# resp.last_name #=> String
|
1136
|
+
# resp.email_address #=> String
|
1137
|
+
# resp.type #=> String, one of "SUPER_USER", "APP_USER"
|
1138
|
+
# resp.api_access #=> String, one of "ENABLED", "DISABLED"
|
1139
|
+
# resp.api_access_principal_arn #=> String
|
1140
|
+
# resp.create_time #=> Integer
|
1141
|
+
# resp.last_enabled_time #=> Integer
|
1142
|
+
# resp.last_disabled_time #=> Integer
|
1143
|
+
# resp.last_modified_time #=> Integer
|
1144
|
+
# resp.last_login_time #=> Integer
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUser AWS API Documentation
|
1147
|
+
#
|
1148
|
+
# @overload get_user(params = {})
|
1149
|
+
# @param [Hash] params ({})
|
1150
|
+
def get_user(params = {}, options = {})
|
1151
|
+
req = build_request(:get_user, params)
|
1152
|
+
req.send_request(options)
|
1153
|
+
end
|
1154
|
+
|
859
1155
|
# A temporary Amazon S3 location, where you can copy your files from a
|
860
1156
|
# source location to stage or use as a scratch space in FinSpace
|
861
1157
|
# notebook.
|
@@ -863,11 +1159,11 @@ module Aws::FinSpaceData
|
|
863
1159
|
# @option params [String] :location_type
|
864
1160
|
# Specify the type of the working location.
|
865
1161
|
#
|
866
|
-
# * `SAGEMAKER`
|
1162
|
+
# * `SAGEMAKER` – Use the Amazon S3 location as a temporary location to
|
867
1163
|
# store data content when working with FinSpace Notebooks that run on
|
868
1164
|
# SageMaker studio.
|
869
1165
|
#
|
870
|
-
# * `INGESTION`
|
1166
|
+
# * `INGESTION` – Use the Amazon S3 location as a staging location to
|
871
1167
|
# copy your data content and then use the location with the Changeset
|
872
1168
|
# creation operation.
|
873
1169
|
#
|
@@ -908,7 +1204,7 @@ module Aws::FinSpaceData
|
|
908
1204
|
# The maximum number of results per page.
|
909
1205
|
#
|
910
1206
|
# @option params [String] :next_token
|
911
|
-
# A token
|
1207
|
+
# A token that indicates where a results page should begin.
|
912
1208
|
#
|
913
1209
|
# @return [Types::ListChangesetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
914
1210
|
#
|
@@ -961,7 +1257,7 @@ module Aws::FinSpaceData
|
|
961
1257
|
# The unique identifier of the Dataset for which to retrieve Dataviews.
|
962
1258
|
#
|
963
1259
|
# @option params [String] :next_token
|
964
|
-
# A token
|
1260
|
+
# A token that indicates where a results page should begin.
|
965
1261
|
#
|
966
1262
|
# @option params [Integer] :max_results
|
967
1263
|
# The maximum number of results per page.
|
@@ -1016,7 +1312,7 @@ module Aws::FinSpaceData
|
|
1016
1312
|
# Lists all of the active Datasets that a user has access to.
|
1017
1313
|
#
|
1018
1314
|
# @option params [String] :next_token
|
1019
|
-
# A token
|
1315
|
+
# A token that indicates where a results page should begin.
|
1020
1316
|
#
|
1021
1317
|
# @option params [Integer] :max_results
|
1022
1318
|
# The maximum number of results per page.
|
@@ -1066,6 +1362,139 @@ module Aws::FinSpaceData
|
|
1066
1362
|
req.send_request(options)
|
1067
1363
|
end
|
1068
1364
|
|
1365
|
+
# Lists all available permission groups in FinSpace.
|
1366
|
+
#
|
1367
|
+
# @option params [String] :next_token
|
1368
|
+
# A token that indicates where a results page should begin.
|
1369
|
+
#
|
1370
|
+
# @option params [required, Integer] :max_results
|
1371
|
+
# The maximum number of results per page.
|
1372
|
+
#
|
1373
|
+
# @return [Types::ListPermissionGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1374
|
+
#
|
1375
|
+
# * {Types::ListPermissionGroupsResponse#permission_groups #permission_groups} => Array<Types::PermissionGroup>
|
1376
|
+
# * {Types::ListPermissionGroupsResponse#next_token #next_token} => String
|
1377
|
+
#
|
1378
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1379
|
+
#
|
1380
|
+
# @example Request syntax with placeholder values
|
1381
|
+
#
|
1382
|
+
# resp = client.list_permission_groups({
|
1383
|
+
# next_token: "PaginationToken",
|
1384
|
+
# max_results: 1, # required
|
1385
|
+
# })
|
1386
|
+
#
|
1387
|
+
# @example Response structure
|
1388
|
+
#
|
1389
|
+
# resp.permission_groups #=> Array
|
1390
|
+
# resp.permission_groups[0].permission_group_id #=> String
|
1391
|
+
# resp.permission_groups[0].name #=> String
|
1392
|
+
# resp.permission_groups[0].description #=> String
|
1393
|
+
# resp.permission_groups[0].application_permissions #=> Array
|
1394
|
+
# resp.permission_groups[0].application_permissions[0] #=> String, one of "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials"
|
1395
|
+
# resp.permission_groups[0].create_time #=> Integer
|
1396
|
+
# resp.permission_groups[0].last_modified_time #=> Integer
|
1397
|
+
# resp.next_token #=> String
|
1398
|
+
#
|
1399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups AWS API Documentation
|
1400
|
+
#
|
1401
|
+
# @overload list_permission_groups(params = {})
|
1402
|
+
# @param [Hash] params ({})
|
1403
|
+
def list_permission_groups(params = {}, options = {})
|
1404
|
+
req = build_request(:list_permission_groups, params)
|
1405
|
+
req.send_request(options)
|
1406
|
+
end
|
1407
|
+
|
1408
|
+
# Lists all available user accounts in FinSpace.
|
1409
|
+
#
|
1410
|
+
# @option params [String] :next_token
|
1411
|
+
# A token that indicates where a results page should begin.
|
1412
|
+
#
|
1413
|
+
# @option params [required, Integer] :max_results
|
1414
|
+
# The maximum number of results per page.
|
1415
|
+
#
|
1416
|
+
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1417
|
+
#
|
1418
|
+
# * {Types::ListUsersResponse#users #users} => Array<Types::User>
|
1419
|
+
# * {Types::ListUsersResponse#next_token #next_token} => String
|
1420
|
+
#
|
1421
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1422
|
+
#
|
1423
|
+
# @example Request syntax with placeholder values
|
1424
|
+
#
|
1425
|
+
# resp = client.list_users({
|
1426
|
+
# next_token: "PaginationToken",
|
1427
|
+
# max_results: 1, # required
|
1428
|
+
# })
|
1429
|
+
#
|
1430
|
+
# @example Response structure
|
1431
|
+
#
|
1432
|
+
# resp.users #=> Array
|
1433
|
+
# resp.users[0].user_id #=> String
|
1434
|
+
# resp.users[0].status #=> String, one of "CREATING", "ENABLED", "DISABLED"
|
1435
|
+
# resp.users[0].first_name #=> String
|
1436
|
+
# resp.users[0].last_name #=> String
|
1437
|
+
# resp.users[0].email_address #=> String
|
1438
|
+
# resp.users[0].type #=> String, one of "SUPER_USER", "APP_USER"
|
1439
|
+
# resp.users[0].api_access #=> String, one of "ENABLED", "DISABLED"
|
1440
|
+
# resp.users[0].api_access_principal_arn #=> String
|
1441
|
+
# resp.users[0].create_time #=> Integer
|
1442
|
+
# resp.users[0].last_enabled_time #=> Integer
|
1443
|
+
# resp.users[0].last_disabled_time #=> Integer
|
1444
|
+
# resp.users[0].last_modified_time #=> Integer
|
1445
|
+
# resp.users[0].last_login_time #=> Integer
|
1446
|
+
# resp.next_token #=> String
|
1447
|
+
#
|
1448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsers AWS API Documentation
|
1449
|
+
#
|
1450
|
+
# @overload list_users(params = {})
|
1451
|
+
# @param [Hash] params ({})
|
1452
|
+
def list_users(params = {}, options = {})
|
1453
|
+
req = build_request(:list_users, params)
|
1454
|
+
req.send_request(options)
|
1455
|
+
end
|
1456
|
+
|
1457
|
+
# Resets the password for a specified user ID and generates a temporary
|
1458
|
+
# one. Only a superuser can reset password for other users. Resetting
|
1459
|
+
# the password immediately invalidates the previous password associated
|
1460
|
+
# with the user.
|
1461
|
+
#
|
1462
|
+
# @option params [required, String] :user_id
|
1463
|
+
# The unique identifier of the user that a temporary password is
|
1464
|
+
# requested for.
|
1465
|
+
#
|
1466
|
+
# @option params [String] :client_token
|
1467
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1468
|
+
#
|
1469
|
+
# **A suitable default value is auto-generated.** You should normally
|
1470
|
+
# not need to pass this option.**
|
1471
|
+
#
|
1472
|
+
# @return [Types::ResetUserPasswordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1473
|
+
#
|
1474
|
+
# * {Types::ResetUserPasswordResponse#user_id #user_id} => String
|
1475
|
+
# * {Types::ResetUserPasswordResponse#temporary_password #temporary_password} => String
|
1476
|
+
#
|
1477
|
+
# @example Request syntax with placeholder values
|
1478
|
+
#
|
1479
|
+
# resp = client.reset_user_password({
|
1480
|
+
# user_id: "UserId", # required
|
1481
|
+
# client_token: "ClientToken",
|
1482
|
+
# })
|
1483
|
+
#
|
1484
|
+
# @example Response structure
|
1485
|
+
#
|
1486
|
+
# resp.user_id #=> String
|
1487
|
+
# resp.temporary_password #=> String
|
1488
|
+
#
|
1489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPassword AWS API Documentation
|
1490
|
+
#
|
1491
|
+
# @overload reset_user_password(params = {})
|
1492
|
+
# @param [Hash] params ({})
|
1493
|
+
def reset_user_password(params = {}, options = {})
|
1494
|
+
req = build_request(:reset_user_password, params)
|
1495
|
+
req.send_request(options)
|
1496
|
+
end
|
1497
|
+
|
1069
1498
|
# Updates a FinSpace Changeset.
|
1070
1499
|
#
|
1071
1500
|
# @option params [String] :client_token
|
@@ -1110,13 +1539,13 @@ module Aws::FinSpaceData
|
|
1110
1539
|
# `formatType` is a required attribute and can have the following
|
1111
1540
|
# values:
|
1112
1541
|
#
|
1113
|
-
# * `PARQUET`
|
1542
|
+
# * `PARQUET` – Parquet source file format.
|
1114
1543
|
#
|
1115
|
-
# * `CSV`
|
1544
|
+
# * `CSV` – CSV source file format.
|
1116
1545
|
#
|
1117
|
-
# * `JSON`
|
1546
|
+
# * `JSON` – JSON source file format.
|
1118
1547
|
#
|
1119
|
-
# * `XML`
|
1548
|
+
# * `XML` – XML source file format.
|
1120
1549
|
#
|
1121
1550
|
# Here is an example of how you could specify the `formatParams`\:
|
1122
1551
|
#
|
@@ -1185,9 +1614,9 @@ module Aws::FinSpaceData
|
|
1185
1614
|
# @option params [required, String] :kind
|
1186
1615
|
# The format in which the Dataset data is structured.
|
1187
1616
|
#
|
1188
|
-
# * `TABULAR`
|
1617
|
+
# * `TABULAR` – Data is structured in a tabular format.
|
1189
1618
|
#
|
1190
|
-
# * `NON_TABULAR`
|
1619
|
+
# * `NON_TABULAR` – Data is structured in a non-tabular format.
|
1191
1620
|
#
|
1192
1621
|
# @option params [String] :dataset_description
|
1193
1622
|
# A description for the Dataset.
|
@@ -1238,6 +1667,144 @@ module Aws::FinSpaceData
|
|
1238
1667
|
req.send_request(options)
|
1239
1668
|
end
|
1240
1669
|
|
1670
|
+
# Modifies the details of a permission group. You cannot modify a
|
1671
|
+
# `permissionGroupID`.
|
1672
|
+
#
|
1673
|
+
# @option params [required, String] :permission_group_id
|
1674
|
+
# The unique identifier for the permission group to update.
|
1675
|
+
#
|
1676
|
+
# @option params [String] :name
|
1677
|
+
# The name of the permission group.
|
1678
|
+
#
|
1679
|
+
# @option params [String] :description
|
1680
|
+
# A brief description for the permission group.
|
1681
|
+
#
|
1682
|
+
# @option params [Array<String>] :application_permissions
|
1683
|
+
# The permissions that are granted to a specific group for accessing the
|
1684
|
+
# FinSpace application.
|
1685
|
+
#
|
1686
|
+
# * `CreateDataset` – Group members can create new datasets.
|
1687
|
+
#
|
1688
|
+
# * `ManageClusters` – Group members can manage Apache Spark clusters
|
1689
|
+
# from FinSpace notebooks.
|
1690
|
+
#
|
1691
|
+
# * `ManageUsersAndGroups` – Group members can manage users and
|
1692
|
+
# permission groups.
|
1693
|
+
#
|
1694
|
+
# * `ManageAttributeSets` – Group members can manage attribute sets.
|
1695
|
+
#
|
1696
|
+
# * `ViewAuditData` – Group members can view audit data.
|
1697
|
+
#
|
1698
|
+
# * `AccessNotebooks` – Group members will have access to FinSpace
|
1699
|
+
# notebooks.
|
1700
|
+
#
|
1701
|
+
# * `GetTemporaryCredentials` – Group members can get temporary API
|
1702
|
+
# credentials.
|
1703
|
+
#
|
1704
|
+
# @option params [String] :client_token
|
1705
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1706
|
+
#
|
1707
|
+
# **A suitable default value is auto-generated.** You should normally
|
1708
|
+
# not need to pass this option.**
|
1709
|
+
#
|
1710
|
+
# @return [Types::UpdatePermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1711
|
+
#
|
1712
|
+
# * {Types::UpdatePermissionGroupResponse#permission_group_id #permission_group_id} => String
|
1713
|
+
#
|
1714
|
+
# @example Request syntax with placeholder values
|
1715
|
+
#
|
1716
|
+
# resp = client.update_permission_group({
|
1717
|
+
# permission_group_id: "PermissionGroupId", # required
|
1718
|
+
# name: "PermissionGroupName",
|
1719
|
+
# description: "PermissionGroupDescription",
|
1720
|
+
# application_permissions: ["CreateDataset"], # accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
|
1721
|
+
# client_token: "ClientToken",
|
1722
|
+
# })
|
1723
|
+
#
|
1724
|
+
# @example Response structure
|
1725
|
+
#
|
1726
|
+
# resp.permission_group_id #=> String
|
1727
|
+
#
|
1728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroup AWS API Documentation
|
1729
|
+
#
|
1730
|
+
# @overload update_permission_group(params = {})
|
1731
|
+
# @param [Hash] params ({})
|
1732
|
+
def update_permission_group(params = {}, options = {})
|
1733
|
+
req = build_request(:update_permission_group, params)
|
1734
|
+
req.send_request(options)
|
1735
|
+
end
|
1736
|
+
|
1737
|
+
# Modifies the details of the specified user account. You cannot update
|
1738
|
+
# the `userId` for a user.
|
1739
|
+
#
|
1740
|
+
# @option params [required, String] :user_id
|
1741
|
+
# The unique identifier for the user account to update.
|
1742
|
+
#
|
1743
|
+
# @option params [String] :type
|
1744
|
+
# The option to indicate the type of user.
|
1745
|
+
#
|
1746
|
+
# * `SUPER_USER`– A user with permission to all the functionality and
|
1747
|
+
# data in FinSpace.
|
1748
|
+
#
|
1749
|
+
# * `APP_USER` – A user with specific permissions in FinSpace. The users
|
1750
|
+
# are assigned permissions by adding them to a permissions group.
|
1751
|
+
#
|
1752
|
+
# @option params [String] :first_name
|
1753
|
+
# The first name of the user.
|
1754
|
+
#
|
1755
|
+
# @option params [String] :last_name
|
1756
|
+
# The last name of the user.
|
1757
|
+
#
|
1758
|
+
# @option params [String] :api_access
|
1759
|
+
# The option to indicate whether the user can use the
|
1760
|
+
# `GetProgrammaticAccessCredentials` API to obtain credentials that can
|
1761
|
+
# then be used to access other FinSpace Data API operations.
|
1762
|
+
#
|
1763
|
+
# * `ENABLED` – The user has permissions to use the APIs.
|
1764
|
+
#
|
1765
|
+
# * `DISABLED` – The user does not have permissions to use any APIs.
|
1766
|
+
#
|
1767
|
+
# @option params [String] :api_access_principal_arn
|
1768
|
+
# The ARN identifier of an AWS user or role that is allowed to call the
|
1769
|
+
# `GetProgrammaticAccessCredentials` API to obtain a credentials token
|
1770
|
+
# for a specific FinSpace user. This must be an IAM role within your
|
1771
|
+
# FinSpace account.
|
1772
|
+
#
|
1773
|
+
# @option params [String] :client_token
|
1774
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1775
|
+
#
|
1776
|
+
# **A suitable default value is auto-generated.** You should normally
|
1777
|
+
# not need to pass this option.**
|
1778
|
+
#
|
1779
|
+
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1780
|
+
#
|
1781
|
+
# * {Types::UpdateUserResponse#user_id #user_id} => String
|
1782
|
+
#
|
1783
|
+
# @example Request syntax with placeholder values
|
1784
|
+
#
|
1785
|
+
# resp = client.update_user({
|
1786
|
+
# user_id: "UserId", # required
|
1787
|
+
# type: "SUPER_USER", # accepts SUPER_USER, APP_USER
|
1788
|
+
# first_name: "FirstName",
|
1789
|
+
# last_name: "LastName",
|
1790
|
+
# api_access: "ENABLED", # accepts ENABLED, DISABLED
|
1791
|
+
# api_access_principal_arn: "RoleArn",
|
1792
|
+
# client_token: "ClientToken",
|
1793
|
+
# })
|
1794
|
+
#
|
1795
|
+
# @example Response structure
|
1796
|
+
#
|
1797
|
+
# resp.user_id #=> String
|
1798
|
+
#
|
1799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUser AWS API Documentation
|
1800
|
+
#
|
1801
|
+
# @overload update_user(params = {})
|
1802
|
+
# @param [Hash] params ({})
|
1803
|
+
def update_user(params = {}, options = {})
|
1804
|
+
req = build_request(:update_user, params)
|
1805
|
+
req.send_request(options)
|
1806
|
+
end
|
1807
|
+
|
1241
1808
|
# @!endgroup
|
1242
1809
|
|
1243
1810
|
# @param params ({})
|
@@ -1251,7 +1818,7 @@ module Aws::FinSpaceData
|
|
1251
1818
|
params: params,
|
1252
1819
|
config: config)
|
1253
1820
|
context[:gem_name] = 'aws-sdk-finspacedata'
|
1254
|
-
context[:gem_version] = '1.
|
1821
|
+
context[:gem_version] = '1.14.0'
|
1255
1822
|
Seahorse::Client::Request.new(handlers, context)
|
1256
1823
|
end
|
1257
1824
|
|