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.
@@ -32,26 +32,26 @@ module Aws::FinSpaceData
32
32
  # @!attribute [rw] error_category
33
33
  # The category of the error.
34
34
  #
35
- # * `VALIDATION` -The inputs to this request are invalid.
35
+ # * `VALIDATION` The inputs to this request are invalid.
36
36
  #
37
- # * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
37
+ # * `SERVICE_QUOTA_EXCEEDED` Service quotas have been exceeded.
38
38
  # Please contact AWS support to increase quotas.
39
39
  #
40
- # * `ACCESS_DENIED` - Missing required permission to perform this
40
+ # * `ACCESS_DENIED` Missing required permission to perform this
41
41
  # request.
42
42
  #
43
- # * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
43
+ # * `RESOURCE_NOT_FOUND` One or more inputs to this request were not
44
44
  # found.
45
45
  #
46
- # * `THROTTLING` - The system temporarily lacks sufficient resources
46
+ # * `THROTTLING` The system temporarily lacks sufficient resources
47
47
  # to process the request.
48
48
  #
49
- # * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
49
+ # * `INTERNAL_SERVICE_EXCEPTION` An internal service error has
50
50
  # occurred.
51
51
  #
52
- # * `CANCELLED` - Cancelled.
52
+ # * `CANCELLED` Cancelled.
53
53
  #
54
- # * `USER_RECOVERABLE` - A user recoverable error has occurred.
54
+ # * `USER_RECOVERABLE` A user recoverable error has occurred.
55
55
  # @return [String]
56
56
  #
57
57
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ChangesetErrorInfo AWS API Documentation
@@ -81,13 +81,13 @@ module Aws::FinSpaceData
81
81
  # @!attribute [rw] change_type
82
82
  # Type that indicates how a Changeset is applied to a Dataset.
83
83
  #
84
- # * `REPLACE` - Changeset is considered as a replacement to all prior
84
+ # * `REPLACE` Changeset is considered as a replacement to all prior
85
85
  # loaded Changesets.
86
86
  #
87
- # * `APPEND` - Changeset is considered as an addition to the end of
87
+ # * `APPEND` Changeset is considered as an addition to the end of
88
88
  # all prior loaded Changesets.
89
89
  #
90
- # * `MODIFY` - Changeset is considered as a replacement to a specific
90
+ # * `MODIFY` Changeset is considered as a replacement to a specific
91
91
  # prior ingested Changeset.
92
92
  # @return [String]
93
93
  #
@@ -101,7 +101,7 @@ module Aws::FinSpaceData
101
101
  #
102
102
  # @!attribute [rw] create_time
103
103
  # The timestamp at which the Changeset was created in FinSpace. The
104
- # value is determined as Epoch time in milliseconds. For example, the
104
+ # value is determined as epoch time in milliseconds. For example, the
105
105
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
106
106
  # 1635768000000.
107
107
  # @return [Integer]
@@ -109,15 +109,15 @@ module Aws::FinSpaceData
109
109
  # @!attribute [rw] status
110
110
  # Status of the Changeset ingestion.
111
111
  #
112
- # * `PENDING` - Changeset is pending creation.
112
+ # * `PENDING` Changeset is pending creation.
113
113
  #
114
- # * `FAILED` - Changeset creation has failed.
114
+ # * `FAILED` Changeset creation has failed.
115
115
  #
116
- # * `SUCCESS` - Changeset creation has succeeded.
116
+ # * `SUCCESS` Changeset creation has succeeded.
117
117
  #
118
- # * `RUNNING` - Changeset creation is running.
118
+ # * `RUNNING` Changeset creation is running.
119
119
  #
120
- # * `STOP_REQUESTED` - User requested Changeset creation to stop.
120
+ # * `STOP_REQUESTED` User requested Changeset creation to stop.
121
121
  # @return [String]
122
122
  #
123
123
  # @!attribute [rw] error_info
@@ -126,13 +126,13 @@ module Aws::FinSpaceData
126
126
  #
127
127
  # @!attribute [rw] active_until_timestamp
128
128
  # Time until which the Changeset is active. The value is determined as
129
- # Epoch time in milliseconds. For example, the value for Monday,
129
+ # epoch time in milliseconds. For example, the value for Monday,
130
130
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
131
131
  # @return [Integer]
132
132
  #
133
133
  # @!attribute [rw] active_from_timestamp
134
134
  # Beginning time from which the Changeset is active. The value is
135
- # determined as Epoch time in milliseconds. For example, the value for
135
+ # determined as epoch time in milliseconds. For example, the value for
136
136
  # Monday, November 1, 2021 12:00:00 PM UTC is specified as
137
137
  # 1635768000000.
138
138
  # @return [Integer]
@@ -179,33 +179,33 @@ module Aws::FinSpaceData
179
179
  # @!attribute [rw] data_type
180
180
  # Data type of a column.
181
181
  #
182
- # * `STRING` - A String data type.
182
+ # * `STRING` A String data type.
183
183
  #
184
- # `CHAR` - A char data type.
184
+ # `CHAR` A char data type.
185
185
  #
186
- # `INTEGER` - An integer data type.
186
+ # `INTEGER` An integer data type.
187
187
  #
188
- # `TINYINT` - A tinyint data type.
188
+ # `TINYINT` A tinyint data type.
189
189
  #
190
- # `SMALLINT` - A smallint data type.
190
+ # `SMALLINT` A smallint data type.
191
191
  #
192
- # `BIGINT` - A bigint data type.
192
+ # `BIGINT` A bigint data type.
193
193
  #
194
- # `FLOAT` - A float data type.
194
+ # `FLOAT` A float data type.
195
195
  #
196
- # `DOUBLE` - A double data type.
196
+ # `DOUBLE` A double data type.
197
197
  #
198
- # `DATE` - A date data type.
198
+ # `DATE` A date data type.
199
199
  #
200
- # `DATETIME` - A datetime data type.
200
+ # `DATETIME` A datetime data type.
201
201
  #
202
- # `BOOLEAN` - A boolean data type.
202
+ # `BOOLEAN` A boolean data type.
203
203
  #
204
- # `BINARY` - A binary data type.
204
+ # `BINARY` A binary data type.
205
205
  # @return [String]
206
206
  #
207
207
  # @!attribute [rw] column_name
208
- # Name for a column.
208
+ # The name of a column.
209
209
  # @return [String]
210
210
  #
211
211
  # @!attribute [rw] column_description
@@ -227,10 +227,14 @@ module Aws::FinSpaceData
227
227
  # @!attribute [rw] message
228
228
  # @return [String]
229
229
  #
230
+ # @!attribute [rw] reason
231
+ # @return [String]
232
+ #
230
233
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ConflictException AWS API Documentation
231
234
  #
232
235
  class ConflictException < Struct.new(
233
- :message)
236
+ :message,
237
+ :reason)
234
238
  SENSITIVE = []
235
239
  include Aws::Structure
236
240
  end
@@ -265,15 +269,15 @@ module Aws::FinSpaceData
265
269
  # @return [String]
266
270
  #
267
271
  # @!attribute [rw] change_type
268
- # Option to indicate how a Changeset will be applied to a Dataset.
272
+ # The option to indicate how a Changeset will be applied to a Dataset.
269
273
  #
270
- # * `REPLACE` - Changeset will be considered as a replacement to all
274
+ # * `REPLACE` Changeset will be considered as a replacement to all
271
275
  # prior loaded Changesets.
272
276
  #
273
- # * `APPEND` - Changeset will be considered as an addition to the end
277
+ # * `APPEND` Changeset will be considered as an addition to the end
274
278
  # of all prior loaded Changesets.
275
279
  #
276
- # * `MODIFY` - Changeset is considered as a replacement to a specific
280
+ # * `MODIFY` Changeset is considered as a replacement to a specific
277
281
  # prior ingested Changeset.
