aws-sdk-finspacedata 1.13.0 → 1.16.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -23,6 +23,52 @@ module Aws::FinSpaceData
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # @note When making an API call, you may pass AssociateUserToPermissionGroupRequest
27
+ # data as a hash:
28
+ #
29
+ # {
30
+ # permission_group_id: "PermissionGroupId", # required
31
+ # user_id: "UserId", # required
32
+ # client_token: "ClientToken",
33
+ # }
34
+ #
35
+ # @!attribute [rw] permission_group_id
36
+ # The unique identifier for the permission group.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] user_id
40
+ # The unique identifier for the user.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] client_token
44
+ # A token that ensures idempotency. This token expires in 10 minutes.
45
+ #
46
+ # **A suitable default value is auto-generated.** You should normally
47
+ # not need to pass this option.
48
+ # @return [String]
49
+ #
50
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroupRequest AWS API Documentation
51
+ #
52
+ class AssociateUserToPermissionGroupRequest < Struct.new(
53
+ :permission_group_id,
54
+ :user_id,
55
+ :client_token)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
60
+ # @!attribute [rw] status_code
61
+ # The returned status code of the response.
62
+ # @return [Integer]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroupResponse AWS API Documentation
65
+ #
66
+ class AssociateUserToPermissionGroupResponse < Struct.new(
67
+ :status_code)
68
+ SENSITIVE = []
69
+ include Aws::Structure
70
+ end
71
+
26
72
  # The structure with error messages.
27
73
  #
28
74
  # @!attribute [rw] error_message
@@ -32,26 +78,26 @@ module Aws::FinSpaceData
32
78
  # @!attribute [rw] error_category
33
79
  # The category of the error.
34
80
  #
35
- # * `VALIDATION` -The inputs to this request are invalid.
81
+ # * `VALIDATION` The inputs to this request are invalid.
36
82
  #
37
- # * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
83
+ # * `SERVICE_QUOTA_EXCEEDED` Service quotas have been exceeded.
38
84
  # Please contact AWS support to increase quotas.
39
85
  #
40
- # * `ACCESS_DENIED` - Missing required permission to perform this
86
+ # * `ACCESS_DENIED` Missing required permission to perform this
41
87
  # request.
42
88
  #
43
- # * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
89
+ # * `RESOURCE_NOT_FOUND` One or more inputs to this request were not
44
90
  # found.
45
91
  #
46
- # * `THROTTLING` - The system temporarily lacks sufficient resources
92
+ # * `THROTTLING` The system temporarily lacks sufficient resources
47
93
  # to process the request.
48
94
  #
49
- # * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
95
+ # * `INTERNAL_SERVICE_EXCEPTION` An internal service error has
50
96
  # occurred.
51
97
  #
52
- # * `CANCELLED` - Cancelled.
98
+ # * `CANCELLED` Cancelled.
53
99
  #
54
- # * `USER_RECOVERABLE` - A user recoverable error has occurred.
100
+ # * `USER_RECOVERABLE` A user recoverable error has occurred.
55
101
  # @return [String]
56
102
  #
57
103
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ChangesetErrorInfo AWS API Documentation
@@ -81,13 +127,13 @@ module Aws::FinSpaceData
81
127
  # @!attribute [rw] change_type
82
128
  # Type that indicates how a Changeset is applied to a Dataset.
83
129
  #
84
- # * `REPLACE` - Changeset is considered as a replacement to all prior
130
+ # * `REPLACE` Changeset is considered as a replacement to all prior
85
131
  # loaded Changesets.
86
132
  #
87
- # * `APPEND` - Changeset is considered as an addition to the end of
133
+ # * `APPEND` Changeset is considered as an addition to the end of
88
134
  # all prior loaded Changesets.
89
135
  #
90
- # * `MODIFY` - Changeset is considered as a replacement to a specific
136
+ # * `MODIFY` Changeset is considered as a replacement to a specific
91
137
  # prior ingested Changeset.
92
138
  # @return [String]
93
139
  #
@@ -101,7 +147,7 @@ module Aws::FinSpaceData
101
147
  #
102
148
  # @!attribute [rw] create_time
103
149
  # The timestamp at which the Changeset was created in FinSpace. The
104
- # value is determined as Epoch time in milliseconds. For example, the
150
+ # value is determined as epoch time in milliseconds. For example, the
105
151
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
106
152
  # 1635768000000.
107
153
  # @return [Integer]
@@ -109,15 +155,15 @@ module Aws::FinSpaceData
109
155
  # @!attribute [rw] status
110
156
  # Status of the Changeset ingestion.
111
157
  #
112
- # * `PENDING` - Changeset is pending creation.
158
+ # * `PENDING` Changeset is pending creation.
113
159
  #
114
- # * `FAILED` - Changeset creation has failed.
160
+ # * `FAILED` Changeset creation has failed.
115
161
  #
116
- # * `SUCCESS` - Changeset creation has succeeded.
162
+ # * `SUCCESS` Changeset creation has succeeded.
117
163
  #
118
- # * `RUNNING` - Changeset creation is running.
164
+ # * `RUNNING` Changeset creation is running.
119
165
  #
120
- # * `STOP_REQUESTED` - User requested Changeset creation to stop.
166
+ # * `STOP_REQUESTED` User requested Changeset creation to stop.
121
167
  # @return [String]
122
168
  #
123
169
  # @!attribute [rw] error_info
@@ -126,13 +172,13 @@ module Aws::FinSpaceData
126
172
  #
127
173
  # @!attribute [rw] active_until_timestamp
128
174
  # Time until which the Changeset is active. The value is determined as
129
- # Epoch time in milliseconds. For example, the value for Monday,
175
+ # epoch time in milliseconds. For example, the value for Monday,
130
176
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
131
177
  # @return [Integer]
132
178
  #
133
179
  # @!attribute [rw] active_from_timestamp
134
180
  # Beginning time from which the Changeset is active. The value is
135
- # determined as Epoch time in milliseconds. For example, the value for
181
+ # determined as epoch time in milliseconds. For example, the value for
136
182
  # Monday, November 1, 2021 12:00:00 PM UTC is specified as
137
183
  # 1635768000000.
138
184
  # @return [Integer]
@@ -179,33 +225,33 @@ module Aws::FinSpaceData
179
225
  # @!attribute [rw] data_type
180
226
  # Data type of a column.
181
227
  #
182
- # * `STRING` - A String data type.
228
+ # * `STRING` A String data type.
183
229
  #
184
- # `CHAR` - A char data type.
230
+ # `CHAR` A char data type.
185
231
  #
186
- # `INTEGER` - An integer data type.
232
+ # `INTEGER` An integer data type.
187
233
  #
188
- # `TINYINT` - A tinyint data type.
234
+ # `TINYINT` A tinyint data type.
189
235
  #
190
- # `SMALLINT` - A smallint data type.
236
+ # `SMALLINT` A smallint data type.
191
237
  #
192
- # `BIGINT` - A bigint data type.
238
+ # `BIGINT` A bigint data type.
193
239
  #
194
- # `FLOAT` - A float data type.
240
+ # `FLOAT` A float data type.
195
241
  #
196
- # `DOUBLE` - A double data type.
242
+ # `DOUBLE` A double data type.
197
243
  #
198
- # `DATE` - A date data type.
244
+ # `DATE` A date data type.
199
245
  #
200
- # `DATETIME` - A datetime data type.
246
+ # `DATETIME` A datetime data type.
201
247
  #
202
- # `BOOLEAN` - A boolean data type.
248
+ # `BOOLEAN` A boolean data type.
203
249
  #
204
- # `BINARY` - A binary data type.
250
+ # `BINARY` A binary data type.
205
251
  # @return [String]
206
252
  #
207
253
  # @!attribute [rw] column_name
208
- # Name for a column.
254
+ # The name of a column.
209
255
  # @return [String]
210
256
  #
211
257
  # @!attribute [rw] column_description
@@ -227,10 +273,14 @@ module Aws::FinSpaceData
227
273
  # @!attribute [rw] message
228
274
  # @return [String]
229
275
  #
276
+ # @!attribute [rw] reason
277
+ # @return [String]
278
+ #
230
279
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ConflictException AWS API Documentation
231
280
  #
232
281
  class ConflictException < Struct.new(
233
- :message)
282
+ :message,
283
+ :reason)
234
284
  SENSITIVE = []
235
285
  include Aws::Structure
236
286
  end
@@ -265,15 +315,15 @@ module Aws::FinSpaceData
265
315
  # @return [String]
266
316
  #
267
317
  # @!attribute [rw] change_type
268
- # Option to indicate how a Changeset will be applied to a Dataset.
318
+ # The option to indicate how a Changeset will be applied to a Dataset.
269
319
  #
270
- # * `REPLACE` - Changeset will be considered as a replacement to all
320
+ # * `REPLACE` Changeset will be considered as a replacement to all
271
321
  # prior loaded Changesets.
272
322
  #
273
- # * `APPEND` - Changeset will be considered as an addition to the end
323
+ # * `APPEND` Changeset will be considered as an addition to the end
274
324
  # of all prior loaded Changesets.
275
325
  #
276
- # * `MODIFY` - Changeset is considered as a replacement to a specific
326
+ # * `MODIFY` Changeset is considered as a replacement to a specific
277
327
  # prior ingested Changeset.
278
328
  # @return [String]
279
329
  #