278
282
  # @return [String]
279
283
  #
@@ -292,7 +296,7 @@ module Aws::FinSpaceData
292
296
  # The S3 path that you specify must allow the FinSpace role access. To
293
297
  # do that, you first need to configure the IAM policy on S3 bucket.
294
298
  # For more information, see [Loading data from an Amazon S3 Bucket
295
- # using the FinSpace API][1]section.
299
+ # using the FinSpace API][1] section.
296
300
  #
297
301
  #
298
302
  #
@@ -308,13 +312,13 @@ module Aws::FinSpaceData
308
312
  # `formatType` is a required attribute and can have the following
309
313
  # values:
310
314
  #
311
- # * `PARQUET` - Parquet source file format.
315
+ # * `PARQUET` Parquet source file format.
312
316
  #
313
- # * `CSV` - CSV source file format.
317
+ # * `CSV` CSV source file format.
314
318
  #
315
- # * `JSON` - JSON source file format.
319
+ # * `JSON` JSON source file format.
316
320
  #
317
- # * `XML` - XML source file format.
321
+ # * `XML` XML source file format.
318
322
  #
319
323
  # Here is an example of how you could specify the `formatParams`\:
320
324
  #
@@ -412,7 +416,7 @@ module Aws::FinSpaceData
412
416
  #
413
417
  # @!attribute [rw] as_of_timestamp
414
418
  # Beginning time to use for the Dataview. The value is determined as
415
- # Epoch time in milliseconds. For example, the value for Monday,
419
+ # epoch time in milliseconds. For example, the value for Monday,
416
420
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
417
421
  # @return [Integer]
418
422
  #
@@ -505,9 +509,9 @@ module Aws::FinSpaceData
505
509
  # @!attribute [rw] kind
506
510
  # The format in which Dataset data is structured.
507
511
  #
508
- # * `TABULAR` - Data is structured in a tabular format.
512
+ # * `TABULAR` Data is structured in a tabular format.
509
513
  #
510
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
514
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
511
515
  # @return [String]
512
516
  #
513
517
  # @!attribute [rw] dataset_description
@@ -559,6 +563,166 @@ module Aws::FinSpaceData
559
563
  include Aws::Structure
560
564
  end
561
565
 
566
+ # @note When making an API call, you may pass CreatePermissionGroupRequest
567
+ # data as a hash:
568
+ #
569
+ # {
570
+ # name: "PermissionGroupName", # required
571
+ # description: "PermissionGroupDescription",
572
+ # application_permissions: ["CreateDataset"], # required, accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
573
+ # client_token: "ClientToken",
574
+ # }
575
+ #
576
+ # @!attribute [rw] name
577
+ # The name of the permission group.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] description
581
+ # A brief description for the permission group.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] application_permissions
585
+ # The option to indicate FinSpace application permissions that are
586
+ # granted to a specific group.
587
+ #
588
+ # * `CreateDataset` – Group members can create new datasets.
589
+ #
590
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
591
+ # from FinSpace notebooks.
592
+ #
593
+ # * `ManageUsersAndGroups` – Group members can manage users and
594
+ # permission groups.
595
+ #
596
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
597
+ #
598
+ # * `ViewAuditData` – Group members can view audit data.
599
+ #
600
+ # * `AccessNotebooks` – Group members will have access to FinSpace
601
+ # notebooks.
602
+ #
603
+ # * `GetTemporaryCredentials` – Group members can get temporary API
604
+ # credentials.
605
+ # @return [Array<String>]
606
+ #
607
+ # @!attribute [rw] client_token
608
+ # A token that ensures idempotency. This token expires in 10 minutes.
609
+ #
610
+ # **A suitable default value is auto-generated.** You should normally
611
+ # not need to pass this option.
612
+ # @return [String]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroupRequest AWS API Documentation
615
+ #
616
+ class CreatePermissionGroupRequest < Struct.new(
617
+ :name,
618
+ :description,
619
+ :application_permissions,
620
+ :client_token)
621
+ SENSITIVE = [:name, :description]
622
+ include Aws::Structure
623
+ end
624
+
625
+ # @!attribute [rw] permission_group_id
626
+ # The unique identifier for the permission group.
627
+ # @return [String]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroupResponse AWS API Documentation
630
+ #
631
+ class CreatePermissionGroupResponse < Struct.new(
632
+ :permission_group_id)
633
+ SENSITIVE = []
634
+ include Aws::Structure
635
+ end
636
+
637
+ # @note When making an API call, you may pass CreateUserRequest
638
+ # data as a hash:
639
+ #
640
+ # {
641
+ # email_address: "Email", # required
642
+ # type: "SUPER_USER", # required, accepts SUPER_USER, APP_USER
643
+ # first_name: "FirstName",
644
+ # last_name: "LastName",
645
+ # api_access: "ENABLED", # accepts ENABLED, DISABLED
646
+ # api_access_principal_arn: "RoleArn",
647
+ # client_token: "ClientToken",
648
+ # }
649
+ #
650
+ # @!attribute [rw] email_address
651
+ # The email address of the user that you want to register. The email
652
+ # address serves as a uniquer identifier for each user and cannot be
653
+ # changed after it's created.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] type
657
+ # The option to indicate the type of user. Use one of the following
658
+ # options to specify this parameter:
659
+ #
660
+ # * `SUPER_USER` – A user with permission to all the functionality and
661
+ # data in FinSpace.
662
+ #
663
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
664
+ # users are assigned permissions by adding them to a permission
665
+ # group.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] first_name
669
+ # The first name of the user that you want to register.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] last_name
673
+ # The last name of the user that you want to register.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] api_access
677
+ # The option to indicate whether the user can use the
678
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
679
+ # can then be used to access other FinSpace Data API operations.
680
+ #
681
+ # * `ENABLED` – The user has permissions to use the APIs.
682
+ #
683
+ # * `DISABLED` – The user does not have permissions to use any APIs.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] api_access_principal_arn
687
+ # The ARN identifier of an AWS user or role that is allowed to call
688
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
689
+ # token for a specific FinSpace user. This must be an IAM role within
690
+ # your FinSpace account.
691
+ # @return [String]
692
+ #
693
+ # @!attribute [rw] client_token
694
+ # A token that ensures idempotency. This token expires in 10 minutes.
695
+ #
696
+ # **A suitable default value is auto-generated.** You should normally
697
+ # not need to pass this option.
698
+ # @return [String]
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUserRequest AWS API Documentation
701
+ #
702
+ class CreateUserRequest < Struct.new(
703
+ :email_address,
704
+ :type,
705
+ :first_name,
706
+ :last_name,
707
+ :api_access,
708
+ :api_access_principal_arn,
709
+ :client_token)
710
+ SENSITIVE = [:email_address, :first_name, :last_name]
711
+ include Aws::Structure
712
+ end
713
+
714
+ # @!attribute [rw] user_id
715
+ # The unique identifier for the user.
716
+ # @return [String]
717
+ #
718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUserResponse AWS API Documentation
719
+ #
720
+ class CreateUserResponse < Struct.new(
721
+ :user_id)
722
+ SENSITIVE = []
723
+ include Aws::Structure
724
+ end
725
+
562
726
  # Short term API credentials.
563
727
  #
564
728
  # @!attribute [rw] access_key_id
@@ -599,17 +763,17 @@ module Aws::FinSpaceData
599
763
  # @!attribute [rw] destination_type
600
764
  # Destination type for a Dataview.
601
765
  #
602
- # * `GLUE_TABLE` - Glue table destination type.
766
+ # * `GLUE_TABLE` Glue table destination type.
603
767
  #
604
- # * `S3` - S3 destination type.
768
+ # * `S3` S3 destination type.
605
769
  # @return [String]
606
770
  #
607
771
  # @!attribute [rw] s3_destination_export_file_format
608
772
  # Data view export file format.
609
773
  #
610
- # * `PARQUET` - Parquet export file format.
774
+ # * `PARQUET` Parquet export file format.
611
775
  #
612
- # * `DELIMITED_TEXT` - Delimited text export file format.
776
+ # * `DELIMITED_TEXT` Delimited text export file format.
613
777
  # @return [String]
614
778
  #
615
779
  # @!attribute [rw] s3_destination_export_file_format_options
@@ -640,26 +804,26 @@ module Aws::FinSpaceData
640
804
  # @!attribute [rw] error_category
641
805
  # The category of the error.
642
806
  #
643
- # * `VALIDATION` -The inputs to this request are invalid.
807
+ # * `VALIDATION` The inputs to this request are invalid.
644
808
  #
645
- # * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
809
+ # * `SERVICE_QUOTA_EXCEEDED` Service quotas have been exceeded.
646
810
  # Please contact AWS support to increase quotas.
647
811
  #
648
- # * `ACCESS_DENIED` - Missing required permission to perform this
812
+ # * `ACCESS_DENIED` Missing required permission to perform this
649
813
  # request.
650
814
  #
651
- # * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
815
+ # * `RESOURCE_NOT_FOUND` One or more inputs to this request were not
652
816
  # found.
653
817
  #
654
- # * `THROTTLING` - The system temporarily lacks sufficient resources
818
+ # * `THROTTLING` The system temporarily lacks sufficient resources
655
819
  # to process the request.
656
820
  #
657
- # * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
821
+ # * `INTERNAL_SERVICE_EXCEPTION` An internal service error has
658
822
  # occurred.
659
823
  #
660
- # * `CANCELLED` - Cancelled.
824
+ # * `CANCELLED` Cancelled.
661
825
  #
662
- # * `USER_RECOVERABLE` - A user recoverable error has occurred.
826
+ # * `USER_RECOVERABLE` A user recoverable error has occurred.
663
827
  # @return [String]
664
828
  #
665
829
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewErrorInfo AWS API Documentation
@@ -686,7 +850,7 @@ module Aws::FinSpaceData
686
850
  # @return [String]
687
851
  #
688
852
  # @!attribute [rw] as_of_timestamp
689
- # Time range to use for the Dataview. The value is determined as Epoch
853
+ # Time range to use for the Dataview. The value is determined as epoch
690
854
  # time in milliseconds. For example, the value for Monday, November 1,
691
855
  # 2021 12:00:00 PM UTC is specified as 1635768000000.
692
856
  # @return [Integer]
@@ -702,21 +866,21 @@ module Aws::FinSpaceData
702
866
  # @!attribute [rw] status
703
867
  # The status of a Dataview creation.
704
868
  #
705
- # * `RUNNING` - Dataview creation is running.
869
+ # * `RUNNING` Dataview creation is running.
706
870
  #
707
- # * `STARTING` - Dataview creation is starting.
871
+ # * `STARTING` Dataview creation is starting.
708
872
  #
709
- # * `FAILED` - Dataview creation has failed.
873
+ # * `FAILED` Dataview creation has failed.
710
874
  #
711
- # * `CANCELLED` - Dataview creation has been cancelled.
875
+ # * `CANCELLED` Dataview creation has been cancelled.
712
876
  #
713
- # * `TIMEOUT` - Dataview creation has timed out.
877
+ # * `TIMEOUT` Dataview creation has timed out.
714
878
  #
715
- # * `SUCCESS` - Dataview creation has succeeded.
879
+ # * `SUCCESS` Dataview creation has succeeded.
716
880
  #
717
- # * `PENDING` - Dataview creation is pending.
881
+ # * `PENDING` Dataview creation is pending.
718
882
  #
719
- # * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
883
+ # * `FAILED_CLEANUP_FAILED` Dataview creation failed and resource
720
884
  # cleanup failed.
721
885
  # @return [String]
722
886
  #
@@ -734,14 +898,14 @@ module Aws::FinSpaceData
734
898
  #
735
899
  # @!attribute [rw] create_time
736
900
  # The timestamp at which the Dataview was created in FinSpace. The
737
- # value is determined as Epoch time in milliseconds. For example, the
901
+ # value is determined as epoch time in milliseconds. For example, the
738
902
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
739
903
  # 1635768000000.
740
904
  # @return [Integer]
741
905
  #
742
906
  # @!attribute [rw] last_modified_time
743
907
  # The last time that a Dataview was modified. The value is determined
744
- # as Epoch time in milliseconds. For example, the value for Monday,
908
+ # as epoch time in milliseconds. For example, the value for Monday,
745
909
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
746
910
  # @return [Integer]
747
911
  #
@@ -781,9 +945,9 @@ module Aws::FinSpaceData
781
945
  # @!attribute [rw] kind
782
946
  # The format in which Dataset data is structured.
783
947
  #
784
- # * `TABULAR` - Data is structured in a tabular format.
948
+ # * `TABULAR` Data is structured in a tabular format.
785
949
  #
786
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
950
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
787
951
  # @return [String]
788
952
  #
789
953
  # @!attribute [rw] dataset_description
@@ -796,14 +960,14 @@ module Aws::FinSpaceData
796
960
  #
797
961
  # @!attribute [rw] create_time
798
962
  # The timestamp at which the Dataset was created in FinSpace. The
799
- # value is determined as Epoch time in milliseconds. For example, the
963
+ # value is determined as epoch time in milliseconds. For example, the
800
964
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
801
965
  # 1635768000000.
802
966
  # @return [Integer]
803
967
  #
804
968
  # @!attribute [rw] last_modified_time
805
969
  # The last time that the Dataset was modified. The value is determined
806
- # as Epoch time in milliseconds. For example, the value for Monday,
970
+ # as epoch time in milliseconds. For example, the value for Monday,
807
971
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
808
972
  # @return [Integer]
809
973
  #
@@ -844,7 +1008,7 @@ module Aws::FinSpaceData
844
1008
  # }
845
1009
  #
846
1010
  # @!attribute [rw] name
847
- # Name of the Dataset owner.
1011
+ # The name of the Dataset owner.
848
1012
  # @return [String]
849
1013
  #
850
1014
  # @!attribute [rw] phone_number
@@ -861,7 +1025,7 @@ module Aws::FinSpaceData
861
1025
  :name,
862
1026
  :phone_number,
863
1027
  :email)
864
- SENSITIVE = []
1028
+ SENSITIVE = [:email]
865
1029
  include Aws::Structure
866
1030
  end
867
1031
 
@@ -909,6 +1073,127 @@ module Aws::FinSpaceData
909
1073
  include Aws::Structure
910
1074
  end
911
1075
 