@@ -292,7 +342,7 @@ module Aws::FinSpaceData
292
342
  # The S3 path that you specify must allow the FinSpace role access. To
293
343
  # do that, you first need to configure the IAM policy on S3 bucket.
294
344
  # For more information, see [Loading data from an Amazon S3 Bucket
295
- # using the FinSpace API][1]section.
345
+ # using the FinSpace API][1] section.
296
346
  #
297
347
  #
298
348
  #
@@ -308,13 +358,13 @@ module Aws::FinSpaceData
308
358
  # `formatType` is a required attribute and can have the following
309
359
  # values:
310
360
  #
311
- # * `PARQUET` - Parquet source file format.
361
+ # * `PARQUET` Parquet source file format.
312
362
  #
313
- # * `CSV` - CSV source file format.
363
+ # * `CSV` CSV source file format.
314
364
  #
315
- # * `JSON` - JSON source file format.
365
+ # * `JSON` JSON source file format.
316
366
  #
317
- # * `XML` - XML source file format.
367
+ # * `XML` XML source file format.
318
368
  #
319
369
  # Here is an example of how you could specify the `formatParams`\:
320
370
  #
@@ -412,7 +462,7 @@ module Aws::FinSpaceData
412
462
  #
413
463
  # @!attribute [rw] as_of_timestamp
414
464
  # Beginning time to use for the Dataview. The value is determined as
415
- # Epoch time in milliseconds. For example, the value for Monday,
465
+ # epoch time in milliseconds. For example, the value for Monday,
416
466
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
417
467
  # @return [Integer]
418
468
  #
@@ -505,9 +555,9 @@ module Aws::FinSpaceData
505
555
  # @!attribute [rw] kind
506
556
  # The format in which Dataset data is structured.
507
557
  #
508
- # * `TABULAR` - Data is structured in a tabular format.
558
+ # * `TABULAR` Data is structured in a tabular format.
509
559
  #
510
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
560
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
511
561
  # @return [String]
512
562
  #
513
563
  # @!attribute [rw] dataset_description
@@ -559,6 +609,166 @@ module Aws::FinSpaceData
559
609
  include Aws::Structure
560
610
  end
561
611
 
612
+ # @note When making an API call, you may pass CreatePermissionGroupRequest
613
+ # data as a hash:
614
+ #
615
+ # {
616
+ # name: "PermissionGroupName", # required
617
+ # description: "PermissionGroupDescription",
618
+ # application_permissions: ["CreateDataset"], # required, accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
619
+ # client_token: "ClientToken",
620
+ # }
621
+ #
622
+ # @!attribute [rw] name
623
+ # The name of the permission group.
624
+ # @return [String]
625
+ #
626
+ # @!attribute [rw] description
627
+ # A brief description for the permission group.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] application_permissions
631
+ # The option to indicate FinSpace application permissions that are
632
+ # granted to a specific group.
633
+ #
634
+ # * `CreateDataset` – Group members can create new datasets.
635
+ #
636
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
637
+ # from FinSpace notebooks.
638
+ #
639
+ # * `ManageUsersAndGroups` – Group members can manage users and
640
+ # permission groups.
641
+ #
642
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
643
+ #
644
+ # * `ViewAuditData` – Group members can view audit data.
645
+ #
646
+ # * `AccessNotebooks` – Group members will have access to FinSpace
647
+ # notebooks.
648
+ #
649
+ # * `GetTemporaryCredentials` – Group members can get temporary API
650
+ # credentials.
651
+ # @return [Array<String>]
652
+ #
653
+ # @!attribute [rw] client_token
654
+ # A token that ensures idempotency. This token expires in 10 minutes.
655
+ #
656
+ # **A suitable default value is auto-generated.** You should normally
657
+ # not need to pass this option.
658
+ # @return [String]
659
+ #
660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroupRequest AWS API Documentation
661
+ #
662
+ class CreatePermissionGroupRequest < Struct.new(
663
+ :name,
664
+ :description,
665
+ :application_permissions,
666
+ :client_token)
667
+ SENSITIVE = [:name, :description]
668
+ include Aws::Structure
669
+ end
670
+
671
+ # @!attribute [rw] permission_group_id
672
+ # The unique identifier for the permission group.
673
+ # @return [String]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroupResponse AWS API Documentation
676
+ #
677
+ class CreatePermissionGroupResponse < Struct.new(
678
+ :permission_group_id)
679
+ SENSITIVE = []
680
+ include Aws::Structure
681
+ end
682
+
683
+ # @note When making an API call, you may pass CreateUserRequest
684
+ # data as a hash:
685
+ #
686
+ # {
687
+ # email_address: "Email", # required
688
+ # type: "SUPER_USER", # required, accepts SUPER_USER, APP_USER
689
+ # first_name: "FirstName",
690
+ # last_name: "LastName",
691
+ # api_access: "ENABLED", # accepts ENABLED, DISABLED
692
+ # api_access_principal_arn: "RoleArn",
693
+ # client_token: "ClientToken",
694
+ # }
695
+ #
696
+ # @!attribute [rw] email_address
697
+ # The email address of the user that you want to register. The email
698
+ # address serves as a uniquer identifier for each user and cannot be
699
+ # changed after it's created.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] type
703
+ # The option to indicate the type of user. Use one of the following
704
+ # options to specify this parameter:
705
+ #
706
+ # * `SUPER_USER` – A user with permission to all the functionality and
707
+ # data in FinSpace.
708
+ #
709
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
710
+ # users are assigned permissions by adding them to a permission
711
+ # group.
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] first_name
715
+ # The first name of the user that you want to register.
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] last_name
719
+ # The last name of the user that you want to register.
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] api_access
723
+ # The option to indicate whether the user can use the
724
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
725
+ # can then be used to access other FinSpace Data API operations.
726
+ #
727
+ # * `ENABLED` – The user has permissions to use the APIs.
728
+ #
729
+ # * `DISABLED` – The user does not have permissions to use any APIs.
730
+ # @return [String]
731
+ #
732
+ # @!attribute [rw] api_access_principal_arn
733
+ # The ARN identifier of an AWS user or role that is allowed to call
734
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
735
+ # token for a specific FinSpace user. This must be an IAM role within
736
+ # your FinSpace account.
737
+ # @return [String]
738
+ #
739
+ # @!attribute [rw] client_token
740
+ # A token that ensures idempotency. This token expires in 10 minutes.
741
+ #
742
+ # **A suitable default value is auto-generated.** You should normally
743
+ # not need to pass this option.
744
+ # @return [String]
745
+ #
746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUserRequest AWS API Documentation
747
+ #
748
+ class CreateUserRequest < Struct.new(
749
+ :email_address,
750
+ :type,
751
+ :first_name,
752
+ :last_name,
753
+ :api_access,
754
+ :api_access_principal_arn,
755
+ :client_token)
756
+ SENSITIVE = [:email_address, :first_name, :last_name]
757
+ include Aws::Structure
758
+ end
759
+
760
+ # @!attribute [rw] user_id
761
+ # The unique identifier for the user.
762
+ # @return [String]
763
+ #
764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUserResponse AWS API Documentation
765
+ #
766
+ class CreateUserResponse < Struct.new(
767
+ :user_id)
768
+ SENSITIVE = []
769
+ include Aws::Structure
770
+ end
771
+
562
772
  # Short term API credentials.
563
773
  #
564
774
  # @!attribute [rw] access_key_id
@@ -599,17 +809,17 @@ module Aws::FinSpaceData
599
809
  # @!attribute [rw] destination_type
600
810
  # Destination type for a Dataview.
601
811
  #
602
- # * `GLUE_TABLE` - Glue table destination type.
812
+ # * `GLUE_TABLE` Glue table destination type.
603
813
  #
604
- # * `S3` - S3 destination type.
814
+ # * `S3` S3 destination type.
605
815
  # @return [String]
606
816
  #
607
817
  # @!attribute [rw] s3_destination_export_file_format
608
- # Data view export file format.
818
+ # Dataview export file format.
609
819
  #
610
- # * `PARQUET` - Parquet export file format.
820
+ # * `PARQUET` Parquet export file format.
611
821
  #
612
- # * `DELIMITED_TEXT` - Delimited text export file format.
822
+ # * `DELIMITED_TEXT` Delimited text export file format.
613
823
  # @return [String]
614
824
  #
615
825
  # @!attribute [rw] s3_destination_export_file_format_options
@@ -640,26 +850,26 @@ module Aws::FinSpaceData
640
850
  # @!attribute [rw] error_category
641
851
  # The category of the error.
642
852
  #
643
- # * `VALIDATION` -The inputs to this request are invalid.
853
+ # * `VALIDATION` The inputs to this request are invalid.
644
854
  #
645
- # * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
855
+ # * `SERVICE_QUOTA_EXCEEDED` Service quotas have been exceeded.
646
856
  # Please contact AWS support to increase quotas.
647
857
  #
648
- # * `ACCESS_DENIED` - Missing required permission to perform this
858
+ # * `ACCESS_DENIED` Missing required permission to perform this
649
859
  # request.
650
860
  #
651
- # * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
861
+ # * `RESOURCE_NOT_FOUND` One or more inputs to this request were not
652
862
  # found.
653
863
  #
654
- # * `THROTTLING` - The system temporarily lacks sufficient resources
864
+ # * `THROTTLING` The system temporarily lacks sufficient resources
655
865
  # to process the request.