1076
+ # @note When making an API call, you may pass DeletePermissionGroupRequest
1077
+ # data as a hash:
1078
+ #
1079
+ # {
1080
+ # permission_group_id: "PermissionGroupId", # required
1081
+ # client_token: "ClientToken",
1082
+ # }
1083
+ #
1084
+ # @!attribute [rw] permission_group_id
1085
+ # The unique identifier for the permission group that you want to
1086
+ # delete.
1087
+ # @return [String]
1088
+ #
1089
+ # @!attribute [rw] client_token
1090
+ # A token that ensures idempotency. This token expires in 10 minutes.
1091
+ #
1092
+ # **A suitable default value is auto-generated.** You should normally
1093
+ # not need to pass this option.
1094
+ # @return [String]
1095
+ #
1096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroupRequest AWS API Documentation
1097
+ #
1098
+ class DeletePermissionGroupRequest < Struct.new(
1099
+ :permission_group_id,
1100
+ :client_token)
1101
+ SENSITIVE = []
1102
+ include Aws::Structure
1103
+ end
1104
+
1105
+ # @!attribute [rw] permission_group_id
1106
+ # The unique identifier for the deleted permission group.
1107
+ # @return [String]
1108
+ #
1109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroupResponse AWS API Documentation
1110
+ #
1111
+ class DeletePermissionGroupResponse < Struct.new(
1112
+ :permission_group_id)
1113
+ SENSITIVE = []
1114
+ include Aws::Structure
1115
+ end
1116
+
1117
+ # @note When making an API call, you may pass DisableUserRequest
1118
+ # data as a hash:
1119
+ #
1120
+ # {
1121
+ # user_id: "UserId", # required
1122
+ # client_token: "ClientToken",
1123
+ # }
1124
+ #
1125
+ # @!attribute [rw] user_id
1126
+ # The unique identifier for the user account that you want to disable.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] client_token
1130
+ # A token that ensures idempotency. This token expires in 10 minutes.
1131
+ #
1132
+ # **A suitable default value is auto-generated.** You should normally
1133
+ # not need to pass this option.
1134
+ # @return [String]
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUserRequest AWS API Documentation
1137
+ #
1138
+ class DisableUserRequest < Struct.new(
1139
+ :user_id,
1140
+ :client_token)
1141
+ SENSITIVE = []
1142
+ include Aws::Structure
1143
+ end
1144
+
1145
+ # @!attribute [rw] user_id
1146
+ # The unique identifier for the disabled user account.
1147
+ # @return [String]
1148
+ #
1149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUserResponse AWS API Documentation
1150
+ #
1151
+ class DisableUserResponse < Struct.new(
1152
+ :user_id)
1153
+ SENSITIVE = []
1154
+ include Aws::Structure
1155
+ end
1156
+
1157
+ # @note When making an API call, you may pass EnableUserRequest
1158
+ # data as a hash:
1159
+ #
1160
+ # {
1161
+ # user_id: "UserId", # required
1162
+ # client_token: "ClientToken",
1163
+ # }
1164
+ #
1165
+ # @!attribute [rw] user_id
1166
+ # The unique identifier for the user account that you want to enable.
1167
+ # @return [String]
1168
+ #
1169
+ # @!attribute [rw] client_token
1170
+ # A token that ensures idempotency. This token expires in 10 minutes.
1171
+ #
1172
+ # **A suitable default value is auto-generated.** You should normally
1173
+ # not need to pass this option.
1174
+ # @return [String]
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUserRequest AWS API Documentation
1177
+ #
1178
+ class EnableUserRequest < Struct.new(
1179
+ :user_id,
1180
+ :client_token)
1181
+ SENSITIVE = []
1182
+ include Aws::Structure
1183
+ end
1184
+
1185
+ # @!attribute [rw] user_id
1186
+ # The unique identifier for the enabled user account.
1187
+ # @return [String]
1188
+ #
1189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUserResponse AWS API Documentation
1190
+ #
1191
+ class EnableUserResponse < Struct.new(
1192
+ :user_id)
1193
+ SENSITIVE = []
1194
+ include Aws::Structure
1195
+ end
1196
+
912
1197
  # Request to describe a changeset.
913
1198
  #
914
1199
  # @note When making an API call, you may pass GetChangesetRequest
@@ -955,13 +1240,13 @@ module Aws::FinSpaceData
955
1240
  # @!attribute [rw] change_type
956
1241
  # Type that indicates how a Changeset is applied to a Dataset.
957
1242
  #
958
- # * `REPLACE` - Changeset is considered as a replacement to all prior
1243
+ # * `REPLACE` Changeset is considered as a replacement to all prior
959
1244
  # loaded Changesets.
960
1245
  #
961
- # * `APPEND` - Changeset is considered as an addition to the end of
1246
+ # * `APPEND` Changeset is considered as an addition to the end of
962
1247
  # all prior loaded Changesets.
963
1248
  #
964
- # * `MODIFY` - Changeset is considered as a replacement to a specific
1249
+ # * `MODIFY` Changeset is considered as a replacement to a specific
965
1250
  # prior ingested Changeset.
966
1251
  # @return [String]
967
1252
  #
@@ -975,7 +1260,7 @@ module Aws::FinSpaceData
975
1260
  #
976
1261
  # @!attribute [rw] create_time
977
1262
  # The timestamp at which the Changeset was created in FinSpace. The
978
- # value is determined as Epoch time in milliseconds. For example, the
1263
+ # value is determined as epoch time in milliseconds. For example, the
979
1264
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
980
1265
  # 1635768000000.
981
1266
  # @return [Integer]
@@ -990,13 +1275,13 @@ module Aws::FinSpaceData
990
1275
  #
991
1276
  # @!attribute [rw] active_until_timestamp
992
1277
  # Time until which the Changeset is active. The value is determined as
993
- # Epoch time in milliseconds. For example, the value for Monday,
1278
+ # epoch time in milliseconds. For example, the value for Monday,
994
1279
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
995
1280
  # @return [Integer]
996
1281
  #
997
1282
  # @!attribute [rw] active_from_timestamp
998
1283
  # Beginning time from which the Changeset is active. The value is
999
- # determined as Epoch time in milliseconds. For example, the value for
1284
+ # determined as epoch time in milliseconds. For example, the value for
1000
1285
  # Monday, November 1, 2021 12:00:00 PM UTC is specified as
1001
1286
  # 1635768000000.
1002
1287
  # @return [Integer]
@@ -1073,7 +1358,7 @@ module Aws::FinSpaceData
1073
1358
  # @return [String]
1074
1359
  #
1075
1360
  # @!attribute [rw] as_of_timestamp
1076
- # Time range to use for the Dataview. The value is determined as Epoch
1361
+ # Time range to use for the Dataview. The value is determined as epoch
1077
1362
  # time in milliseconds. For example, the value for Monday, November 1,
1078
1363
  # 2021 12:00:00 PM UTC is specified as 1635768000000.
1079
1364
  # @return [Integer]
@@ -1084,13 +1369,13 @@ module Aws::FinSpaceData
1084
1369
  #
1085
1370
  # @!attribute [rw] last_modified_time
1086
1371
  # The last time that a Dataview was modified. The value is determined
1087
- # as Epoch time in milliseconds. For example, the value for Monday,
1372
+ # as epoch time in milliseconds. For example, the value for Monday,
1088
1373
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1089
1374
  # @return [Integer]
1090
1375
  #
1091
1376
  # @!attribute [rw] create_time
1092
1377
  # The timestamp at which the Dataview was created in FinSpace. The
1093
- # value is determined as Epoch time in milliseconds. For example, the
1378
+ # value is determined as epoch time in milliseconds. For example, the
1094
1379
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1095
1380
  # 1635768000000.
1096
1381
  # @return [Integer]
@@ -1114,21 +1399,21 @@ module Aws::FinSpaceData
1114
1399
  # @!attribute [rw] status
1115
1400
  # The status of a Dataview creation.
1116
1401
  #
1117
- # * `RUNNING` - Dataview creation is running.
1402
+ # * `RUNNING` Dataview creation is running.
1118
1403
  #
1119
- # * `STARTING` - Dataview creation is starting.
1404
+ # * `STARTING` Dataview creation is starting.
1120
1405
  #
1121
- # * `FAILED` - Dataview creation has failed.
1406
+ # * `FAILED` Dataview creation has failed.
1122
1407
  #
1123
- # * `CANCELLED` - Dataview creation has been cancelled.
1408
+ # * `CANCELLED` Dataview creation has been cancelled.
1124
1409
  #
1125
- # * `TIMEOUT` - Dataview creation has timed out.
1410
+ # * `TIMEOUT` Dataview creation has timed out.
1126
1411
  #
1127
- # * `SUCCESS` - Dataview creation has succeeded.
1412
+ # * `SUCCESS` Dataview creation has succeeded.
1128
1413
  #
1129
- # * `PENDING` - Dataview creation is pending.
1414
+ # * `PENDING` Dataview creation is pending.
1130
1415
  #
1131
- # * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
1416
+ # * `FAILED_CLEANUP_FAILED` Dataview creation failed and resource
1132
1417
  # cleanup failed.
1133
1418
  # @return [String]
1134
1419
  #
@@ -1189,9 +1474,9 @@ module Aws::FinSpaceData
1189
1474
  # @!attribute [rw] kind
1190
1475
  # The format in which Dataset data is structured.
1191
1476
  #
1192
- # * `TABULAR` - Data is structured in a tabular format.
1477
+ # * `TABULAR` Data is structured in a tabular format.
1193
1478
  #
1194
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
1479
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
1195
1480
  # @return [String]
1196
1481
  #
1197
1482
  # @!attribute [rw] dataset_description
@@ -1200,14 +1485,14 @@ module Aws::FinSpaceData
1200
1485
  #
1201
1486
  # @!attribute [rw] create_time
1202
1487
  # The timestamp at which the Dataset was created in FinSpace. The
1203
- # value is determined as Epoch time in milliseconds. For example, the
1488
+ # value is determined as epoch time in milliseconds. For example, the
1204
1489
  # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1205
1490
  # 1635768000000.
1206
1491
  # @return [Integer]
1207
1492
  #
1208
1493
  # @!attribute [rw] last_modified_time
1209
1494
  # The last time that the Dataset was modified. The value is determined
1210
- # as Epoch time in milliseconds. For example, the value for Monday,
1495
+ # as epoch time in milliseconds. For example, the value for Monday,
1211
1496
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1212
1497
  # @return [Integer]
1213
1498
  #
@@ -1222,13 +1507,13 @@ module Aws::FinSpaceData
1222
1507
  # @!attribute [rw] status
1223
1508
  # Status of the Dataset creation.
1224
1509
  #
1225
- # * `PENDING` - Dataset is pending creation.
1510
+ # * `PENDING` Dataset is pending creation.
1226
1511
  #
1227
- # * `FAILED` - Dataset creation has failed.
1512
+ # * `FAILED` Dataset creation has failed.
1228
1513
  #
1229
- # * `SUCCESS` - Dataset creation has succeeded.
1514
+ # * `SUCCESS` Dataset creation has succeeded.
1230
1515
  #
1231
- # * `RUNNING` - Dataset creation is running.
1516
+ # * `RUNNING` Dataset creation is running.
1232
1517
  # @return [String]
1233
1518
  #
1234
1519
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDatasetResponse AWS API Documentation
@@ -1294,6 +1579,129 @@ module Aws::FinSpaceData
1294
1579
  include Aws::Structure
1295
1580
  end
1296
1581
 
1582
+ # @note When making an API call, you may pass GetUserRequest
1583
+ # data as a hash:
1584
+ #
1585
+ # {
1586
+ # user_id: "UserId", # required
1587
+ # }
1588
+ #
1589
+ # @!attribute [rw] user_id
1590
+ # The unique identifier of the user to get data for.
1591
+ # @return [String]
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUserRequest AWS API Documentation
1594
+ #
1595
+ class GetUserRequest < Struct.new(
1596
+ :user_id)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1601
+ # @!attribute [rw] user_id
1602
+ # The unique identifier for the user account that is retrieved.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] status
1606
+ # The current status of the user account.
1607
+ #
1608
+ # * `CREATING` – The user account creation is in progress.
1609
+ #
1610
+ # * `ENABLED` – The user account is created and is currently active.
1611
+ #
1612
+ # * `DISABLED` – The user account is currently inactive.
1613
+ # @return [String]
1614
+ #
1615
+ # @!attribute [rw] first_name
1616
+ # The first name of the user.
1617
+ # @return [String]
1618
+ #
1619
+ # @!attribute [rw] last_name
1620
+ # The last name of the user.
1621
+ # @return [String]
1622
+ #
1623
+ # @!attribute [rw] email_address
1624
+ # The email address that is associated with the user.
1625
+ # @return [String]
1626
+ #
1627
+ # @!attribute [rw] type
1628
+ # Indicates the type of user.
1629
+ #
1630
+ # * `SUPER_USER` – A user with permission to all the functionality and
1631
+ # data in FinSpace.
1632
+ #
1633
+ # ^
1634
+ # ^
1635
+ #
1636
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
1637
+ # users are assigned permissions by adding them to a permissions
1638
+ # group.
1639
+ #
1640
+ # ^
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] api_access
1644
+ # Indicates whether the user can use the
1645
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
1646
+ # can then be used to access other FinSpace Data API operations.
1647
+ #
1648
+ # * `ENABLED` – The user has permissions to use the APIs.
1649
+ #
1650
+ # * `DISABLED` – The user does not have permissions to use any APIs.
1651
+ # @return [String]
1652
+ #
1653
+ # @!attribute [rw] api_access_principal_arn
1654
+ # The ARN identifier of an AWS user or role that is allowed to call
1655
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
1656
+ # token for a specific FinSpace user. This must be an IAM role within
1657
+ # your FinSpace account.
1658
+ # @return [String]
1659
+ #
1660
+ # @!attribute [rw] create_time
1661
+ # The timestamp at which the user account was created in FinSpace. The
1662
+ # value is determined as epoch time in milliseconds.
1663
+ # @return [Integer]
1664
+ #
1665
+ # @!attribute [rw] last_enabled_time
1666
+ # Describes the last time the user account was enabled. The value is
1667
+ # determined as epoch time in milliseconds.
1668
+ # @return [Integer]
1669
+ #
1670
+ # @!attribute [rw] last_disabled_time
1671
+ # Describes the last time the user account was disabled. The value is
1672
+ # determined as epoch time in milliseconds.
1673
+ # @return [Integer]
1674
+ #
1675
+ # @!attribute [rw] last_modified_time
1676
+ # Describes the last time the user account was updated. The value is
1677
+ # determined as epoch time in milliseconds.
1678
+ # @return [Integer]
1679
+ #
1680
+ # @!attribute [rw] last_login_time
1681
+ # Describes the last time that the user logged into their account. The
1682
+ # value is determined as epoch time in milliseconds.
1683
+ # @return [Integer]
1684
+ #
1685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUserResponse AWS API Documentation
1686
+ #
1687
+ class GetUserResponse < Struct.new(
1688
+ :user_id,
1689
+ :status,
1690
+ :first_name,
1691
+ :last_name,
1692
+ :email_address,
1693
+ :type,
1694
+ :api_access,
1695
+ :api_access_principal_arn,
1696
+ :create_time,
1697
+ :last_enabled_time,
1698
+ :last_disabled_time,
1699
+ :last_modified_time,
1700
+ :last_login_time)
1701
+ SENSITIVE = [:first_name, :last_name, :email_address]
1702
+ include Aws::Structure
1703
+ end
1704
+
1297
1705
  # @note When making an API call, you may pass GetWorkingLocationRequest
1298
1706
  # data as a hash:
1299
1707
  #
@@ -1304,11 +1712,11 @@ module Aws::FinSpaceData
1304
1712
  # @!attribute [rw] location_type
1305
1713
  # Specify the type of the working location.
1306
1714
  #
1307
- # * `SAGEMAKER` - Use the Amazon S3 location as a temporary location
1715
+ # * `SAGEMAKER` Use the Amazon S3 location as a temporary location
1308
1716
  # to store data content when working with FinSpace Notebooks that
1309
1717
  # run on SageMaker studio.
1310
1718
  #
1311
- # * `INGESTION` - Use the Amazon S3 location as a staging location to
1719
+ # * `INGESTION` Use the Amazon S3 location as a staging location to
1312
1720
  # copy your data content and then use the location with the
1313
1721
  # Changeset creation operation.
1314
1722
  # @return [String]
@@ -1391,7 +1799,7 @@ module Aws::FinSpaceData
1391
1799
  # @return [Integer]