656
866
  #
657
- # * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
867
+ # * `INTERNAL_SERVICE_EXCEPTION` An internal service error has
658
868
  # occurred.
659
869
  #
660
- # * `CANCELLED` - Cancelled.
870
+ # * `CANCELLED` Cancelled.
661
871
  #
662
- # * `USER_RECOVERABLE` - A user recoverable error has occurred.
872
+ # * `USER_RECOVERABLE` A user recoverable error has occurred.
663
873
  # @return [String]
664
874
  #
665
875
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewErrorInfo AWS API Documentation
@@ -686,7 +896,7 @@ module Aws::FinSpaceData
686
896
  # @return [String]
687
897
  #
688
898
  # @!attribute [rw] as_of_timestamp
689
- # Time range to use for the Dataview. The value is determined as Epoch
899
+ # Time range to use for the Dataview. The value is determined as epoch
690
900
  # time in milliseconds. For example, the value for Monday, November 1,
691
901
  # 2021 12:00:00 PM UTC is specified as 1635768000000.
692
902
  # @return [Integer]
@@ -702,21 +912,21 @@ module Aws::FinSpaceData
702
912
  # @!attribute [rw] status
703
913
  # The status of a Dataview creation.
704
914
  #
705
- # * `RUNNING` - Dataview creation is running.
915
+ # * `RUNNING` Dataview creation is running.
706
916
  #
707
- # * `STARTING` - Dataview creation is starting.
917
+ # * `STARTING` Dataview creation is starting.
708
918
  #
709
- # * `FAILED` - Dataview creation has failed.
919
+ # * `FAILED` Dataview creation has failed.
710
920
  #
711
- # * `CANCELLED` - Dataview creation has been cancelled.
921
+ # * `CANCELLED` Dataview creation has been cancelled.
712
922
  #
713
- # * `TIMEOUT` - Dataview creation has timed out.
923
+ # * `TIMEOUT` Dataview creation has timed out.
714
924
  #
715
- # * `SUCCESS` - Dataview creation has succeeded.
925
+ # * `SUCCESS` Dataview creation has succeeded.
716
926
  #
717
- # * `PENDING` - Dataview creation is pending.
927
+ # * `PENDING` Dataview creation is pending.
718
928
  #
719
- # * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
929
+ # * `FAILED_CLEANUP_FAILED` Dataview creation failed and resource
720
930
  # cleanup failed.
721
931
  # @return [String]
722
932
  #
@@ -734,14 +944,14 @@ module Aws::FinSpaceData
734
944
  #
735
945
  # @!attribute [rw] create_time
736
946
  # The timestamp at which the Dataview was created in FinSpace. The
737
- # value is determined as Epoch time in milliseconds. For example, the
947
+ # value is determined as epoch time in milliseconds. For example, the
738
948
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
739
949
  # 1635768000000.
740
950
  # @return [Integer]
741
951
  #
742
952
  # @!attribute [rw] last_modified_time
743
953
  # The last time that a Dataview was modified. The value is determined
744
- # as Epoch time in milliseconds. For example, the value for Monday,
954
+ # as epoch time in milliseconds. For example, the value for Monday,
745
955
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
746
956
  # @return [Integer]
747
957
  #
@@ -781,9 +991,9 @@ module Aws::FinSpaceData
781
991
  # @!attribute [rw] kind
782
992
  # The format in which Dataset data is structured.
783
993
  #
784
- # * `TABULAR` - Data is structured in a tabular format.
994
+ # * `TABULAR` Data is structured in a tabular format.
785
995
  #
786
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
996
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
787
997
  # @return [String]
788
998
  #
789
999
  # @!attribute [rw] dataset_description
@@ -796,14 +1006,14 @@ module Aws::FinSpaceData
796
1006
  #
797
1007
  # @!attribute [rw] create_time
798
1008
  # The timestamp at which the Dataset was created in FinSpace. The
799
- # value is determined as Epoch time in milliseconds. For example, the
1009
+ # value is determined as epoch time in milliseconds. For example, the
800
1010
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
801
1011
  # 1635768000000.
802
1012
  # @return [Integer]
803
1013
  #
804
1014
  # @!attribute [rw] last_modified_time
805
1015
  # The last time that the Dataset was modified. The value is determined
806
- # as Epoch time in milliseconds. For example, the value for Monday,
1016
+ # as epoch time in milliseconds. For example, the value for Monday,
807
1017
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
808
1018
  # @return [Integer]
809
1019
  #
@@ -844,7 +1054,7 @@ module Aws::FinSpaceData
844
1054
  # }
845
1055
  #
846
1056
  # @!attribute [rw] name
847
- # Name of the Dataset owner.
1057
+ # The name of the Dataset owner.
848
1058
  # @return [String]
849
1059
  #
850
1060
  # @!attribute [rw] phone_number
@@ -861,7 +1071,7 @@ module Aws::FinSpaceData
861
1071
  :name,
862
1072
  :phone_number,
863
1073
  :email)
864
- SENSITIVE = []
1074
+ SENSITIVE = [:email]
865
1075
  include Aws::Structure
866
1076
  end
867
1077
 
@@ -909,6 +1119,173 @@ module Aws::FinSpaceData
909
1119
  include Aws::Structure
910
1120
  end
911
1121
 
1122
+ # @note When making an API call, you may pass DeletePermissionGroupRequest
1123
+ # data as a hash:
1124
+ #
1125
+ # {
1126
+ # permission_group_id: "PermissionGroupId", # required
1127
+ # client_token: "ClientToken",
1128
+ # }
1129
+ #
1130
+ # @!attribute [rw] permission_group_id
1131
+ # The unique identifier for the permission group that you want to
1132
+ # delete.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] client_token
1136
+ # A token that ensures idempotency. This token expires in 10 minutes.
1137
+ #
1138
+ # **A suitable default value is auto-generated.** You should normally
1139
+ # not need to pass this option.
1140
+ # @return [String]
1141
+ #
1142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroupRequest AWS API Documentation
1143
+ #
1144
+ class DeletePermissionGroupRequest < Struct.new(
1145
+ :permission_group_id,
1146
+ :client_token)
1147
+ SENSITIVE = []
1148
+ include Aws::Structure
1149
+ end
1150
+
1151
+ # @!attribute [rw] permission_group_id
1152
+ # The unique identifier for the deleted permission group.
1153
+ # @return [String]
1154
+ #
1155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroupResponse AWS API Documentation
1156
+ #
1157
+ class DeletePermissionGroupResponse < Struct.new(
1158
+ :permission_group_id)
1159
+ SENSITIVE = []
1160
+ include Aws::Structure
1161
+ end
1162
+
1163
+ # @note When making an API call, you may pass DisableUserRequest
1164
+ # data as a hash:
1165
+ #
1166
+ # {
1167
+ # user_id: "UserId", # required
1168
+ # client_token: "ClientToken",
1169
+ # }
1170
+ #
1171
+ # @!attribute [rw] user_id
1172
+ # The unique identifier for the user account that you want to disable.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] client_token
1176
+ # A token that ensures idempotency. This token expires in 10 minutes.
1177
+ #
1178
+ # **A suitable default value is auto-generated.** You should normally
1179
+ # not need to pass this option.
1180
+ # @return [String]
1181
+ #
1182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUserRequest AWS API Documentation
1183
+ #
1184
+ class DisableUserRequest < Struct.new(
1185
+ :user_id,
1186
+ :client_token)
1187
+ SENSITIVE = []
1188
+ include Aws::Structure
1189
+ end
1190
+
1191
+ # @!attribute [rw] user_id
1192
+ # The unique identifier for the disabled user account.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUserResponse AWS API Documentation
1196
+ #
1197
+ class DisableUserResponse < Struct.new(
1198
+ :user_id)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # @note When making an API call, you may pass DisassociateUserFromPermissionGroupRequest
1204
+ # data as a hash:
1205
+ #
1206
+ # {
1207
+ # permission_group_id: "PermissionGroupId", # required
1208
+ # user_id: "UserId", # required
1209
+ # client_token: "ClientToken",
1210
+ # }
1211
+ #
1212
+ # @!attribute [rw] permission_group_id
1213
+ # The unique identifier for the permission group.
1214
+ # @return [String]
1215
+ #
1216
+ # @!attribute [rw] user_id
1217
+ # The unique identifier for the user.
1218
+ # @return [String]
1219
+ #
1220
+ # @!attribute [rw] client_token
1221
+ # A token that ensures idempotency. This token expires in 10 minutes.
1222
+ #
1223
+ # **A suitable default value is auto-generated.** You should normally
1224
+ # not need to pass this option.
1225
+ # @return [String]
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroupRequest AWS API Documentation
1228
+ #
1229
+ class DisassociateUserFromPermissionGroupRequest < Struct.new(
1230
+ :permission_group_id,
1231
+ :user_id,
1232
+ :client_token)
1233
+ SENSITIVE = []
1234
+ include Aws::Structure
1235
+ end
1236
+
1237
+ # @!attribute [rw] status_code
1238
+ # The returned status code of the response.
1239
+ # @return [Integer]
1240
+ #
1241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroupResponse AWS API Documentation
1242
+ #
1243
+ class DisassociateUserFromPermissionGroupResponse < Struct.new(
1244
+ :status_code)
1245
+ SENSITIVE = []
1246
+ include Aws::Structure
1247
+ end
1248
+
1249
+ # @note When making an API call, you may pass EnableUserRequest
1250
+ # data as a hash:
1251
+ #
1252
+ # {
1253
+ # user_id: "UserId", # required
1254
+ # client_token: "ClientToken",
1255
+ # }
1256
+ #
1257
+ # @!attribute [rw] user_id
1258
+ # The unique identifier for the user account that you want to enable.
1259
+ # @return [String]
1260
+ #
1261
+ # @!attribute [rw] client_token
1262
+ # A token that ensures idempotency. This token expires in 10 minutes.
1263
+ #
1264
+ # **A suitable default value is auto-generated.** You should normally
1265
+ # not need to pass this option.
1266
+ # @return [String]
1267
+ #
1268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUserRequest AWS API Documentation
1269
+ #
1270
+ class EnableUserRequest < Struct.new(
1271
+ :user_id,
1272
+ :client_token)
1273
+ SENSITIVE = []
1274
+ include Aws::Structure
1275
+ end
1276
+
1277
+ # @!attribute [rw] user_id
1278
+ # The unique identifier for the enabled user account.
1279
+ # @return [String]
1280
+ #
1281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUserResponse AWS API Documentation
1282
+ #
1283
+ class EnableUserResponse < Struct.new(
1284
+ :user_id)
1285
+ SENSITIVE = []
1286
+ include Aws::Structure
1287
+ end
1288
+
912
1289
  # Request to describe a changeset.