1392
1800
  #
1393
1801
  # @!attribute [rw] next_token
1394
- # A token indicating where a results page should begin.
1802
+ # A token that indicates where a results page should begin.
1395
1803
  # @return [String]
1396
1804
  #
1397
1805
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsRequest AWS API Documentation
@@ -1412,7 +1820,7 @@ module Aws::FinSpaceData
1412
1820
  # @return [Array<Types::ChangesetSummary>]
1413
1821
  #
1414
1822
  # @!attribute [rw] next_token
1415
- # A token indicating where a results page should begin.
1823
+ # A token that indicates where a results page should begin.
1416
1824
  # @return [String]
1417
1825
  #
1418
1826
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsResponse AWS API Documentation
@@ -1441,7 +1849,7 @@ module Aws::FinSpaceData
1441
1849
  # @return [String]
1442
1850
  #
1443
1851
  # @!attribute [rw] next_token
1444
- # A token indicating where a results page should begin.
1852
+ # A token that indicates where a results page should begin.
1445
1853
  # @return [String]
1446
1854
  #
1447
1855
  # @!attribute [rw] max_results
@@ -1459,7 +1867,7 @@ module Aws::FinSpaceData
1459
1867
  end
1460
1868
 
1461
1869
  # @!attribute [rw] next_token
1462
- # A token indicating where a results page should begin.
1870
+ # A token that indicates where a results page should begin.
1463
1871
  # @return [String]
1464
1872
  #
1465
1873
  # @!attribute [rw] data_views
@@ -1486,7 +1894,7 @@ module Aws::FinSpaceData
1486
1894
  # }
1487
1895
  #
1488
1896
  # @!attribute [rw] next_token
1489
- # A token indicating where a results page should begin.
1897
+ # A token that indicates where a results page should begin.
1490
1898
  # @return [String]
1491
1899
  #
1492
1900
  # @!attribute [rw] max_results
@@ -1509,7 +1917,7 @@ module Aws::FinSpaceData
1509
1917
  # @return [Array<Types::Dataset>]
1510
1918
  #
1511
1919
  # @!attribute [rw] next_token
1512
- # A token indicating where a results page should begin.
1920
+ # A token that indicates where a results page should begin.
1513
1921
  # @return [String]
1514
1922
  #
1515
1923
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasetsResponse AWS API Documentation
@@ -1521,6 +1929,150 @@ module Aws::FinSpaceData
1521
1929
  include Aws::Structure
1522
1930
  end
1523
1931
 
1932
+ # @note When making an API call, you may pass ListPermissionGroupsRequest
1933
+ # data as a hash:
1934
+ #
1935
+ # {
1936
+ # next_token: "PaginationToken",
1937
+ # max_results: 1, # required
1938
+ # }
1939
+ #
1940
+ # @!attribute [rw] next_token
1941
+ # A token that indicates where a results page should begin.
1942
+ # @return [String]
1943
+ #
1944
+ # @!attribute [rw] max_results
1945
+ # The maximum number of results per page.
1946
+ # @return [Integer]
1947
+ #
1948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsRequest AWS API Documentation
1949
+ #
1950
+ class ListPermissionGroupsRequest < Struct.new(
1951
+ :next_token,
1952
+ :max_results)
1953
+ SENSITIVE = []
1954
+ include Aws::Structure
1955
+ end
1956
+
1957
+ # @!attribute [rw] permission_groups
1958
+ # A list of all the permission groups.
1959
+ # @return [Array<Types::PermissionGroup>]
1960
+ #
1961
+ # @!attribute [rw] next_token
1962
+ # A token that indicates where a results page should begin.
1963
+ # @return [String]
1964
+ #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsResponse AWS API Documentation
1966
+ #
1967
+ class ListPermissionGroupsResponse < Struct.new(
1968
+ :permission_groups,
1969
+ :next_token)
1970
+ SENSITIVE = []
1971
+ include Aws::Structure
1972
+ end
1973
+
1974
+ # @note When making an API call, you may pass ListUsersRequest
1975
+ # data as a hash:
1976
+ #
1977
+ # {
1978
+ # next_token: "PaginationToken",
1979
+ # max_results: 1, # required
1980
+ # }
1981
+ #
1982
+ # @!attribute [rw] next_token
1983
+ # A token that indicates where a results page should begin.
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] max_results
1987
+ # The maximum number of results per page.
1988
+ # @return [Integer]
1989
+ #
1990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersRequest AWS API Documentation
1991
+ #
1992
+ class ListUsersRequest < Struct.new(
1993
+ :next_token,
1994
+ :max_results)
1995
+ SENSITIVE = []
1996
+ include Aws::Structure
1997
+ end
1998
+
1999
+ # @!attribute [rw] users
2000
+ # A list of all the user accounts.
2001
+ # @return [Array<Types::User>]
2002
+ #
2003
+ # @!attribute [rw] next_token
2004
+ # A token that indicates where a results page should begin.
2005
+ # @return [String]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersResponse AWS API Documentation
2008
+ #
2009
+ class ListUsersResponse < Struct.new(
2010
+ :users,
2011
+ :next_token)
2012
+ SENSITIVE = []
2013
+ include Aws::Structure
2014
+ end
2015
+
2016
+ # The structure for a permission group.
2017
+ #
2018
+ # @!attribute [rw] permission_group_id
2019
+ # The unique identifier for the permission group.
2020
+ # @return [String]
2021
+ #
2022
+ # @!attribute [rw] name
2023
+ # The name of the permission group.
2024
+ # @return [String]
2025
+ #
2026
+ # @!attribute [rw] description
2027
+ # A brief description for the permission group.
2028
+ # @return [String]
2029
+ #
2030
+ # @!attribute [rw] application_permissions
2031
+ # Indicates the permissions that are granted to a specific group for
2032
+ # accessing the FinSpace application.
2033
+ #
2034
+ # * `CreateDataset` – Group members can create new datasets.
2035
+ #
2036
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
2037
+ # from FinSpace notebooks.
2038
+ #
2039
+ # * `ManageUsersAndGroups` – Group members can manage users and
2040
+ # permission groups.
2041
+ #
2042
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
2043
+ #
2044
+ # * `ViewAuditData` – Group members can view audit data.
2045
+ #
2046
+ # * `AccessNotebooks` – Group members will have access to FinSpace
2047
+ # notebooks.
2048
+ #
2049
+ # * `GetTemporaryCredentials` – Group members can get temporary API
2050
+ # credentials.
2051
+ # @return [Array<String>]
2052
+ #
2053
+ # @!attribute [rw] create_time
2054
+ # The timestamp at which the group was created in FinSpace. The value
2055
+ # is determined as epoch time in milliseconds.
2056
+ # @return [Integer]
2057
+ #
2058
+ # @!attribute [rw] last_modified_time
2059
+ # Describes the last time the permission group was updated. The value
2060
+ # is determined as epoch time in milliseconds.
2061
+ # @return [Integer]
2062
+ #
2063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroup AWS API Documentation
2064
+ #
2065
+ class PermissionGroup < Struct.new(
2066
+ :permission_group_id,
2067
+ :name,
2068
+ :description,
2069
+ :application_permissions,
2070
+ :create_time,
2071
+ :last_modified_time)
2072
+ SENSITIVE = [:name, :description]
2073
+ include Aws::Structure
2074
+ end
2075
+
1524
2076
  # Permission group parameters for Dataset permissions.
1525
2077
  #
1526
2078
  # Here is an example of how you could specify the
@@ -1544,7 +2096,7 @@ module Aws::FinSpaceData
1544
2096
  # }
1545
2097
  #
1546
2098
  # @!attribute [rw] permission_group_id
1547
- # The unique identifier of the PermissionGroup.
2099
+ # The unique identifier for the `PermissionGroup`.
1548
2100
  # @return [String]
1549
2101
  #
1550
2102
  # @!attribute [rw] dataset_permissions
@@ -1560,15 +2112,67 @@ module Aws::FinSpaceData
1560
2112
  include Aws::Structure
1561
2113
  end
1562
2114
 
2115
+ # @note When making an API call, you may pass ResetUserPasswordRequest
2116
+ # data as a hash:
2117
+ #
2118
+ # {
2119
+ # user_id: "UserId", # required
2120
+ # client_token: "ClientToken",
2121
+ # }
2122
+ #
2123
+ # @!attribute [rw] user_id
2124
+ # The unique identifier of the user that a temporary password is
2125
+ # requested for.
2126
+ # @return [String]
2127
+ #
2128
+ # @!attribute [rw] client_token
2129
+ # A token that ensures idempotency. This token expires in 10 minutes.
2130
+ #
2131
+ # **A suitable default value is auto-generated.** You should normally
2132
+ # not need to pass this option.
2133
+ # @return [String]
2134
+ #
2135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPasswordRequest AWS API Documentation
2136
+ #
2137
+ class ResetUserPasswordRequest < Struct.new(
2138
+ :user_id,
2139
+ :client_token)
2140
+ SENSITIVE = []
2141
+ include Aws::Structure
2142
+ end
2143
+
2144
+ # @!attribute [rw] user_id
2145
+ # The unique identifier of the user that a new password is generated
2146
+ # for.
2147
+ # @return [String]
2148
+ #
2149
+ # @!attribute [rw] temporary_password
2150
+ # A randomly generated temporary password for the requested user
2151
+ # account. This password expires in 7 days.
2152
+ # @return [String]
2153
+ #
2154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPasswordResponse AWS API Documentation
2155
+ #
2156
+ class ResetUserPasswordResponse < Struct.new(
2157
+ :user_id,
2158
+ :temporary_password)
2159
+ SENSITIVE = [:temporary_password]
2160
+ include Aws::Structure
2161
+ end
2162
+
1563
2163
  # One or more resources can't be found.
1564
2164
  #
1565
2165
  # @!attribute [rw] message
1566
2166
  # @return [String]
1567
2167
  #
2168
+ # @!attribute [rw] reason
2169
+ # @return [String]
2170
+ #
1568
2171
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResourceNotFoundException AWS API Documentation
1569
2172
  #
1570
2173
  class ResourceNotFoundException < Struct.new(
1571
- :message)
2174
+ :message,
2175
+ :reason)
1572
2176
  SENSITIVE = []
1573
2177
  include Aws::Structure
1574
2178
  end
@@ -1593,8 +2197,8 @@ module Aws::FinSpaceData
1593
2197
  #
1594
2198
  # * `DeleteDataset`
1595
2199
  #
1596
- # For more information on the ataset permissions, see [Supported Dataset
1597
- # Permissions][1] in the FinSpace User Guide.
2200
+ # For more information on the dataset permissions, see [Supported
2201
+ # Dataset Permissions][1] in the FinSpace User Guide.
1598
2202
  #
1599
2203
  #
1600
2204
  #
@@ -1752,13 +2356,13 @@ module Aws::FinSpaceData
1752
2356
  # `formatType` is a required attribute and can have the following
1753
2357
  # values:
1754
2358
  #
1755
- # * `PARQUET` - Parquet source file format.
2359
+ # * `PARQUET` Parquet source file format.
1756
2360
  #
1757
- # * `CSV` - CSV source file format.
2361
+ # * `CSV` CSV source file format.
1758
2362
  #
1759
- # * `JSON` - JSON source file format.
2363
+ # * `JSON` JSON source file format.
1760
2364
  #
1761
- # * `XML` - XML source file format.
2365
+ # * `XML` XML source file format.
1762
2366
  #
1763
2367
  # Here is an example of how you could specify the `formatParams`\:
1764
2368
  #
@@ -1854,9 +2458,9 @@ module Aws::FinSpaceData
1854
2458
  # @!attribute [rw] kind
1855
2459
  # The format in which the Dataset data is structured.
1856
2460
  #
1857
- # * `TABULAR` - Data is structured in a tabular format.
2461
+ # * `TABULAR` Data is structured in a tabular format.
1858
2462
  #
1859
- # * `NON_TABULAR` - Data is structured in a non-tabular format.
2463
+ # * `NON_TABULAR` Data is structured in a non-tabular format.
1860
2464
  # @return [String]
1861
2465
  #
1862
2466
  # @!attribute [rw] dataset_description
@@ -1899,16 +2503,285 @@ module Aws::FinSpaceData
1899
2503
  include Aws::Structure
1900
2504
  end
1901
2505
 