913
1290
  #
914
1291
  # @note When making an API call, you may pass GetChangesetRequest
@@ -955,13 +1332,13 @@ module Aws::FinSpaceData
955
1332
  # @!attribute [rw] change_type
956
1333
  # Type that indicates how a Changeset is applied to a Dataset.
957
1334
  #
958
- # * `REPLACE` - Changeset is considered as a replacement to all prior
1335
+ # * `REPLACE` Changeset is considered as a replacement to all prior
959
1336
  # loaded Changesets.
960
1337
  #
961
- # * `APPEND` - Changeset is considered as an addition to the end of
1338
+ # * `APPEND` Changeset is considered as an addition to the end of
962
1339
  # all prior loaded Changesets.
963
1340
  #
964
- # * `MODIFY` - Changeset is considered as a replacement to a specific
1341
+ # * `MODIFY` Changeset is considered as a replacement to a specific
965
1342
  # prior ingested Changeset.
966
1343
  # @return [String]
967
1344
  #
@@ -975,7 +1352,7 @@ module Aws::FinSpaceData
975
1352
  #
976
1353
  # @!attribute [rw] create_time
977
1354
  # The timestamp at which the Changeset was created in FinSpace. The
978
- # value is determined as Epoch time in milliseconds. For example, the
1355
+ # value is determined as epoch time in milliseconds. For example, the
979
1356
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
980
1357
  # 1635768000000.
981
1358
  # @return [Integer]
@@ -990,13 +1367,13 @@ module Aws::FinSpaceData
990
1367
  #
991
1368
  # @!attribute [rw] active_until_timestamp
992
1369
  # Time until which the Changeset is active. The value is determined as
993
- # Epoch time in milliseconds. For example, the value for Monday,
1370
+ # epoch time in milliseconds. For example, the value for Monday,
994
1371
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
995
1372
  # @return [Integer]
996
1373
  #
997
1374
  # @!attribute [rw] active_from_timestamp
998
1375
  # Beginning time from which the Changeset is active. The value is
999
- # determined as Epoch time in milliseconds. For example, the value for
1376
+ # determined as epoch time in milliseconds. For example, the value for
1000
1377
  # Monday, November 1, 2021 12:00:00 PM UTC is specified as
1001
1378
  # 1635768000000.
1002
1379
  # @return [Integer]
@@ -1073,7 +1450,7 @@ module Aws::FinSpaceData
1073
1450
  # @return [String]
1074
1451
  #
1075
1452
  # @!attribute [rw] as_of_timestamp
1076
- # Time range to use for the Dataview. The value is determined as Epoch
1453
+ # Time range to use for the Dataview. The value is determined as epoch
1077
1454
  # time in milliseconds. For example, the value for Monday, November 1,
1078
1455
  # 2021 12:00:00 PM UTC is specified as 1635768000000.
1079
1456
  # @return [Integer]
@@ -1084,13 +1461,13 @@ module Aws::FinSpaceData
1084
1461
  #
1085
1462
  # @!attribute [rw] last_modified_time
1086
1463
  # The last time that a Dataview was modified. The value is determined
1087
- # as Epoch time in milliseconds. For example, the value for Monday,
1464
+ # as epoch time in milliseconds. For example, the value for Monday,
1088
1465
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1089
1466
  # @return [Integer]
1090
1467
  #
1091
1468
  # @!attribute [rw] create_time
1092
1469
  # The timestamp at which the Dataview was created in FinSpace. The
1093
- # value is determined as Epoch time in milliseconds. For example, the
1470
+ # value is determined as epoch time in milliseconds. For example, the
1094
1471
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1095
1472
  # 1635768000000.
1096
1473
  # @return [Integer]
@@ -1114,21 +1491,21 @@ module Aws::FinSpaceData
1114
1491
  # @!attribute [rw] status
1115
1492
  # The status of a Dataview creation.
1116
1493
  #
1117
- # * `RUNNING` - Dataview creation is running.
1494
+ # * `RUNNING` Dataview creation is running.
1118
1495
  #
1119
- # * `STARTING` - Dataview creation is starting.
1496
+ # * `STARTING` Dataview creation is starting.
1120
1497
  #
1121
- # * `FAILED` - Dataview creation has failed.
1498
+ # * `FAILED` Dataview creation has failed.
1122
1499
  #
1123
- # * `CANCELLED` - Dataview creation has been cancelled.
1500
+ # * `CANCELLED` Dataview creation has been cancelled.
1124
1501
  #
1125
- # * `TIMEOUT` - Dataview creation has timed out.
1502
+ # * `TIMEOUT` Dataview creation has timed out.
1126
1503
  #
1127
- # * `SUCCESS` - Dataview creation has succeeded.
1504
+ # * `SUCCESS` Dataview creation has succeeded.
1128
1505
  #
1129
- # * `PENDING` - Dataview creation is pending.
1506
+ # * `PENDING` Dataview creation is pending.
1130
1507
  #
1131
- # * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
1508
+ # * `FAILED_CLEANUP_FAILED` Dataview creation failed and resource
1132
1509
  # cleanup failed.
1133
1510
  # @return [String]
1134
1511
  #
@@ -1189,9 +1566,9 @@ module Aws::FinSpaceData
1189
1566
  # @!attribute [rw] kind
1190
1567
  # The format in which Dataset data is structured.
1191
1568
  #
1192
- # * `TABULAR` - Data is structured in a tabular format.
1569
+ # * `TABULAR` Data is structured in a tabular format.
1193
1570
  #
1194
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
1571
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
1195
1572
  # @return [String]
1196
1573
  #
1197
1574
  # @!attribute [rw] dataset_description
@@ -1200,14 +1577,14 @@ module Aws::FinSpaceData
1200
1577
  #
1201
1578
  # @!attribute [rw] create_time
1202
1579
  # The timestamp at which the Dataset was created in FinSpace. The
1203
- # value is determined as Epoch time in milliseconds. For example, the
1580
+ # value is determined as epoch time in milliseconds. For example, the
1204
1581
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1205
1582
  # 1635768000000.
1206
1583
  # @return [Integer]
1207
1584
  #
1208
1585
  # @!attribute [rw] last_modified_time
1209
1586
  # The last time that the Dataset was modified. The value is determined
1210
- # as Epoch time in milliseconds. For example, the value for Monday,
1587
+ # as epoch time in milliseconds. For example, the value for Monday,
1211
1588
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1212
1589
  # @return [Integer]
1213
1590
  #
@@ -1222,13 +1599,13 @@ module Aws::FinSpaceData
1222
1599
  # @!attribute [rw] status
1223
1600
  # Status of the Dataset creation.
1224
1601
  #
1225
- # * `PENDING` - Dataset is pending creation.
1602
+ # * `PENDING` Dataset is pending creation.
1226
1603
  #
1227
- # * `FAILED` - Dataset creation has failed.
1604
+ # * `FAILED` Dataset creation has failed.
1228
1605
  #
1229
- # * `SUCCESS` - Dataset creation has succeeded.
1606
+ # * `SUCCESS` Dataset creation has succeeded.
1230
1607
  #
1231
- # * `RUNNING` - Dataset creation is running.
1608
+ # * `RUNNING` Dataset creation is running.
1232
1609
  # @return [String]
1233
1610
  #
1234
1611
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDatasetResponse AWS API Documentation
@@ -1248,6 +1625,37 @@ module Aws::FinSpaceData
1248
1625
  include Aws::Structure
1249
1626
  end
1250
1627
 