2506
+ # @note When making an API call, you may pass UpdatePermissionGroupRequest
2507
+ # data as a hash:
2508
+ #
2509
+ # {
2510
+ # permission_group_id: "PermissionGroupId", # required
2511
+ # name: "PermissionGroupName",
2512
+ # description: "PermissionGroupDescription",
2513
+ # application_permissions: ["CreateDataset"], # accepts CreateDataset, ManageClusters, ManageUsersAndGroups, ManageAttributeSets, ViewAuditData, AccessNotebooks, GetTemporaryCredentials
2514
+ # client_token: "ClientToken",
2515
+ # }
2516
+ #
2517
+ # @!attribute [rw] permission_group_id
2518
+ # The unique identifier for the permission group to update.
2519
+ # @return [String]
2520
+ #
2521
+ # @!attribute [rw] name
2522
+ # The name of the permission group.
2523
+ # @return [String]
2524
+ #
2525
+ # @!attribute [rw] description
2526
+ # A brief description for the permission group.
2527
+ # @return [String]
2528
+ #
2529
+ # @!attribute [rw] application_permissions
2530
+ # The permissions that are granted to a specific group for accessing
2531
+ # the FinSpace application.
2532
+ #
2533
+ # * `CreateDataset` – Group members can create new datasets.
2534
+ #
2535
+ # * `ManageClusters` – Group members can manage Apache Spark clusters
2536
+ # from FinSpace notebooks.
2537
+ #
2538
+ # * `ManageUsersAndGroups` – Group members can manage users and
2539
+ # permission groups.
2540
+ #
2541
+ # * `ManageAttributeSets` – Group members can manage attribute sets.
2542
+ #
2543
+ # * `ViewAuditData` – Group members can view audit data.
2544
+ #
2545
+ # * `AccessNotebooks` – Group members will have access to FinSpace
2546
+ # notebooks.
2547
+ #
2548
+ # * `GetTemporaryCredentials` – Group members can get temporary API
2549
+ # credentials.
2550
+ # @return [Array<String>]
2551
+ #
2552
+ # @!attribute [rw] client_token
2553
+ # A token that ensures idempotency. This token expires in 10 minutes.
2554
+ #
2555
+ # **A suitable default value is auto-generated.** You should normally
2556
+ # not need to pass this option.
2557
+ # @return [String]
2558
+ #
2559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroupRequest AWS API Documentation
2560
+ #
2561
+ class UpdatePermissionGroupRequest < Struct.new(
2562
+ :permission_group_id,
2563
+ :name,
2564
+ :description,
2565
+ :application_permissions,
2566
+ :client_token)
2567
+ SENSITIVE = [:name, :description]
2568
+ include Aws::Structure
2569
+ end
2570
+
2571
+ # @!attribute [rw] permission_group_id
2572
+ # The unique identifier for the updated permission group.
2573
+ # @return [String]
2574
+ #
2575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroupResponse AWS API Documentation
2576
+ #
2577
+ class UpdatePermissionGroupResponse < Struct.new(
2578
+ :permission_group_id)
2579
+ SENSITIVE = []
2580
+ include Aws::Structure
2581
+ end
2582
+
2583
+ # @note When making an API call, you may pass UpdateUserRequest
2584
+ # data as a hash:
2585
+ #
2586
+ # {
2587
+ # user_id: "UserId", # required
2588
+ # type: "SUPER_USER", # accepts SUPER_USER, APP_USER
2589
+ # first_name: "FirstName",
2590
+ # last_name: "LastName",
2591
+ # api_access: "ENABLED", # accepts ENABLED, DISABLED
2592
+ # api_access_principal_arn: "RoleArn",
2593
+ # client_token: "ClientToken",
2594
+ # }
2595
+ #
2596
+ # @!attribute [rw] user_id
2597
+ # The unique identifier for the user account to update.
2598
+ # @return [String]
2599
+ #
2600
+ # @!attribute [rw] type
2601
+ # The option to indicate the type of user.
2602
+ #
2603
+ # * `SUPER_USER`– A user with permission to all the functionality and
2604
+ # data in FinSpace.
2605
+ #
2606
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
2607
+ # users are assigned permissions by adding them to a permissions
2608
+ # group.
2609
+ # @return [String]
2610
+ #
2611
+ # @!attribute [rw] first_name
2612
+ # The first name of the user.
2613
+ # @return [String]
2614
+ #
2615
+ # @!attribute [rw] last_name
2616
+ # The last name of the user.
2617
+ # @return [String]
2618
+ #
2619
+ # @!attribute [rw] api_access
2620
+ # The option to indicate whether the user can use the
2621
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
2622
+ # can then be used to access other FinSpace Data API operations.
2623
+ #
2624
+ # * `ENABLED` – The user has permissions to use the APIs.
2625
+ #
2626
+ # * `DISABLED` – The user does not have permissions to use any APIs.
2627
+ # @return [String]
2628
+ #
2629
+ # @!attribute [rw] api_access_principal_arn
2630
+ # The ARN identifier of an AWS user or role that is allowed to call
2631
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
2632
+ # token for a specific FinSpace user. This must be an IAM role within
2633
+ # your FinSpace account.
2634
+ # @return [String]
2635
+ #
2636
+ # @!attribute [rw] client_token
2637
+ # A token that ensures idempotency. This token expires in 10 minutes.
2638
+ #
2639
+ # **A suitable default value is auto-generated.** You should normally
2640
+ # not need to pass this option.
2641
+ # @return [String]
2642
+ #
2643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUserRequest AWS API Documentation
2644
+ #
2645
+ class UpdateUserRequest < Struct.new(
2646
+ :user_id,
2647
+ :type,
2648
+ :first_name,
2649
+ :last_name,
2650
+ :api_access,
2651
+ :api_access_principal_arn,
2652
+ :client_token)
2653
+ SENSITIVE = [:first_name, :last_name]
2654
+ include Aws::Structure
2655
+ end
2656
+
2657
+ # @!attribute [rw] user_id
2658
+ # The unique identifier of the updated user account.
2659
+ # @return [String]
2660
+ #
2661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUserResponse AWS API Documentation
2662
+ #
2663
+ class UpdateUserResponse < Struct.new(
2664
+ :user_id)
2665
+ SENSITIVE = []
2666
+ include Aws::Structure
2667
+ end
2668
+
2669
+ # The details of the user account.
2670
+ #
2671
+ # @!attribute [rw] user_id
2672
+ # The unique identifier for the user.
2673
+ # @return [String]
2674
+ #
2675
+ # @!attribute [rw] status
2676
+ # The current status of the user account.
2677
+ #
2678
+ # * `CREATING` – The user account creation is in progress.
2679
+ #
2680
+ # * `ENABLED` – The user account is created and is currently active.
2681
+ #
2682
+ # * `DISABLED` – The user account is currently inactive.
2683
+ # @return [String]
2684
+ #
2685
+ # @!attribute [rw] first_name
2686
+ # The first name of the user.
2687
+ # @return [String]
2688
+ #
2689
+ # @!attribute [rw] last_name
2690
+ # The last name of the user.
2691
+ # @return [String]
2692
+ #
2693
+ # @!attribute [rw] email_address
2694
+ # The email address of the user. The email address serves as a uniquer
2695
+ # identifier for each user and cannot be changed after it's created.
2696
+ # @return [String]
2697
+ #
2698
+ # @!attribute [rw] type
2699
+ # Indicates the type of user.
2700
+ #
2701
+ # * `SUPER_USER` – A user with permission to all the functionality and
2702
+ # data in FinSpace.
2703
+ #
2704
+ # * `APP_USER` – A user with specific permissions in FinSpace. The
2705
+ # users are assigned permissions by adding them to a permissions
2706
+ # group.
2707
+ # @return [String]
2708
+ #
2709
+ # @!attribute [rw] api_access
2710
+ # Indicates whether the user can use the
2711
+ # `GetProgrammaticAccessCredentials` API to obtain credentials that
2712
+ # can then be used to access other FinSpace Data API operations.
2713
+ #
2714
+ # * `ENABLED` – The user has permissions to use the APIs.
2715
+ #
2716
+ # * `DISABLED` – The user does not have permissions to use any APIs.
2717
+ # @return [String]
2718
+ #
2719
+ # @!attribute [rw] api_access_principal_arn
2720
+ # The ARN identifier of an AWS user or role that is allowed to call
2721
+ # the `GetProgrammaticAccessCredentials` API to obtain a credentials
2722
+ # token for a specific FinSpace user. This must be an IAM role within
2723
+ # your FinSpace account.
2724
+ # @return [String]
2725
+ #
2726
+ # @!attribute [rw] create_time
2727
+ # The timestamp at which the user account was created in FinSpace. The
2728
+ # value is determined as epoch time in milliseconds.
2729
+ # @return [Integer]
2730
+ #
2731
+ # @!attribute [rw] last_enabled_time
2732
+ # Describes the last time the user account was enabled. The value is
2733
+ # determined as epoch time in milliseconds.
2734
+ # @return [Integer]
2735
+ #
2736
+ # @!attribute [rw] last_disabled_time
2737
+ # Describes the last time the user account was disabled. The value is
2738
+ # determined as epoch time in milliseconds.
2739
+ # @return [Integer]
2740
+ #
2741
+ # @!attribute [rw] last_modified_time
2742
+ # Describes the last time the user account was updated. The value is
2743
+ # determined as epoch time in milliseconds.
2744
+ # @return [Integer]
2745
+ #
2746
+ # @!attribute [rw] last_login_time
2747
+ # Describes the last time that the user logged into their account. The
2748
+ # value is determined as epoch time in milliseconds.
2749
+ # @return [Integer]
2750
+ #
2751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/User AWS API Documentation
2752
+ #
2753
+ class User < Struct.new(
2754
+ :user_id,
2755
+ :status,
2756
+ :first_name,
2757
+ :last_name,
2758
+ :email_address,
2759
+ :type,
2760
+ :api_access,
2761
+ :api_access_principal_arn,
2762
+ :create_time,
2763
+ :last_enabled_time,
2764
+ :last_disabled_time,
2765
+ :last_modified_time,
2766
+ :last_login_time)
2767
+ SENSITIVE = [:first_name, :last_name, :email_address]
2768
+ include Aws::Structure
2769
+ end
2770
+
1902
2771
  # The input fails to satisfy the constraints specified by an AWS
1903
2772
  # service.
1904
2773
  #
1905
2774
  # @!attribute [rw] message
1906
2775
  # @return [String]
1907
2776
  #
2777
+ # @!attribute [rw] reason
2778
+ # @return [String]
2779
+ #
1908
2780
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ValidationException AWS API Documentation
1909
2781
  #
1910
2782
  class ValidationException < Struct.new(
1911
- :message)
2783
+ :message,
2784
+ :reason)
1912
2785
  SENSITIVE = []
1913
2786
  include Aws::Structure
1914
2787
  end