1628
+ # @note When making an API call, you may pass GetPermissionGroupRequest
1629
+ # data as a hash:
1630
+ #
1631
+ # {
1632
+ # permission_group_id: "PermissionGroupId", # required
1633
+ # }
1634
+ #
1635
+ # @!attribute [rw] permission_group_id
1636
+ # The unique identifier for the permission group.
1637
+ # @return [String]
1638
+ #
1639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroupRequest AWS API Documentation
1640
+ #
1641
+ class GetPermissionGroupRequest < Struct.new(
1642
+ :permission_group_id)
1643
+ SENSITIVE = []
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # @!attribute [rw] permission_group
1648
+ # The structure for a permission group.
1649
+ # @return [Types::PermissionGroup]
1650
+ #
1651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroupResponse AWS API Documentation
1652
+ #
1653
+ class GetPermissionGroupResponse < Struct.new(
1654
+ :permission_group)
1655
+ SENSITIVE = []
1656
+ include Aws::Structure
1657
+ end
1658
+
1251
1659
  # Request for GetProgrammaticAccessCredentials operation
1252
1660
  #
1253
1661
  # @note When making an API call, you may pass GetProgrammaticAccessCredentialsRequest
@@ -1294,21 +1702,144 @@ module Aws::FinSpaceData
1294
1702
  include Aws::Structure
1295
1703
  end
1296
1704
 
1297
- # @note When making an API call, you may pass GetWorkingLocationRequest
1705
+ # @note When making an API call, you may pass GetUserRequest
1298
1706
  # data as a hash:
1299
1707
  #
1300
1708
  # {
1301
- # location_type: "INGESTION", # accepts INGESTION, SAGEMAKER
1709
+ # user_id: "UserId", # required
1302
1710
  # }
1303
1711
  #
1304
- # @!attribute [rw] location_type
1305
- # Specify the type of the working location.
1712
+ # @!attribute [rw] user_id
1713
+ # The unique identifier of the user to get data for.
1714
+ # @return [String]
1306
1715
  #
1307
- # * `SAGEMAKER` - Use the Amazon S3 location as a temporary location
1308
- # to store data content when working with FinSpace Notebooks that
1716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUserRequest AWS API Documentation
1717
+ #
1718
+ class GetUserRequest < Struct.new(
1719
+ :user_id)
1720
+ SENSITIVE = []
1721
+ include Aws::Structure
1722
+ end
1723
+
1724
+ # @!attribute [rw] user_id
1725
+ # The unique identifier for the user account that is retrieved.
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] status
1729
+ # The current status of the user account.
1730
+ #
1731
+ # * `CREATING` – The user account creation is in progress.
1732
+ #
1733
+ # * `ENABLED` – The user account is created and is currently active.
1734
+ #
1735
+ # * `DISABLED` – The user account is currently inactive.
1736
+ # @return [String]
1737
+ #
1738
+ # @!attribute [rw] first_name
1739
+ # The first name of the user.
1740
+ # @return [String]
1741
+ #
1742
+ # @!attribute [rw] last_name
1743
+ # The last name of the user.
1744
+ # @return [String]
1745
+ #
1746
+ # @!attribute [rw] email_address
1747
+ # The email address that is associated with the user.
1748
+ # @return [String]
1749
+ #
1750
+ # @!attribute [rw] type
1751
+ # Indicates the type of user.
1752
+ #
1753
+ # * `SUPER_USER` – A user with permission to all the functionality and
1754
+ # data in FinSpace.
1755
+ #
1756
+ # ^
1757
+ # ^
1758
+ #
1759
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
1760
+ # users are assigned permissions by adding them to a permission
1761
+ # group.
1762
+ #
1763
+ # ^
1764
+ # @return [String]
1765
+ #
1766
+ # @!attribute [rw] api_access
1767
+ # Indicates whether the user can use the
1768
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
1769
+ # can then be used to access other FinSpace Data API operations.
1770
+ #
1771
+ # * `ENABLED` – The user has permissions to use the APIs.
1772
+ #
1773
+ # * `DISABLED` – The user does not have permissions to use any APIs.
1774
+ # @return [String]
1775
+ #
1776
+ # @!attribute [rw] api_access_principal_arn
1777
+ # The ARN identifier of an AWS user or role that is allowed to call
1778
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
1779
+ # token for a specific FinSpace user. This must be an IAM role within
1780
+ # your FinSpace account.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] create_time
1784
+ # The timestamp at which the user account was created in FinSpace. The
1785
+ # value is determined as epoch time in milliseconds.
1786
+ # @return [Integer]
1787
+ #
1788
+ # @!attribute [rw] last_enabled_time
1789
+ # Describes the last time the user account was enabled. The value is
1790
+ # determined as epoch time in milliseconds.
1791
+ # @return [Integer]
1792
+ #
1793
+ # @!attribute [rw] last_disabled_time
1794
+ # Describes the last time the user account was disabled. The value is
1795
+ # determined as epoch time in milliseconds.
1796
+ # @return [Integer]
1797
+ #
1798
+ # @!attribute [rw] last_modified_time
1799
+ # Describes the last time the user account was updated. The value is
1800
+ # determined as epoch time in milliseconds.
1801
+ # @return [Integer]
1802
+ #
1803
+ # @!attribute [rw] last_login_time
1804
+ # Describes the last time that the user logged into their account. The
1805
+ # value is determined as epoch time in milliseconds.
1806
+ # @return [Integer]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUserResponse AWS API Documentation
1809
+ #
1810
+ class GetUserResponse < Struct.new(
1811
+ :user_id,
1812
+ :status,
1813
+ :first_name,
1814
+ :last_name,
1815
+ :email_address,
1816
+ :type,
1817
+ :api_access,
1818
+ :api_access_principal_arn,
1819
+ :create_time,
1820
+ :last_enabled_time,
1821
+ :last_disabled_time,
1822
+ :last_modified_time,
1823
+ :last_login_time)
1824
+ SENSITIVE = [:first_name, :last_name, :email_address]
1825
+ include Aws::Structure
1826
+ end
1827
+
1828
+ # @note When making an API call, you may pass GetWorkingLocationRequest
1829
+ # data as a hash:
1830
+ #
1831
+ # {
1832
+ # location_type: "INGESTION", # accepts INGESTION, SAGEMAKER
1833
+ # }
1834
+ #
1835
+ # @!attribute [rw] location_type
1836
+ # Specify the type of the working location.
1837
+ #
1838
+ # * `SAGEMAKER` – Use the Amazon S3 location as a temporary location
1839
+ # to store data content when working with FinSpace Notebooks that
1309
1840
  # run on SageMaker studio.
1310
1841
  #
1311
- # * `INGESTION` - Use the Amazon S3 location as a staging location to
1842
+ # * `INGESTION` Use the Amazon S3 location as a staging location to
1312
1843
  # copy your data content and then use the location with the
1313
1844
  # Changeset creation operation.
1314
1845
  # @return [String]
@@ -1391,7 +1922,7 @@ module Aws::FinSpaceData
1391
1922
  # @return [Integer]
1392
1923
  #
1393
1924
  # @!attribute [rw] next_token
1394
- # A token indicating where a results page should begin.
1925
+ # A token that indicates where a results page should begin.
1395
1926
  # @return [String]
1396
1927
  #
1397
1928
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsRequest AWS API Documentation
@@ -1412,7 +1943,7 @@ module Aws::FinSpaceData
1412
1943
  # @return [Array<Types::ChangesetSummary>]
1413
1944
  #
1414
1945
  # @!attribute [rw] next_token
1415
- # A token indicating where a results page should begin.
1946
+ # A token that indicates where a results page should begin.
1416
1947
  # @return [String]
1417
1948
  #
1418
1949
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsResponse AWS API Documentation
@@ -1441,7 +1972,7 @@ module Aws::FinSpaceData
1441
1972
  # @return [String]
1442
1973
  #
1443
1974
  # @!attribute [rw] next_token
1444
- # A token indicating where a results page should begin.
1975
+ # A token that indicates where a results page should begin.
1445
1976
  # @return [String]
1446
1977
  #
1447
1978
  # @!attribute [rw] max_results
@@ -1459,7 +1990,7 @@ module Aws::FinSpaceData
1459
1990
  end
1460
1991
 
1461
1992
  # @!attribute [rw] next_token
1462
- # A token indicating where a results page should begin.
1993
+ # A token that indicates where a results page should begin.
1463
1994
  # @return [String]
1464
1995
  #
1465
1996
  # @!attribute [rw] data_views
@@ -1486,7 +2017,7 @@ module Aws::FinSpaceData
1486
2017
  # }
1487
2018
  #
1488
2019
  # @!attribute [rw] next_token
1489
- # A token indicating where a results page should begin.
2020
+ # A token that indicates where a results page should begin.
1490
2021
  # @return [String]
1491
2022
  #
1492
2023
  # @!attribute [rw] max_results
@@ -1509,7 +2040,7 @@ module Aws::FinSpaceData
1509
2040
  # @return [Array<Types::Dataset>]
1510
2041
  #
1511
2042
  # @!attribute [rw] next_token
1512
- # A token indicating where a results page should begin.
2043
+ # A token that indicates where a results page should begin.
1513
2044
  # @return [String]
1514
2045
  #
1515
2046
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasetsResponse AWS API Documentation
@@ -1521,6 +2052,293 @@ module Aws::FinSpaceData
1521
2052
  include Aws::Structure
1522
2053
  end
1523
2054
 
2055
+ # @note When making an API call, you may pass ListPermissionGroupsByUserRequest
2056
+ # data as a hash:
2057
+ #
2058
+ # {
2059
+ # user_id: "UserId", # required
2060
+ # next_token: "PaginationToken",
2061
+ # max_results: 1, # required
2062
+ # }
2063
+ #
2064
+ # @!attribute [rw] user_id
2065
+ # The unique identifier for the user.
2066
+ # @return [String]
2067
+ #
2068
+ # @!attribute [rw] next_token
2069
+ # A token that indicates where a results page should begin.
2070
+ # @return [String]
2071
+ #
2072
+ # @!attribute [rw] max_results
2073
+ # The maximum number of results per page.
2074
+ # @return [Integer]
2075
+ #
2076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUserRequest AWS API Documentation
2077
+ #
2078
+ class ListPermissionGroupsByUserRequest < Struct.new(
2079
+ :user_id,
2080
+ :next_token,
2081
+ :max_results)
2082
+ SENSITIVE = []
2083
+ include Aws::Structure
2084
+ end
2085
+
2086
+ # @!attribute [rw] permission_groups
2087
+ # A list of returned permission groups.
2088
+ # @return [Array<Types::PermissionGroupByUser>]
2089
+ #
2090
+ # @!attribute [rw] next_token
2091
+ # A token that indicates where a results page should begin.
2092
+ # @return [String]
2093
+ #
2094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUserResponse AWS API Documentation
2095
+ #
2096
+ class ListPermissionGroupsByUserResponse < Struct.new(
2097
+ :permission_groups,
2098
+ :next_token)
2099
+ SENSITIVE = []
2100
+ include Aws::Structure
2101
+ end
2102
+
2103
+ # @note When making an API call, you may pass ListPermissionGroupsRequest
2104
+ # data as a hash:
2105
+ #
2106
+ # {
2107
+ # next_token: "PaginationToken",
2108
+ # max_results: 1, # required
2109
+ # }
2110
+ #
2111
+ # @!attribute [rw] next_token
2112
+ # A token that indicates where a results page should begin.
2113
+ # @return [String]
2114
+ #
2115
+ # @!attribute [rw] max_results
2116
+ # The maximum number of results per page.
2117
+ # @return [Integer]
2118
+ #
2119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsRequest AWS API Documentation
2120
+ #
2121
+ class ListPermissionGroupsRequest < Struct.new(
2122
+ :next_token,
2123
+ :max_results)
2124
+ SENSITIVE = []
2125
+ include Aws::Structure
2126
+ end
2127
+
2128
+ # @!attribute [rw] permission_groups
2129
+ # A list of all the permission groups.
2130
+ # @return [Array<Types::PermissionGroup>]
2131
+ #
2132
+ # @!attribute [rw] next_token
2133
+ # A token that indicates where a results page should begin.
2134
+ # @return [String]
2135
+ #
2136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsResponse AWS API Documentation
2137
+ #
2138
+ class ListPermissionGroupsResponse < Struct.new(
2139
+ :permission_groups,
2140
+ :next_token)
2141
+ SENSITIVE = []
2142
+ include Aws::Structure
2143
+ end
2144
+
2145
+ # @note When making an API call, you may pass ListUsersByPermissionGroupRequest
2146
+ # data as a hash:
2147
+ #
2148
+ # {
2149
+ # permission_group_id: "PermissionGroupId", # required
2150
+ # next_token: "PaginationToken",
2151
+ # max_results: 1, # required
2152
+ # }
2153
+ #
2154
+ # @!attribute [rw] permission_group_id
2155
+ # The unique identifier for the permission group.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] next_token
2159
+ # A token that indicates where a results page should begin.
2160
+ # @return [String]
2161
+ #
2162
+ # @!attribute [rw] max_results
2163
+ # The maximum number of results per page.
2164
+ # @return [Integer]
2165
+ #
2166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroupRequest AWS API Documentation
2167
+ #
2168
+ class ListUsersByPermissionGroupRequest < Struct.new(
2169
+ :permission_group_id,
2170
+ :next_token,
2171
+ :max_results)
2172
+ SENSITIVE = []
2173
+ include Aws::Structure
2174
+ end
2175
+
2176
+ # @!attribute [rw] users
2177
+ # Lists details of all users in a specific permission group.
2178
+ # @return [Array<Types::UserByPermissionGroup>]
2179
+ #
2180
+ # @!attribute [rw] next_token
2181
+ # A token that indicates where a results page should begin.
2182
+ # @return [String]
2183
+ #
2184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroupResponse AWS API Documentation
2185
+ #
2186
+ class ListUsersByPermissionGroupResponse < Struct.new(
2187
+ :users,
2188
+ :next_token)
2189
+ SENSITIVE = []
2190
+ include Aws::Structure
2191
+ end
2192
+
2193
+ # @note When making an API call, you may pass ListUsersRequest
2194
+ # data as a hash:
2195
+ #
2196
+ # {
2197
+ # next_token: "PaginationToken",
2198
+ # max_results: 1, # required
2199
+ # }
2200
+ #
2201
+ # @!attribute [rw] next_token
2202
+ # A token that indicates where a results page should begin.
2203
+ # @return [String]
2204
+ #
2205
+ # @!attribute [rw] max_results
2206
+ # The maximum number of results per page.
2207
+ # @return [Integer]
2208
+ #
2209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersRequest AWS API Documentation
2210
+ #
2211
+ class ListUsersRequest < Struct.new(
2212
+ :next_token,
2213
+ :max_results)
2214
+ SENSITIVE = []
2215
+ include Aws::Structure
2216
+ end
2217
+
2218
+ # @!attribute [rw] users
2219
+ # A list of all the user accounts.
2220
+ # @return [Array<Types::User>]
2221
+ #
2222
+ # @!attribute [rw] next_token
2223
+ # A token that indicates where a results page should begin.
2224
+ # @return [String]
2225
+ #
2226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersResponse AWS API Documentation
2227
+ #
2228
+ class ListUsersResponse < Struct.new(
2229
+ :users,
2230
+ :next_token)
2231
+ SENSITIVE = []
2232
+ include Aws::Structure
2233
+ end
2234
+
2235
+ # The structure for a permission group.
2236
+ #
2237
+ # @!attribute [rw] permission_group_id
2238
+ # The unique identifier for the permission group.
2239
+ # @return [String]
2240
+ #
2241
+ # @!attribute [rw] name
2242
+ # The name of the permission group.
2243
+ # @return [String]
2244
+ #
2245
+ # @!attribute [rw] description
2246
+ # A brief description for the permission group.
2247
+ # @return [String]
2248
+ #
2249
+ # @!attribute [rw] application_permissions
2250
+ # Indicates the permissions that are granted to a specific group for
2251
+ # accessing the FinSpace application.
2252
+ #
2253
+ # * `CreateDataset` – Group members can create new datasets.
2254
+ #
2255
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
2256
+ # from FinSpace notebooks.
2257
+ #
2258
+ # * `ManageUsersAndGroups` – Group members can manage users and
2259
+ # permission groups.
2260
+ #
2261
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
2262
+ #
2263
+ # * `ViewAuditData` – Group members can view audit data.
2264
+ #
2265
+ # * `AccessNotebooks` – Group members will have access to FinSpace
2266
+ # notebooks.
2267
+ #
2268
+ # * `GetTemporaryCredentials` – Group members can get temporary API
2269
+ # credentials.
2270
+ # @return [Array<String>]
2271
+ #
2272
+ # @!attribute [rw] create_time
2273
+ # The timestamp at which the group was created in FinSpace. The value
2274
+ # is determined as epoch time in milliseconds.
2275
+ # @return [Integer]
2276
+ #
2277
+ # @!attribute [rw] last_modified_time
2278
+ # Describes the last time the permission group was updated. The value
2279
+ # is determined as epoch time in milliseconds.
2280
+ # @return [Integer]
2281
+ #
2282
+ # @!attribute [rw] membership_status
2283
+ # Indicates the status of the user account within a permission group.
2284
+ #
2285
+ # * `ADDITION_IN_PROGRESS` – The user account is currently being added
2286
+ # to the permission group.
2287
+ #
2288
+ # * `ADDITION_SUCCESS` – The user account is successfully added to the
2289
+ # permission group.
2290
+ #
2291
+ # * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
2292
+ # the permission group.
2293
+ # @return [String]
2294
+ #
2295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroup AWS API Documentation
2296
+ #
2297
+ class PermissionGroup < Struct.new(
2298
+ :permission_group_id,
2299
+ :name,
2300
+ :description,
2301
+ :application_permissions,
2302
+ :create_time,
2303
+ :last_modified_time,
2304
+ :membership_status)
2305
+ SENSITIVE = [:name, :description]
2306
+ include Aws::Structure
2307
+ end
2308
+
2309
+ # The structure of a permission group associated with a user account.
2310
+ #
2311
+ # @!attribute [rw] permission_group_id
2312
+ # The unique identifier for the permission group.
2313
+ # @return [String]
2314
+ #
2315
+ # @!attribute [rw] name
2316
+ # The name of the permission group.
2317
+ # @return [String]
2318
+ #
2319
+ # @!attribute [rw] membership_status
2320
+ # Indicates the status of the user account within a permission group.
2321
+ #
2322
+ # * `ADDITION_IN_PROGRESS` – The user account is currently being added
2323
+ # to the permission group.
2324
+ #
2325
+ # * `ADDITION_SUCCESS` – The user account is successfully added to the
2326
+ # permission group.
2327
+ #
2328
+ # * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
2329
+ # the permission group.
2330
+ # @return [String]
2331
+ #
2332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroupByUser AWS API Documentation
2333
+ #
2334
+ class PermissionGroupByUser < Struct.new(
2335
+ :permission_group_id,
2336
+ :name,
2337
+ :membership_status)
2338
+ SENSITIVE = [:name]
2339
+ include Aws::Structure
2340
+ end
2341
+
1524
2342
  # Permission group parameters for Dataset permissions.
1525
2343
  #
1526
2344
  # Here is an example of how you could specify the
@@ -1544,7 +2362,7 @@ module Aws::FinSpaceData
1544
2362
  # }
1545
2363
  #
1546
2364
  # @!attribute [rw] permission_group_id
1547
- # The unique identifier of the PermissionGroup.
2365
+ # The unique identifier for the `PermissionGroup`.
1548
2366
  # @return [String]
1549
2367
  #
1550
2368
  # @!attribute [rw] dataset_permissions
@@ -1560,15 +2378,67 @@ module Aws::FinSpaceData
1560
2378
  include Aws::Structure
1561
2379
  end
1562
2380
 
2381
+ # @note When making an API call, you may pass ResetUserPasswordRequest
2382
+ # data as a hash:
2383
+ #
2384
+ # {
2385
+ # user_id: "UserId", # required
2386
+ # client_token: "ClientToken",
2387
+ # }
2388
+ #
2389
+ # @!attribute [rw] user_id
2390
+ # The unique identifier of the user that a temporary password is
2391
+ # requested for.
2392
+ # @return [String]
2393
+ #
2394
+ # @!attribute [rw] client_token
2395
+ # A token that ensures idempotency. This token expires in 10 minutes.
2396
+ #
2397
+ # **A suitable default value is auto-generated.** You should normally
2398
+ # not need to pass this option.
2399
+ # @return [String]
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPasswordRequest AWS API Documentation
2402
+ #
2403
+ class ResetUserPasswordRequest < Struct.new(
2404
+ :user_id,
2405
+ :client_token)
2406
+ SENSITIVE = []
2407
+ include Aws::Structure
2408
+ end
2409
+
2410
+ # @!attribute [rw] user_id
2411
+ # The unique identifier of the user that a new password is generated
2412
+ # for.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] temporary_password
2416
+ # A randomly generated temporary password for the requested user
2417
+ # account. This password expires in 7 days.
2418
+ # @return [String]
2419
+ #
2420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPasswordResponse AWS API Documentation
2421
+ #
2422
+ class ResetUserPasswordResponse < Struct.new(
2423
+ :user_id,
2424
+ :temporary_password)
2425
+ SENSITIVE = [:temporary_password]
2426
+ include Aws::Structure
2427
+ end
2428
+
1563
2429
  # One or more resources can't be found.
1564
2430
  #
1565
2431
  # @!attribute [rw] message
1566
2432
  # @return [String]
1567
2433
  #
2434
+ # @!attribute [rw] reason
2435
+ # @return [String]
2436
+ #
1568
2437
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResourceNotFoundException AWS API Documentation
1569
2438
  #
1570
2439
  class ResourceNotFoundException < Struct.new(
1571
- :message)
2440
+ :message,
2441
+ :reason)
1572
2442
  SENSITIVE = []
1573
2443
  include Aws::Structure
1574
2444
  end
@@ -1587,14 +2457,14 @@ module Aws::FinSpaceData
1587
2457
  #
1588
2458
  # * `AddDatasetData`
1589
2459
  #
1590
- # * `CreateSnapshot`
2460
+ # * `CreateDataView`
1591
2461
  #
1592
2462
  # * `EditDatasetMetadata`
1593
2463
  #
1594
2464
  # * `DeleteDataset`
1595
2465
  #
1596
- # For more information on the ataset permissions, see [Supported Dataset
1597
- # Permissions][1] in the FinSpace User Guide.
2466
+ # For more information on the dataset permissions, see [Supported
2467
+ # Dataset Permissions][1] in the FinSpace User Guide.
1598
2468
  #
1599
2469
  #
1600
2470
  #
@@ -1752,13 +2622,13 @@ module Aws::FinSpaceData
1752
2622
  # `formatType` is a required attribute and can have the following
1753
2623
  # values:
1754
2624
  #
1755
- # * `PARQUET` - Parquet source file format.
2625
+ # * `PARQUET` Parquet source file format.
1756
2626
  #
1757
- # * `CSV` - CSV source file format.
2627
+ # * `CSV` CSV source file format.
1758
2628
  #
1759
- # * `JSON` - JSON source file format.
2629
+ # * `JSON` JSON source file format.
1760
2630
  #
1761
- # * `XML` - XML source file format.
2631
+ # * `XML` XML source file format.
1762
2632
  #
1763
2633
  # Here is an example of how you could specify the `formatParams`\:
1764
2634
  #
@@ -1854,9 +2724,9 @@ module Aws::FinSpaceData
1854
2724
  # @!attribute [rw] kind
1855
2725
  # The format in which the Dataset data is structured.
1856
2726
  #
1857
- # * `TABULAR` - Data is structured in a tabular format.
2727
+ # * `TABULAR` Data is structured in a tabular format.
1858
2728
  #
1859
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
2729
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
1860
2730
  # @return [String]
1861
2731
  #
1862
2732
  # @!attribute [rw] dataset_description
@@ -1899,16 +2769,367 @@ module Aws::FinSpaceData
1899
2769
  include Aws::Structure
1900
2770
  end
1901
2771
 
2772
+ # @note When making an API call, you may pass UpdatePermissionGroupRequest
2773
+ # data as a hash:
2774
+ #
2775
+ # {
2776
+ # permission_group_id: "PermissionGroupId", # required
2777
+ # name: "PermissionGroupName",
2778
+ # description: "PermissionGroupDescription",
2779
+ # application_permissions: ["CreateDataset"], # accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
2780
+ # client_token: "ClientToken",
2781
+ # }
2782
+ #
2783
+ # @!attribute [rw] permission_group_id
2784
+ # The unique identifier for the permission group to update.
2785
+ # @return [String]
2786
+ #
2787
+ # @!attribute [rw] name
2788
+ # The name of the permission group.
2789
+ # @return [String]
2790
+ #
2791
+ # @!attribute [rw] description
2792
+ # A brief description for the permission group.
2793
+ # @return [String]
2794
+ #
2795
+ # @!attribute [rw] application_permissions
2796
+ # The permissions that are granted to a specific group for accessing
2797
+ # the FinSpace application.
2798
+ #
2799
+ # * `CreateDataset` – Group members can create new datasets.
2800
+ #
2801
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
2802
+ # from FinSpace notebooks.
2803
+ #
2804
+ # * `ManageUsersAndGroups` – Group members can manage users and
2805
+ # permission groups.
2806
+ #
2807
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
2808
+ #
2809
+ # * `ViewAuditData` – Group members can view audit data.
2810
+ #
2811
+ # * `AccessNotebooks` – Group members will have access to FinSpace
2812
+ # notebooks.
2813
+ #
2814
+ # * `GetTemporaryCredentials` – Group members can get temporary API
2815
+ # credentials.
2816
+ # @return [Array<String>]
2817
+ #
2818
+ # @!attribute [rw] client_token
2819
+ # A token that ensures idempotency. This token expires in 10 minutes.
2820
+ #
2821
+ # **A suitable default value is auto-generated.** You should normally
2822
+ # not need to pass this option.
2823
+ # @return [String]
2824
+ #
2825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroupRequest AWS API Documentation
2826
+ #
2827
+ class UpdatePermissionGroupRequest < Struct.new(
2828
+ :permission_group_id,
2829
+ :name,
2830
+ :description,
2831
+ :application_permissions,
2832
+ :client_token)
2833
+ SENSITIVE = [:name, :description]
2834
+ include Aws::Structure
2835
+ end
2836
+
2837
+ # @!attribute [rw] permission_group_id
2838
+ # The unique identifier for the updated permission group.
2839
+ # @return [String]
2840
+ #
2841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroupResponse AWS API Documentation
2842
+ #
2843
+ class UpdatePermissionGroupResponse < Struct.new(
2844
+ :permission_group_id)
2845
+ SENSITIVE = []
2846
+ include Aws::Structure
2847
+ end
2848
+
2849
+ # @note When making an API call, you may pass UpdateUserRequest
2850
+ # data as a hash:
2851
+ #
2852
+ # {
2853
+ # user_id: "UserId", # required
2854
+ # type: "SUPER_USER", # accepts SUPER_USER, APP_USER
2855
+ # first_name: "FirstName",
2856
+ # last_name: "LastName",
2857
+ # api_access: "ENABLED", # accepts ENABLED, DISABLED
2858
+ # api_access_principal_arn: "RoleArn",
2859
+ # client_token: "ClientToken",
2860
+ # }
2861
+ #
2862
+ # @!attribute [rw] user_id
2863
+ # The unique identifier for the user account to update.
2864
+ # @return [String]
2865
+ #
2866
+ # @!attribute [rw] type
2867
+ # The option to indicate the type of user.
2868
+ #
2869
+ # * `SUPER_USER`– A user with permission to all the functionality and
2870
+ # data in FinSpace.
2871
+ #
2872
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
2873
+ # users are assigned permissions by adding them to a permission
2874
+ # group.
2875
+ # @return [String]
2876
+ #
2877
+ # @!attribute [rw] first_name
2878
+ # The first name of the user.
2879
+ # @return [String]
2880
+ #
2881
+ # @!attribute [rw] last_name
2882
+ # The last name of the user.
2883
+ # @return [String]
2884
+ #
2885
+ # @!attribute [rw] api_access
2886
+ # The option to indicate whether the user can use the
2887
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
2888
+ # can then be used to access other FinSpace Data API operations.
2889
+ #
2890
+ # * `ENABLED` – The user has permissions to use the APIs.
2891
+ #
2892
+ # * `DISABLED` – The user does not have permissions to use any APIs.
2893
+ # @return [String]
2894
+ #
2895
+ # @!attribute [rw] api_access_principal_arn
2896
+ # The ARN identifier of an AWS user or role that is allowed to call
2897
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
2898
+ # token for a specific FinSpace user. This must be an IAM role within
2899
+ # your FinSpace account.
2900
+ # @return [String]
2901
+ #
2902
+ # @!attribute [rw] client_token
2903
+ # A token that ensures idempotency. This token expires in 10 minutes.
2904
+ #
2905
+ # **A suitable default value is auto-generated.** You should normally
2906
+ # not need to pass this option.
2907
+ # @return [String]
2908
+ #
2909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUserRequest AWS API Documentation
2910
+ #
2911
+ class UpdateUserRequest < Struct.new(
2912
+ :user_id,
2913
+ :type,
2914
+ :first_name,
2915
+ :last_name,
2916
+ :api_access,
2917
+ :api_access_principal_arn,
2918
+ :client_token)
2919
+ SENSITIVE = [:first_name, :last_name]
2920
+ include Aws::Structure
2921
+ end
2922
+
2923
+ # @!attribute [rw] user_id
2924
+ # The unique identifier of the updated user account.
2925
+ # @return [String]
2926
+ #
2927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUserResponse AWS API Documentation
2928
+ #
2929
+ class UpdateUserResponse < Struct.new(
2930
+ :user_id)
2931
+ SENSITIVE = []
2932
+ include Aws::Structure
2933
+ end
2934
+
2935
+ # The details of the user account.
2936
+ #
2937
+ # @!attribute [rw] user_id
2938
+ # The unique identifier for the user.
2939
+ # @return [String]
2940
+ #
2941
+ # @!attribute [rw] status
2942
+ # The current status of the user account.
2943
+ #
2944
+ # * `CREATING` – The user account creation is in progress.
2945
+ #
2946
+ # * `ENABLED` – The user account is created and is currently active.
2947
+ #
2948
+ # * `DISABLED` – The user account is currently inactive.
2949
+ # @return [String]
2950
+ #
2951
+ # @!attribute [rw] first_name
2952
+ # The first name of the user.
2953
+ # @return [String]
2954
+ #
2955
+ # @!attribute [rw] last_name
2956
+ # The last name of the user.
2957
+ # @return [String]
2958
+ #
2959
+ # @!attribute [rw] email_address
2960
+ # The email address of the user. The email address serves as a uniquer
2961
+ # identifier for each user and cannot be changed after it's created.
2962
+ # @return [String]
2963
+ #
2964
+ # @!attribute [rw] type
2965
+ # Indicates the type of user.
2966
+ #
2967
+ # * `SUPER_USER` – A user with permission to all the functionality and
2968
+ # data in FinSpace.
2969
+ #
2970
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
2971
+ # users are assigned permissions by adding them to a permission
2972
+ # group.
2973
+ # @return [String]
2974
+ #
2975
+ # @!attribute [rw] api_access
2976
+ # Indicates whether the user can use the
2977
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
2978
+ # can then be used to access other FinSpace Data API operations.
2979
+ #
2980
+ # * `ENABLED` – The user has permissions to use the APIs.
2981
+ #
2982
+ # * `DISABLED` – The user does not have permissions to use any APIs.
2983
+ # @return [String]
2984
+ #
2985
+ # @!attribute [rw] api_access_principal_arn
2986
+ # The ARN identifier of an AWS user or role that is allowed to call
2987
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
2988
+ # token for a specific FinSpace user. This must be an IAM role within
2989
+ # your FinSpace account.
2990
+ # @return [String]
2991
+ #
2992
+ # @!attribute [rw] create_time
2993
+ # The timestamp at which the user account was created in FinSpace. The
2994
+ # value is determined as epoch time in milliseconds.
2995
+ # @return [Integer]
2996
+ #
2997
+ # @!attribute [rw] last_enabled_time
2998
+ # Describes the last time the user account was enabled. The value is
2999
+ # determined as epoch time in milliseconds.
3000
+ # @return [Integer]
3001
+ #
3002
+ # @!attribute [rw] last_disabled_time
3003
+ # Describes the last time the user account was disabled. The value is
3004
+ # determined as epoch time in milliseconds.
3005
+ # @return [Integer]
3006
+ #
3007
+ # @!attribute [rw] last_modified_time
3008
+ # Describes the last time the user account was updated. The value is
3009
+ # determined as epoch time in milliseconds.
3010
+ # @return [Integer]
3011
+ #
3012
+ # @!attribute [rw] last_login_time
3013
+ # Describes the last time that the user logged into their account. The
3014
+ # value is determined as epoch time in milliseconds.
3015
+ # @return [Integer]
3016
+ #
3017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/User AWS API Documentation
3018
+ #
3019
+ class User < Struct.new(
3020
+ :user_id,
3021
+ :status,
3022
+ :first_name,
3023
+ :last_name,
3024
+ :email_address,
3025
+ :type,
3026
+ :api_access,
3027
+ :api_access_principal_arn,
3028
+ :create_time,
3029
+ :last_enabled_time,
3030
+ :last_disabled_time,
3031
+ :last_modified_time,
3032
+ :last_login_time)
3033
+ SENSITIVE = [:first_name, :last_name, :email_address]
3034
+ include Aws::Structure
3035
+ end
3036
+
3037
+ # The structure of a user account associated with a permission group.
3038
+ #
3039
+ # @!attribute [rw] user_id
3040
+ # The unique identifier for the user.
3041
+ # @return [String]
3042
+ #
3043
+ # @!attribute [rw] status
3044
+ # The current status of the user account.
3045
+ #
3046
+ # * `CREATING` – The user account creation is in progress.
3047
+ #
3048
+ # * `ENABLED` – The user account is created and is currently active.
3049
+ #
3050
+ # * `DISABLED` – The user account is currently inactive.
3051
+ # @return [String]
3052
+ #
3053
+ # @!attribute [rw] first_name
3054
+ # The first name of the user.
3055
+ # @return [String]
3056
+ #
3057
+ # @!attribute [rw] last_name
3058
+ # The last name of the user.
3059
+ # @return [String]
3060
+ #
3061
+ # @!attribute [rw] email_address
3062
+ # The email address of the user. The email address serves as a unique
3063
+ # identifier for each user and cannot be changed after it's created.
3064
+ # @return [String]
3065
+ #
3066
+ # @!attribute [rw] type
3067
+ # Indicates the type of user.
3068
+ #
3069
+ # * `SUPER_USER` – A user with permission to all the functionality and
3070
+ # data in FinSpace.
3071
+ #
3072
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
3073
+ # users are assigned permissions by adding them to a permission
3074
+ # group.
3075
+ # @return [String]
3076
+ #
3077
+ # @!attribute [rw] api_access
3078
+ # Indicates whether the user can access FinSpace API operations.
3079
+ #
3080
+ # * `ENABLED` – The user has permissions to use the API operations.
3081
+ #
3082
+ # * `DISABLED` – The user does not have permissions to use any API
3083
+ # operations.
3084
+ # @return [String]
3085
+ #
3086
+ # @!attribute [rw] api_access_principal_arn
3087
+ # The IAM ARN identifier that is attached to FinSpace API calls.
3088
+ # @return [String]
3089
+ #
3090
+ # @!attribute [rw] membership_status
3091
+ # Indicates the status of the user account within a permission group.
3092
+ #
3093
+ # * `ADDITION_IN_PROGRESS` – The user account is currently being added
3094
+ # to the permission group.
3095
+ #
3096
+ # * `ADDITION_SUCCESS` – The user account is successfully added to the
3097
+ # permission group.
3098
+ #
3099
+ # * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
3100
+ # the permission group.
3101
+ # @return [String]
3102
+ #
3103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UserByPermissionGroup AWS API Documentation
3104
+ #
3105
+ class UserByPermissionGroup < Struct.new(
3106
+ :user_id,
3107
+ :status,
3108
+ :first_name,
3109
+ :last_name,
3110
+ :email_address,
3111
+ :type,
3112
+ :api_access,
3113
+ :api_access_principal_arn,
3114
+ :membership_status)
3115
+ SENSITIVE = [:first_name, :last_name, :email_address]
3116
+ include Aws::Structure
3117
+ end
3118
+
1902
3119
  # The input fails to satisfy the constraints specified by an AWS
1903
3120
  # service.
1904
3121
  #
1905
3122
  # @!attribute [rw] message
1906
3123
  # @return [String]
1907
3124
  #
3125
+ # @!attribute [rw] reason
3126
+ # @return [String]
3127
+ #
1908
3128
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ValidationException AWS API Documentation
1909
3129
  #
1910
3130
  class ValidationException < Struct.new(
1911
- :message)
3131
+ :message,
3132
+ :reason)
1912
3133
  SENSITIVE = []
1913
3134
  include Aws::Structure
1914
3135
  end