@aws-sdk/client-finspace-data 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +286 -0
- package/package.json +5 -5
|
@@ -46,14 +46,17 @@ export type ApplicationPermission = (typeof ApplicationPermission)[keyof typeof
|
|
|
46
46
|
*/
|
|
47
47
|
export interface AssociateUserToPermissionGroupRequest {
|
|
48
48
|
/**
|
|
49
|
+
* @public
|
|
49
50
|
* <p>The unique identifier for the permission group.</p>
|
|
50
51
|
*/
|
|
51
52
|
permissionGroupId: string | undefined;
|
|
52
53
|
/**
|
|
54
|
+
* @public
|
|
53
55
|
* <p>The unique identifier for the user.</p>
|
|
54
56
|
*/
|
|
55
57
|
userId: string | undefined;
|
|
56
58
|
/**
|
|
59
|
+
* @public
|
|
57
60
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
58
61
|
*/
|
|
59
62
|
clientToken?: string;
|
|
@@ -63,6 +66,7 @@ export interface AssociateUserToPermissionGroupRequest {
|
|
|
63
66
|
*/
|
|
64
67
|
export interface AssociateUserToPermissionGroupResponse {
|
|
65
68
|
/**
|
|
69
|
+
* @public
|
|
66
70
|
* <p>The returned status code of the response.</p>
|
|
67
71
|
*/
|
|
68
72
|
statusCode?: number;
|
|
@@ -137,18 +141,22 @@ export declare class ValidationException extends __BaseException {
|
|
|
137
141
|
*/
|
|
138
142
|
export interface AwsCredentials {
|
|
139
143
|
/**
|
|
144
|
+
* @public
|
|
140
145
|
* <p> The unique identifier for the security credentials.</p>
|
|
141
146
|
*/
|
|
142
147
|
accessKeyId?: string;
|
|
143
148
|
/**
|
|
149
|
+
* @public
|
|
144
150
|
* <p> The secret access key that can be used to sign requests.</p>
|
|
145
151
|
*/
|
|
146
152
|
secretAccessKey?: string;
|
|
147
153
|
/**
|
|
154
|
+
* @public
|
|
148
155
|
* <p> The token that users must pass to use the credentials.</p>
|
|
149
156
|
*/
|
|
150
157
|
sessionToken?: string;
|
|
151
158
|
/**
|
|
159
|
+
* @public
|
|
152
160
|
* <p> The Epoch time when the current credentials expire.</p>
|
|
153
161
|
*/
|
|
154
162
|
expiration?: number;
|
|
@@ -172,15 +180,18 @@ export type ChangeType = (typeof ChangeType)[keyof typeof ChangeType];
|
|
|
172
180
|
*/
|
|
173
181
|
export interface CreateChangesetRequest {
|
|
174
182
|
/**
|
|
183
|
+
* @public
|
|
175
184
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
176
185
|
*/
|
|
177
186
|
clientToken?: string;
|
|
178
187
|
/**
|
|
188
|
+
* @public
|
|
179
189
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset will be created.
|
|
180
190
|
* </p>
|
|
181
191
|
*/
|
|
182
192
|
datasetId: string | undefined;
|
|
183
193
|
/**
|
|
194
|
+
* @public
|
|
184
195
|
* <p>The option to indicate how a Changeset will be applied to a Dataset.</p>
|
|
185
196
|
* <ul>
|
|
186
197
|
* <li>
|
|
@@ -201,6 +212,7 @@ export interface CreateChangesetRequest {
|
|
|
201
212
|
*/
|
|
202
213
|
changeType: ChangeType | string | undefined;
|
|
203
214
|
/**
|
|
215
|
+
* @public
|
|
204
216
|
* <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
|
|
205
217
|
* <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
|
|
206
218
|
* <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
|
|
@@ -217,6 +229,7 @@ export interface CreateChangesetRequest {
|
|
|
217
229
|
*/
|
|
218
230
|
sourceParams: Record<string, string> | undefined;
|
|
219
231
|
/**
|
|
232
|
+
* @public
|
|
220
233
|
* <p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>).
|
|
221
234
|
* </p>
|
|
222
235
|
* <p>
|
|
@@ -272,10 +285,12 @@ export interface CreateChangesetRequest {
|
|
|
272
285
|
*/
|
|
273
286
|
export interface CreateChangesetResponse {
|
|
274
287
|
/**
|
|
288
|
+
* @public
|
|
275
289
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
|
|
276
290
|
*/
|
|
277
291
|
datasetId?: string;
|
|
278
292
|
/**
|
|
293
|
+
* @public
|
|
279
294
|
* <p>The unique identifier of the Changeset that is created.</p>
|
|
280
295
|
*/
|
|
281
296
|
changesetId?: string;
|
|
@@ -310,14 +325,17 @@ export type DatasetKind = (typeof DatasetKind)[keyof typeof DatasetKind];
|
|
|
310
325
|
*/
|
|
311
326
|
export interface DatasetOwnerInfo {
|
|
312
327
|
/**
|
|
328
|
+
* @public
|
|
313
329
|
* <p>The name of the Dataset owner.</p>
|
|
314
330
|
*/
|
|
315
331
|
name?: string;
|
|
316
332
|
/**
|
|
333
|
+
* @public
|
|
317
334
|
* <p>Phone number for the Dataset owner.</p>
|
|
318
335
|
*/
|
|
319
336
|
phoneNumber?: string;
|
|
320
337
|
/**
|
|
338
|
+
* @public
|
|
321
339
|
* <p>Email address for the Dataset owner.</p>
|
|
322
340
|
*/
|
|
323
341
|
email?: string;
|
|
@@ -364,6 +382,7 @@ export interface DatasetOwnerInfo {
|
|
|
364
382
|
*/
|
|
365
383
|
export interface ResourcePermission {
|
|
366
384
|
/**
|
|
385
|
+
* @public
|
|
367
386
|
* <p>Permission for a resource.</p>
|
|
368
387
|
*/
|
|
369
388
|
permission?: string;
|
|
@@ -388,10 +407,12 @@ export interface ResourcePermission {
|
|
|
388
407
|
*/
|
|
389
408
|
export interface PermissionGroupParams {
|
|
390
409
|
/**
|
|
410
|
+
* @public
|
|
391
411
|
* <p>The unique identifier for the <code>PermissionGroup</code>.</p>
|
|
392
412
|
*/
|
|
393
413
|
permissionGroupId?: string;
|
|
394
414
|
/**
|
|
415
|
+
* @public
|
|
395
416
|
* <p>List of resource permissions.</p>
|
|
396
417
|
*/
|
|
397
418
|
datasetPermissions?: ResourcePermission[];
|
|
@@ -424,6 +445,7 @@ export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType
|
|
|
424
445
|
*/
|
|
425
446
|
export interface ColumnDefinition {
|
|
426
447
|
/**
|
|
448
|
+
* @public
|
|
427
449
|
* <p>Data type of a column.</p>
|
|
428
450
|
* <ul>
|
|
429
451
|
* <li>
|
|
@@ -456,10 +478,12 @@ export interface ColumnDefinition {
|
|
|
456
478
|
*/
|
|
457
479
|
dataType?: ColumnDataType | string;
|
|
458
480
|
/**
|
|
481
|
+
* @public
|
|
459
482
|
* <p>The name of a column.</p>
|
|
460
483
|
*/
|
|
461
484
|
columnName?: string;
|
|
462
485
|
/**
|
|
486
|
+
* @public
|
|
463
487
|
* <p>Description for a column.</p>
|
|
464
488
|
*/
|
|
465
489
|
columnDescription?: string;
|
|
@@ -470,10 +494,12 @@ export interface ColumnDefinition {
|
|
|
470
494
|
*/
|
|
471
495
|
export interface SchemaDefinition {
|
|
472
496
|
/**
|
|
497
|
+
* @public
|
|
473
498
|
* <p>List of column definitions.</p>
|
|
474
499
|
*/
|
|
475
500
|
columns?: ColumnDefinition[];
|
|
476
501
|
/**
|
|
502
|
+
* @public
|
|
477
503
|
* <p>List of column names used for primary key.</p>
|
|
478
504
|
*/
|
|
479
505
|
primaryKeyColumns?: string[];
|
|
@@ -484,6 +510,7 @@ export interface SchemaDefinition {
|
|
|
484
510
|
*/
|
|
485
511
|
export interface SchemaUnion {
|
|
486
512
|
/**
|
|
513
|
+
* @public
|
|
487
514
|
* <p>The configuration for a schema on a tabular Dataset.</p>
|
|
488
515
|
*/
|
|
489
516
|
tabularSchemaConfig?: SchemaDefinition;
|
|
@@ -494,14 +521,17 @@ export interface SchemaUnion {
|
|
|
494
521
|
*/
|
|
495
522
|
export interface CreateDatasetRequest {
|
|
496
523
|
/**
|
|
524
|
+
* @public
|
|
497
525
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
498
526
|
*/
|
|
499
527
|
clientToken?: string;
|
|
500
528
|
/**
|
|
529
|
+
* @public
|
|
501
530
|
* <p>Display title for a FinSpace Dataset.</p>
|
|
502
531
|
*/
|
|
503
532
|
datasetTitle: string | undefined;
|
|
504
533
|
/**
|
|
534
|
+
* @public
|
|
505
535
|
* <p>The format in which Dataset data is structured.</p>
|
|
506
536
|
* <ul>
|
|
507
537
|
* <li>
|
|
@@ -516,22 +546,27 @@ export interface CreateDatasetRequest {
|
|
|
516
546
|
*/
|
|
517
547
|
kind: DatasetKind | string | undefined;
|
|
518
548
|
/**
|
|
549
|
+
* @public
|
|
519
550
|
* <p>Description of a Dataset.</p>
|
|
520
551
|
*/
|
|
521
552
|
datasetDescription?: string;
|
|
522
553
|
/**
|
|
554
|
+
* @public
|
|
523
555
|
* <p>Contact information for a Dataset owner.</p>
|
|
524
556
|
*/
|
|
525
557
|
ownerInfo?: DatasetOwnerInfo;
|
|
526
558
|
/**
|
|
559
|
+
* @public
|
|
527
560
|
* <p>Permission group parameters for Dataset permissions.</p>
|
|
528
561
|
*/
|
|
529
562
|
permissionGroupParams: PermissionGroupParams | undefined;
|
|
530
563
|
/**
|
|
564
|
+
* @public
|
|
531
565
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
532
566
|
*/
|
|
533
567
|
alias?: string;
|
|
534
568
|
/**
|
|
569
|
+
* @public
|
|
535
570
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
536
571
|
*/
|
|
537
572
|
schemaDefinition?: SchemaUnion;
|
|
@@ -542,6 +577,7 @@ export interface CreateDatasetRequest {
|
|
|
542
577
|
*/
|
|
543
578
|
export interface CreateDatasetResponse {
|
|
544
579
|
/**
|
|
580
|
+
* @public
|
|
545
581
|
* <p>The unique identifier for the created Dataset.</p>
|
|
546
582
|
*/
|
|
547
583
|
datasetId?: string;
|
|
@@ -564,6 +600,7 @@ export type ExportFileFormat = (typeof ExportFileFormat)[keyof typeof ExportFile
|
|
|
564
600
|
*/
|
|
565
601
|
export interface DataViewDestinationTypeParams {
|
|
566
602
|
/**
|
|
603
|
+
* @public
|
|
567
604
|
* <p>Destination type for a Dataview.</p>
|
|
568
605
|
* <ul>
|
|
569
606
|
* <li>
|
|
@@ -578,6 +615,7 @@ export interface DataViewDestinationTypeParams {
|
|
|
578
615
|
*/
|
|
579
616
|
destinationType: string | undefined;
|
|
580
617
|
/**
|
|
618
|
+
* @public
|
|
581
619
|
* <p>Dataview export file format.</p>
|
|
582
620
|
* <ul>
|
|
583
621
|
* <li>
|
|
@@ -592,6 +630,7 @@ export interface DataViewDestinationTypeParams {
|
|
|
592
630
|
*/
|
|
593
631
|
s3DestinationExportFileFormat?: ExportFileFormat | string;
|
|
594
632
|
/**
|
|
633
|
+
* @public
|
|
595
634
|
* <p>Format Options for S3 Destination type.</p>
|
|
596
635
|
* <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code>
|
|
597
636
|
* </p>
|
|
@@ -612,30 +651,37 @@ export interface DataViewDestinationTypeParams {
|
|
|
612
651
|
*/
|
|
613
652
|
export interface CreateDataViewRequest {
|
|
614
653
|
/**
|
|
654
|
+
* @public
|
|
615
655
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
616
656
|
*/
|
|
617
657
|
clientToken?: string;
|
|
618
658
|
/**
|
|
659
|
+
* @public
|
|
619
660
|
* <p>The unique Dataset identifier that is used to create a Dataview.</p>
|
|
620
661
|
*/
|
|
621
662
|
datasetId: string | undefined;
|
|
622
663
|
/**
|
|
664
|
+
* @public
|
|
623
665
|
* <p>Flag to indicate Dataview should be updated automatically.</p>
|
|
624
666
|
*/
|
|
625
667
|
autoUpdate?: boolean;
|
|
626
668
|
/**
|
|
669
|
+
* @public
|
|
627
670
|
* <p>Columns to be used for sorting the data.</p>
|
|
628
671
|
*/
|
|
629
672
|
sortColumns?: string[];
|
|
630
673
|
/**
|
|
674
|
+
* @public
|
|
631
675
|
* <p>Ordered set of column names used to partition data.</p>
|
|
632
676
|
*/
|
|
633
677
|
partitionColumns?: string[];
|
|
634
678
|
/**
|
|
679
|
+
* @public
|
|
635
680
|
* <p>Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
636
681
|
*/
|
|
637
682
|
asOfTimestamp?: number;
|
|
638
683
|
/**
|
|
684
|
+
* @public
|
|
639
685
|
* <p>Options that define the destination type for the Dataview.</p>
|
|
640
686
|
*/
|
|
641
687
|
destinationTypeParams: DataViewDestinationTypeParams | undefined;
|
|
@@ -646,10 +692,12 @@ export interface CreateDataViewRequest {
|
|
|
646
692
|
*/
|
|
647
693
|
export interface CreateDataViewResponse {
|
|
648
694
|
/**
|
|
695
|
+
* @public
|
|
649
696
|
* <p>The unique identifier of the Dataset used for the Dataview.</p>
|
|
650
697
|
*/
|
|
651
698
|
datasetId?: string;
|
|
652
699
|
/**
|
|
700
|
+
* @public
|
|
653
701
|
* <p>The unique identifier for the created Dataview.</p>
|
|
654
702
|
*/
|
|
655
703
|
dataViewId?: string;
|
|
@@ -659,14 +707,17 @@ export interface CreateDataViewResponse {
|
|
|
659
707
|
*/
|
|
660
708
|
export interface CreatePermissionGroupRequest {
|
|
661
709
|
/**
|
|
710
|
+
* @public
|
|
662
711
|
* <p>The name of the permission group.</p>
|
|
663
712
|
*/
|
|
664
713
|
name: string | undefined;
|
|
665
714
|
/**
|
|
715
|
+
* @public
|
|
666
716
|
* <p>A brief description for the permission group.</p>
|
|
667
717
|
*/
|
|
668
718
|
description?: string;
|
|
669
719
|
/**
|
|
720
|
+
* @public
|
|
670
721
|
* <p>The option to indicate FinSpace application permissions that are granted to a specific group.</p>
|
|
671
722
|
* <important>
|
|
672
723
|
* <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p>
|
|
@@ -704,6 +755,7 @@ export interface CreatePermissionGroupRequest {
|
|
|
704
755
|
*/
|
|
705
756
|
applicationPermissions: (ApplicationPermission | string)[] | undefined;
|
|
706
757
|
/**
|
|
758
|
+
* @public
|
|
707
759
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
708
760
|
*/
|
|
709
761
|
clientToken?: string;
|
|
@@ -713,6 +765,7 @@ export interface CreatePermissionGroupRequest {
|
|
|
713
765
|
*/
|
|
714
766
|
export interface CreatePermissionGroupResponse {
|
|
715
767
|
/**
|
|
768
|
+
* @public
|
|
716
769
|
* <p>The unique identifier for the permission group.</p>
|
|
717
770
|
*/
|
|
718
771
|
permissionGroupId?: string;
|
|
@@ -734,10 +787,12 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
|
|
|
734
787
|
*/
|
|
735
788
|
export interface CreateUserRequest {
|
|
736
789
|
/**
|
|
790
|
+
* @public
|
|
737
791
|
* <p>The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>
|
|
738
792
|
*/
|
|
739
793
|
emailAddress: string | undefined;
|
|
740
794
|
/**
|
|
795
|
+
* @public
|
|
741
796
|
* <p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p>
|
|
742
797
|
* <ul>
|
|
743
798
|
* <li>
|
|
@@ -752,14 +807,17 @@ export interface CreateUserRequest {
|
|
|
752
807
|
*/
|
|
753
808
|
type: UserType | string | undefined;
|
|
754
809
|
/**
|
|
810
|
+
* @public
|
|
755
811
|
* <p>The first name of the user that you want to register.</p>
|
|
756
812
|
*/
|
|
757
813
|
firstName?: string;
|
|
758
814
|
/**
|
|
815
|
+
* @public
|
|
759
816
|
* <p>The last name of the user that you want to register.</p>
|
|
760
817
|
*/
|
|
761
818
|
lastName?: string;
|
|
762
819
|
/**
|
|
820
|
+
* @public
|
|
763
821
|
* <p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p>
|
|
764
822
|
* <ul>
|
|
765
823
|
* <li>
|
|
@@ -774,10 +832,12 @@ export interface CreateUserRequest {
|
|
|
774
832
|
*/
|
|
775
833
|
ApiAccess?: ApiAccess | string;
|
|
776
834
|
/**
|
|
835
|
+
* @public
|
|
777
836
|
* <p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>
|
|
778
837
|
*/
|
|
779
838
|
apiAccessPrincipalArn?: string;
|
|
780
839
|
/**
|
|
840
|
+
* @public
|
|
781
841
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
782
842
|
*/
|
|
783
843
|
clientToken?: string;
|
|
@@ -787,6 +847,7 @@ export interface CreateUserRequest {
|
|
|
787
847
|
*/
|
|
788
848
|
export interface CreateUserResponse {
|
|
789
849
|
/**
|
|
850
|
+
* @public
|
|
790
851
|
* <p>The unique identifier for the user.</p>
|
|
791
852
|
*/
|
|
792
853
|
userId?: string;
|
|
@@ -797,10 +858,12 @@ export interface CreateUserResponse {
|
|
|
797
858
|
*/
|
|
798
859
|
export interface DeleteDatasetRequest {
|
|
799
860
|
/**
|
|
861
|
+
* @public
|
|
800
862
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
801
863
|
*/
|
|
802
864
|
clientToken?: string;
|
|
803
865
|
/**
|
|
866
|
+
* @public
|
|
804
867
|
* <p>The unique identifier of the Dataset to be deleted.</p>
|
|
805
868
|
*/
|
|
806
869
|
datasetId: string | undefined;
|
|
@@ -811,6 +874,7 @@ export interface DeleteDatasetRequest {
|
|
|
811
874
|
*/
|
|
812
875
|
export interface DeleteDatasetResponse {
|
|
813
876
|
/**
|
|
877
|
+
* @public
|
|
814
878
|
* <p>The unique identifier for the deleted Dataset.</p>
|
|
815
879
|
*/
|
|
816
880
|
datasetId?: string;
|
|
@@ -820,10 +884,12 @@ export interface DeleteDatasetResponse {
|
|
|
820
884
|
*/
|
|
821
885
|
export interface DeletePermissionGroupRequest {
|
|
822
886
|
/**
|
|
887
|
+
* @public
|
|
823
888
|
* <p>The unique identifier for the permission group that you want to delete.</p>
|
|
824
889
|
*/
|
|
825
890
|
permissionGroupId: string | undefined;
|
|
826
891
|
/**
|
|
892
|
+
* @public
|
|
827
893
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
828
894
|
*/
|
|
829
895
|
clientToken?: string;
|
|
@@ -833,6 +899,7 @@ export interface DeletePermissionGroupRequest {
|
|
|
833
899
|
*/
|
|
834
900
|
export interface DeletePermissionGroupResponse {
|
|
835
901
|
/**
|
|
902
|
+
* @public
|
|
836
903
|
* <p>The unique identifier for the deleted permission group.</p>
|
|
837
904
|
*/
|
|
838
905
|
permissionGroupId?: string;
|
|
@@ -842,10 +909,12 @@ export interface DeletePermissionGroupResponse {
|
|
|
842
909
|
*/
|
|
843
910
|
export interface DisableUserRequest {
|
|
844
911
|
/**
|
|
912
|
+
* @public
|
|
845
913
|
* <p>The unique identifier for the user account that you want to disable.</p>
|
|
846
914
|
*/
|
|
847
915
|
userId: string | undefined;
|
|
848
916
|
/**
|
|
917
|
+
* @public
|
|
849
918
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
850
919
|
*/
|
|
851
920
|
clientToken?: string;
|
|
@@ -855,6 +924,7 @@ export interface DisableUserRequest {
|
|
|
855
924
|
*/
|
|
856
925
|
export interface DisableUserResponse {
|
|
857
926
|
/**
|
|
927
|
+
* @public
|
|
858
928
|
* <p>The unique identifier for the disabled user account.</p>
|
|
859
929
|
*/
|
|
860
930
|
userId?: string;
|
|
@@ -864,14 +934,17 @@ export interface DisableUserResponse {
|
|
|
864
934
|
*/
|
|
865
935
|
export interface DisassociateUserFromPermissionGroupRequest {
|
|
866
936
|
/**
|
|
937
|
+
* @public
|
|
867
938
|
* <p>The unique identifier for the permission group.</p>
|
|
868
939
|
*/
|
|
869
940
|
permissionGroupId: string | undefined;
|
|
870
941
|
/**
|
|
942
|
+
* @public
|
|
871
943
|
* <p>The unique identifier for the user.</p>
|
|
872
944
|
*/
|
|
873
945
|
userId: string | undefined;
|
|
874
946
|
/**
|
|
947
|
+
* @public
|
|
875
948
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
876
949
|
*/
|
|
877
950
|
clientToken?: string;
|
|
@@ -881,6 +954,7 @@ export interface DisassociateUserFromPermissionGroupRequest {
|
|
|
881
954
|
*/
|
|
882
955
|
export interface DisassociateUserFromPermissionGroupResponse {
|
|
883
956
|
/**
|
|
957
|
+
* @public
|
|
884
958
|
* <p>The returned status code of the response.</p>
|
|
885
959
|
*/
|
|
886
960
|
statusCode?: number;
|
|
@@ -890,10 +964,12 @@ export interface DisassociateUserFromPermissionGroupResponse {
|
|
|
890
964
|
*/
|
|
891
965
|
export interface EnableUserRequest {
|
|
892
966
|
/**
|
|
967
|
+
* @public
|
|
893
968
|
* <p>The unique identifier for the user account that you want to enable.</p>
|
|
894
969
|
*/
|
|
895
970
|
userId: string | undefined;
|
|
896
971
|
/**
|
|
972
|
+
* @public
|
|
897
973
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
898
974
|
*/
|
|
899
975
|
clientToken?: string;
|
|
@@ -903,6 +979,7 @@ export interface EnableUserRequest {
|
|
|
903
979
|
*/
|
|
904
980
|
export interface EnableUserResponse {
|
|
905
981
|
/**
|
|
982
|
+
* @public
|
|
906
983
|
* <p>The unique identifier for the enabled user account.</p>
|
|
907
984
|
*/
|
|
908
985
|
userId?: string;
|
|
@@ -913,10 +990,12 @@ export interface EnableUserResponse {
|
|
|
913
990
|
*/
|
|
914
991
|
export interface GetChangesetRequest {
|
|
915
992
|
/**
|
|
993
|
+
* @public
|
|
916
994
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
|
|
917
995
|
*/
|
|
918
996
|
datasetId: string | undefined;
|
|
919
997
|
/**
|
|
998
|
+
* @public
|
|
920
999
|
* <p>The unique identifier of the Changeset for which to get data.</p>
|
|
921
1000
|
*/
|
|
922
1001
|
changesetId: string | undefined;
|
|
@@ -945,10 +1024,12 @@ export type ErrorCategory = (typeof ErrorCategory)[keyof typeof ErrorCategory];
|
|
|
945
1024
|
*/
|
|
946
1025
|
export interface ChangesetErrorInfo {
|
|
947
1026
|
/**
|
|
1027
|
+
* @public
|
|
948
1028
|
* <p>The text of the error message.</p>
|
|
949
1029
|
*/
|
|
950
1030
|
errorMessage?: string;
|
|
951
1031
|
/**
|
|
1032
|
+
* @public
|
|
952
1033
|
* <p>The category of the error.</p>
|
|
953
1034
|
* <ul>
|
|
954
1035
|
* <li>
|
|
@@ -1013,18 +1094,22 @@ export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionSta
|
|
|
1013
1094
|
*/
|
|
1014
1095
|
export interface GetChangesetResponse {
|
|
1015
1096
|
/**
|
|
1097
|
+
* @public
|
|
1016
1098
|
* <p>The unique identifier for a Changeset.</p>
|
|
1017
1099
|
*/
|
|
1018
1100
|
changesetId?: string;
|
|
1019
1101
|
/**
|
|
1102
|
+
* @public
|
|
1020
1103
|
* <p>The ARN identifier of the Changeset.</p>
|
|
1021
1104
|
*/
|
|
1022
1105
|
changesetArn?: string;
|
|
1023
1106
|
/**
|
|
1107
|
+
* @public
|
|
1024
1108
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
|
|
1025
1109
|
*/
|
|
1026
1110
|
datasetId?: string;
|
|
1027
1111
|
/**
|
|
1112
|
+
* @public
|
|
1028
1113
|
* <p>Type that indicates how a Changeset is applied to a Dataset.</p>
|
|
1029
1114
|
* <ul>
|
|
1030
1115
|
* <li>
|
|
@@ -1043,38 +1128,47 @@ export interface GetChangesetResponse {
|
|
|
1043
1128
|
*/
|
|
1044
1129
|
changeType?: ChangeType | string;
|
|
1045
1130
|
/**
|
|
1131
|
+
* @public
|
|
1046
1132
|
* <p>Options that define the location of the data being ingested.</p>
|
|
1047
1133
|
*/
|
|
1048
1134
|
sourceParams?: Record<string, string>;
|
|
1049
1135
|
/**
|
|
1136
|
+
* @public
|
|
1050
1137
|
* <p>Structure of the source file(s).</p>
|
|
1051
1138
|
*/
|
|
1052
1139
|
formatParams?: Record<string, string>;
|
|
1053
1140
|
/**
|
|
1141
|
+
* @public
|
|
1054
1142
|
* <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1055
1143
|
*/
|
|
1056
1144
|
createTime?: number;
|
|
1057
1145
|
/**
|
|
1146
|
+
* @public
|
|
1058
1147
|
* <p>The status of Changeset creation operation.</p>
|
|
1059
1148
|
*/
|
|
1060
1149
|
status?: IngestionStatus | string;
|
|
1061
1150
|
/**
|
|
1151
|
+
* @public
|
|
1062
1152
|
* <p>The structure with error messages.</p>
|
|
1063
1153
|
*/
|
|
1064
1154
|
errorInfo?: ChangesetErrorInfo;
|
|
1065
1155
|
/**
|
|
1156
|
+
* @public
|
|
1066
1157
|
* <p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1067
1158
|
*/
|
|
1068
1159
|
activeUntilTimestamp?: number;
|
|
1069
1160
|
/**
|
|
1161
|
+
* @public
|
|
1070
1162
|
* <p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1071
1163
|
*/
|
|
1072
1164
|
activeFromTimestamp?: number;
|
|
1073
1165
|
/**
|
|
1166
|
+
* @public
|
|
1074
1167
|
* <p>The unique identifier of the Changeset that is being updated.</p>
|
|
1075
1168
|
*/
|
|
1076
1169
|
updatesChangesetId?: string;
|
|
1077
1170
|
/**
|
|
1171
|
+
* @public
|
|
1078
1172
|
* <p>The unique identifier of the updated Changeset.</p>
|
|
1079
1173
|
*/
|
|
1080
1174
|
updatedByChangesetId?: string;
|
|
@@ -1085,6 +1179,7 @@ export interface GetChangesetResponse {
|
|
|
1085
1179
|
*/
|
|
1086
1180
|
export interface GetDatasetRequest {
|
|
1087
1181
|
/**
|
|
1182
|
+
* @public
|
|
1088
1183
|
* <p>The unique identifier for a Dataset.</p>
|
|
1089
1184
|
*/
|
|
1090
1185
|
datasetId: string | undefined;
|
|
@@ -1109,18 +1204,22 @@ export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
|
|
|
1109
1204
|
*/
|
|
1110
1205
|
export interface GetDatasetResponse {
|
|
1111
1206
|
/**
|
|
1207
|
+
* @public
|
|
1112
1208
|
* <p>The unique identifier for a Dataset.</p>
|
|
1113
1209
|
*/
|
|
1114
1210
|
datasetId?: string;
|
|
1115
1211
|
/**
|
|
1212
|
+
* @public
|
|
1116
1213
|
* <p>The ARN identifier of the Dataset.</p>
|
|
1117
1214
|
*/
|
|
1118
1215
|
datasetArn?: string;
|
|
1119
1216
|
/**
|
|
1217
|
+
* @public
|
|
1120
1218
|
* <p>Display title for a Dataset.</p>
|
|
1121
1219
|
*/
|
|
1122
1220
|
datasetTitle?: string;
|
|
1123
1221
|
/**
|
|
1222
|
+
* @public
|
|
1124
1223
|
* <p>The format in which Dataset data is structured.</p>
|
|
1125
1224
|
* <ul>
|
|
1126
1225
|
* <li>
|
|
@@ -1135,26 +1234,32 @@ export interface GetDatasetResponse {
|
|
|
1135
1234
|
*/
|
|
1136
1235
|
kind?: DatasetKind | string;
|
|
1137
1236
|
/**
|
|
1237
|
+
* @public
|
|
1138
1238
|
* <p>A description of the Dataset.</p>
|
|
1139
1239
|
*/
|
|
1140
1240
|
datasetDescription?: string;
|
|
1141
1241
|
/**
|
|
1242
|
+
* @public
|
|
1142
1243
|
* <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1143
1244
|
*/
|
|
1144
1245
|
createTime?: number;
|
|
1145
1246
|
/**
|
|
1247
|
+
* @public
|
|
1146
1248
|
* <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1147
1249
|
*/
|
|
1148
1250
|
lastModifiedTime?: number;
|
|
1149
1251
|
/**
|
|
1252
|
+
* @public
|
|
1150
1253
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
1151
1254
|
*/
|
|
1152
1255
|
schemaDefinition?: SchemaUnion;
|
|
1153
1256
|
/**
|
|
1257
|
+
* @public
|
|
1154
1258
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
1155
1259
|
*/
|
|
1156
1260
|
alias?: string;
|
|
1157
1261
|
/**
|
|
1262
|
+
* @public
|
|
1158
1263
|
* <p>Status of the Dataset creation.</p>
|
|
1159
1264
|
* <ul>
|
|
1160
1265
|
* <li>
|
|
@@ -1183,10 +1288,12 @@ export interface GetDatasetResponse {
|
|
|
1183
1288
|
*/
|
|
1184
1289
|
export interface GetDataViewRequest {
|
|
1185
1290
|
/**
|
|
1291
|
+
* @public
|
|
1186
1292
|
* <p>The unique identifier for the Dataview.</p>
|
|
1187
1293
|
*/
|
|
1188
1294
|
dataViewId: string | undefined;
|
|
1189
1295
|
/**
|
|
1296
|
+
* @public
|
|
1190
1297
|
* <p>The unique identifier for the Dataset used in the Dataview.</p>
|
|
1191
1298
|
*/
|
|
1192
1299
|
datasetId: string | undefined;
|
|
@@ -1197,10 +1304,12 @@ export interface GetDataViewRequest {
|
|
|
1197
1304
|
*/
|
|
1198
1305
|
export interface DataViewErrorInfo {
|
|
1199
1306
|
/**
|
|
1307
|
+
* @public
|
|
1200
1308
|
* <p>The text of the error message.</p>
|
|
1201
1309
|
*/
|
|
1202
1310
|
errorMessage?: string;
|
|
1203
1311
|
/**
|
|
1312
|
+
* @public
|
|
1204
1313
|
* <p>The category of the error.</p>
|
|
1205
1314
|
* <ul>
|
|
1206
1315
|
* <li>
|
|
@@ -1268,50 +1377,62 @@ export type DataViewStatus = (typeof DataViewStatus)[keyof typeof DataViewStatus
|
|
|
1268
1377
|
*/
|
|
1269
1378
|
export interface GetDataViewResponse {
|
|
1270
1379
|
/**
|
|
1380
|
+
* @public
|
|
1271
1381
|
* <p>Flag to indicate Dataview should be updated automatically.</p>
|
|
1272
1382
|
*/
|
|
1273
1383
|
autoUpdate?: boolean;
|
|
1274
1384
|
/**
|
|
1385
|
+
* @public
|
|
1275
1386
|
* <p>Ordered set of column names used to partition data.</p>
|
|
1276
1387
|
*/
|
|
1277
1388
|
partitionColumns?: string[];
|
|
1278
1389
|
/**
|
|
1390
|
+
* @public
|
|
1279
1391
|
* <p>The unique identifier for the Dataset used in the Dataview.</p>
|
|
1280
1392
|
*/
|
|
1281
1393
|
datasetId?: string;
|
|
1282
1394
|
/**
|
|
1395
|
+
* @public
|
|
1283
1396
|
* <p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1284
1397
|
*/
|
|
1285
1398
|
asOfTimestamp?: number;
|
|
1286
1399
|
/**
|
|
1400
|
+
* @public
|
|
1287
1401
|
* <p>Information about an error that occurred for the Dataview.</p>
|
|
1288
1402
|
*/
|
|
1289
1403
|
errorInfo?: DataViewErrorInfo;
|
|
1290
1404
|
/**
|
|
1405
|
+
* @public
|
|
1291
1406
|
* <p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1292
1407
|
*/
|
|
1293
1408
|
lastModifiedTime?: number;
|
|
1294
1409
|
/**
|
|
1410
|
+
* @public
|
|
1295
1411
|
* <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1296
1412
|
*/
|
|
1297
1413
|
createTime?: number;
|
|
1298
1414
|
/**
|
|
1415
|
+
* @public
|
|
1299
1416
|
* <p>Columns to be used for sorting the data.</p>
|
|
1300
1417
|
*/
|
|
1301
1418
|
sortColumns?: string[];
|
|
1302
1419
|
/**
|
|
1420
|
+
* @public
|
|
1303
1421
|
* <p>The unique identifier for the Dataview.</p>
|
|
1304
1422
|
*/
|
|
1305
1423
|
dataViewId?: string;
|
|
1306
1424
|
/**
|
|
1425
|
+
* @public
|
|
1307
1426
|
* <p>The ARN identifier of the Dataview.</p>
|
|
1308
1427
|
*/
|
|
1309
1428
|
dataViewArn?: string;
|
|
1310
1429
|
/**
|
|
1430
|
+
* @public
|
|
1311
1431
|
* <p>Options that define the destination type for the Dataview.</p>
|
|
1312
1432
|
*/
|
|
1313
1433
|
destinationTypeParams?: DataViewDestinationTypeParams;
|
|
1314
1434
|
/**
|
|
1435
|
+
* @public
|
|
1315
1436
|
* <p>The status of a Dataview creation.</p>
|
|
1316
1437
|
* <ul>
|
|
1317
1438
|
* <li>
|
|
@@ -1355,10 +1476,12 @@ export interface GetDataViewResponse {
|
|
|
1355
1476
|
*/
|
|
1356
1477
|
export interface GetExternalDataViewAccessDetailsRequest {
|
|
1357
1478
|
/**
|
|
1479
|
+
* @public
|
|
1358
1480
|
* <p>The unique identifier for the Dataview that you want to access.</p>
|
|
1359
1481
|
*/
|
|
1360
1482
|
dataViewId: string | undefined;
|
|
1361
1483
|
/**
|
|
1484
|
+
* @public
|
|
1362
1485
|
* <p>The unique identifier for the Dataset.</p>
|
|
1363
1486
|
*/
|
|
1364
1487
|
datasetId: string | undefined;
|
|
@@ -1369,10 +1492,12 @@ export interface GetExternalDataViewAccessDetailsRequest {
|
|
|
1369
1492
|
*/
|
|
1370
1493
|
export interface S3Location {
|
|
1371
1494
|
/**
|
|
1495
|
+
* @public
|
|
1372
1496
|
* <p> The name of the S3 bucket.</p>
|
|
1373
1497
|
*/
|
|
1374
1498
|
bucket: string | undefined;
|
|
1375
1499
|
/**
|
|
1500
|
+
* @public
|
|
1376
1501
|
* <p> The path of the folder, within the S3 bucket that contains the Dataset.</p>
|
|
1377
1502
|
*/
|
|
1378
1503
|
key: string | undefined;
|
|
@@ -1382,10 +1507,12 @@ export interface S3Location {
|
|
|
1382
1507
|
*/
|
|
1383
1508
|
export interface GetExternalDataViewAccessDetailsResponse {
|
|
1384
1509
|
/**
|
|
1510
|
+
* @public
|
|
1385
1511
|
* <p>The credentials required to access the external Dataview from the S3 location.</p>
|
|
1386
1512
|
*/
|
|
1387
1513
|
credentials?: AwsCredentials;
|
|
1388
1514
|
/**
|
|
1515
|
+
* @public
|
|
1389
1516
|
* <p>The location where the external Dataview is stored.</p>
|
|
1390
1517
|
*/
|
|
1391
1518
|
s3Location?: S3Location;
|
|
@@ -1395,6 +1522,7 @@ export interface GetExternalDataViewAccessDetailsResponse {
|
|
|
1395
1522
|
*/
|
|
1396
1523
|
export interface GetPermissionGroupRequest {
|
|
1397
1524
|
/**
|
|
1525
|
+
* @public
|
|
1398
1526
|
* <p>The unique identifier for the permission group.</p>
|
|
1399
1527
|
*/
|
|
1400
1528
|
permissionGroupId: string | undefined;
|
|
@@ -1418,18 +1546,22 @@ export type PermissionGroupMembershipStatus = (typeof PermissionGroupMembershipS
|
|
|
1418
1546
|
*/
|
|
1419
1547
|
export interface PermissionGroup {
|
|
1420
1548
|
/**
|
|
1549
|
+
* @public
|
|
1421
1550
|
* <p> The unique identifier for the permission group.</p>
|
|
1422
1551
|
*/
|
|
1423
1552
|
permissionGroupId?: string;
|
|
1424
1553
|
/**
|
|
1554
|
+
* @public
|
|
1425
1555
|
* <p>The name of the permission group.</p>
|
|
1426
1556
|
*/
|
|
1427
1557
|
name?: string;
|
|
1428
1558
|
/**
|
|
1559
|
+
* @public
|
|
1429
1560
|
* <p> A brief description for the permission group.</p>
|
|
1430
1561
|
*/
|
|
1431
1562
|
description?: string;
|
|
1432
1563
|
/**
|
|
1564
|
+
* @public
|
|
1433
1565
|
* <p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
1434
1566
|
* <important>
|
|
1435
1567
|
* <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p>
|
|
@@ -1467,16 +1599,19 @@ export interface PermissionGroup {
|
|
|
1467
1599
|
*/
|
|
1468
1600
|
applicationPermissions?: (ApplicationPermission | string)[];
|
|
1469
1601
|
/**
|
|
1602
|
+
* @public
|
|
1470
1603
|
* <p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
|
|
1471
1604
|
* </p>
|
|
1472
1605
|
*/
|
|
1473
1606
|
createTime?: number;
|
|
1474
1607
|
/**
|
|
1608
|
+
* @public
|
|
1475
1609
|
* <p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
|
|
1476
1610
|
* </p>
|
|
1477
1611
|
*/
|
|
1478
1612
|
lastModifiedTime?: number;
|
|
1479
1613
|
/**
|
|
1614
|
+
* @public
|
|
1480
1615
|
* <p>Indicates the status of the user account within a permission group.</p>
|
|
1481
1616
|
* <ul>
|
|
1482
1617
|
* <li>
|
|
@@ -1500,6 +1635,7 @@ export interface PermissionGroup {
|
|
|
1500
1635
|
*/
|
|
1501
1636
|
export interface GetPermissionGroupResponse {
|
|
1502
1637
|
/**
|
|
1638
|
+
* @public
|
|
1503
1639
|
* <p>The structure for a permission group.</p>
|
|
1504
1640
|
*/
|
|
1505
1641
|
permissionGroup?: PermissionGroup;
|
|
@@ -1510,10 +1646,12 @@ export interface GetPermissionGroupResponse {
|
|
|
1510
1646
|
*/
|
|
1511
1647
|
export interface GetProgrammaticAccessCredentialsRequest {
|
|
1512
1648
|
/**
|
|
1649
|
+
* @public
|
|
1513
1650
|
* <p>The time duration in which the credentials remain valid. </p>
|
|
1514
1651
|
*/
|
|
1515
1652
|
durationInMinutes?: number;
|
|
1516
1653
|
/**
|
|
1654
|
+
* @public
|
|
1517
1655
|
* <p>The FinSpace environment identifier.</p>
|
|
1518
1656
|
*/
|
|
1519
1657
|
environmentId: string | undefined;
|
|
@@ -1524,14 +1662,17 @@ export interface GetProgrammaticAccessCredentialsRequest {
|
|
|
1524
1662
|
*/
|
|
1525
1663
|
export interface Credentials {
|
|
1526
1664
|
/**
|
|
1665
|
+
* @public
|
|
1527
1666
|
* <p>The access key identifier.</p>
|
|
1528
1667
|
*/
|
|
1529
1668
|
accessKeyId?: string;
|
|
1530
1669
|
/**
|
|
1670
|
+
* @public
|
|
1531
1671
|
* <p>The access key.</p>
|
|
1532
1672
|
*/
|
|
1533
1673
|
secretAccessKey?: string;
|
|
1534
1674
|
/**
|
|
1675
|
+
* @public
|
|
1535
1676
|
* <p>The session token.</p>
|
|
1536
1677
|
*/
|
|
1537
1678
|
sessionToken?: string;
|
|
@@ -1542,10 +1683,12 @@ export interface Credentials {
|
|
|
1542
1683
|
*/
|
|
1543
1684
|
export interface GetProgrammaticAccessCredentialsResponse {
|
|
1544
1685
|
/**
|
|
1686
|
+
* @public
|
|
1545
1687
|
* <p>Returns the programmatic credentials.</p>
|
|
1546
1688
|
*/
|
|
1547
1689
|
credentials?: Credentials;
|
|
1548
1690
|
/**
|
|
1691
|
+
* @public
|
|
1549
1692
|
* <p>Returns the duration in which the credentials will remain valid.</p>
|
|
1550
1693
|
*/
|
|
1551
1694
|
durationInMinutes?: number;
|
|
@@ -1555,6 +1698,7 @@ export interface GetProgrammaticAccessCredentialsResponse {
|
|
|
1555
1698
|
*/
|
|
1556
1699
|
export interface GetUserRequest {
|
|
1557
1700
|
/**
|
|
1701
|
+
* @public
|
|
1558
1702
|
* <p>The unique identifier of the user to get data for.</p>
|
|
1559
1703
|
*/
|
|
1560
1704
|
userId: string | undefined;
|
|
@@ -1577,10 +1721,12 @@ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
|
|
|
1577
1721
|
*/
|
|
1578
1722
|
export interface GetUserResponse {
|
|
1579
1723
|
/**
|
|
1724
|
+
* @public
|
|
1580
1725
|
* <p>The unique identifier for the user account that is retrieved.</p>
|
|
1581
1726
|
*/
|
|
1582
1727
|
userId?: string;
|
|
1583
1728
|
/**
|
|
1729
|
+
* @public
|
|
1584
1730
|
* <p>The current status of the user account. </p>
|
|
1585
1731
|
* <ul>
|
|
1586
1732
|
* <li>
|
|
@@ -1599,18 +1745,22 @@ export interface GetUserResponse {
|
|
|
1599
1745
|
*/
|
|
1600
1746
|
status?: UserStatus | string;
|
|
1601
1747
|
/**
|
|
1748
|
+
* @public
|
|
1602
1749
|
* <p>The first name of the user.</p>
|
|
1603
1750
|
*/
|
|
1604
1751
|
firstName?: string;
|
|
1605
1752
|
/**
|
|
1753
|
+
* @public
|
|
1606
1754
|
* <p>The last name of the user.</p>
|
|
1607
1755
|
*/
|
|
1608
1756
|
lastName?: string;
|
|
1609
1757
|
/**
|
|
1758
|
+
* @public
|
|
1610
1759
|
* <p>The email address that is associated with the user.</p>
|
|
1611
1760
|
*/
|
|
1612
1761
|
emailAddress?: string;
|
|
1613
1762
|
/**
|
|
1763
|
+
* @public
|
|
1614
1764
|
* <p>Indicates the type of user. </p>
|
|
1615
1765
|
* <ul>
|
|
1616
1766
|
* <li>
|
|
@@ -1627,6 +1777,7 @@ export interface GetUserResponse {
|
|
|
1627
1777
|
*/
|
|
1628
1778
|
type?: UserType | string;
|
|
1629
1779
|
/**
|
|
1780
|
+
* @public
|
|
1630
1781
|
* <p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations. </p>
|
|
1631
1782
|
* <ul>
|
|
1632
1783
|
* <li>
|
|
@@ -1641,26 +1792,32 @@ export interface GetUserResponse {
|
|
|
1641
1792
|
*/
|
|
1642
1793
|
apiAccess?: ApiAccess | string;
|
|
1643
1794
|
/**
|
|
1795
|
+
* @public
|
|
1644
1796
|
* <p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>
|
|
1645
1797
|
*/
|
|
1646
1798
|
apiAccessPrincipalArn?: string;
|
|
1647
1799
|
/**
|
|
1800
|
+
* @public
|
|
1648
1801
|
* <p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
1649
1802
|
*/
|
|
1650
1803
|
createTime?: number;
|
|
1651
1804
|
/**
|
|
1805
|
+
* @public
|
|
1652
1806
|
* <p>Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.</p>
|
|
1653
1807
|
*/
|
|
1654
1808
|
lastEnabledTime?: number;
|
|
1655
1809
|
/**
|
|
1810
|
+
* @public
|
|
1656
1811
|
* <p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>
|
|
1657
1812
|
*/
|
|
1658
1813
|
lastDisabledTime?: number;
|
|
1659
1814
|
/**
|
|
1815
|
+
* @public
|
|
1660
1816
|
* <p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.</p>
|
|
1661
1817
|
*/
|
|
1662
1818
|
lastModifiedTime?: number;
|
|
1663
1819
|
/**
|
|
1820
|
+
* @public
|
|
1664
1821
|
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>
|
|
1665
1822
|
*/
|
|
1666
1823
|
lastLoginTime?: number;
|
|
@@ -1682,6 +1839,7 @@ export type LocationType = (typeof LocationType)[keyof typeof LocationType];
|
|
|
1682
1839
|
*/
|
|
1683
1840
|
export interface GetWorkingLocationRequest {
|
|
1684
1841
|
/**
|
|
1842
|
+
* @public
|
|
1685
1843
|
* <p>Specify the type of the working location.</p>
|
|
1686
1844
|
* <ul>
|
|
1687
1845
|
* <li>
|
|
@@ -1703,14 +1861,17 @@ export interface GetWorkingLocationRequest {
|
|
|
1703
1861
|
*/
|
|
1704
1862
|
export interface GetWorkingLocationResponse {
|
|
1705
1863
|
/**
|
|
1864
|
+
* @public
|
|
1706
1865
|
* <p>Returns the Amazon S3 URI for the working location.</p>
|
|
1707
1866
|
*/
|
|
1708
1867
|
s3Uri?: string;
|
|
1709
1868
|
/**
|
|
1869
|
+
* @public
|
|
1710
1870
|
* <p>Returns the Amazon S3 Path for the working location.</p>
|
|
1711
1871
|
*/
|
|
1712
1872
|
s3Path?: string;
|
|
1713
1873
|
/**
|
|
1874
|
+
* @public
|
|
1714
1875
|
* <p>Returns the Amazon S3 bucket name for the working location.</p>
|
|
1715
1876
|
*/
|
|
1716
1877
|
s3Bucket?: string;
|
|
@@ -1721,14 +1882,17 @@ export interface GetWorkingLocationResponse {
|
|
|
1721
1882
|
*/
|
|
1722
1883
|
export interface ListChangesetsRequest {
|
|
1723
1884
|
/**
|
|
1885
|
+
* @public
|
|
1724
1886
|
* <p>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</p>
|
|
1725
1887
|
*/
|
|
1726
1888
|
datasetId: string | undefined;
|
|
1727
1889
|
/**
|
|
1890
|
+
* @public
|
|
1728
1891
|
* <p>The maximum number of results per page.</p>
|
|
1729
1892
|
*/
|
|
1730
1893
|
maxResults?: number;
|
|
1731
1894
|
/**
|
|
1895
|
+
* @public
|
|
1732
1896
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1733
1897
|
*/
|
|
1734
1898
|
nextToken?: string;
|
|
@@ -1739,18 +1903,22 @@ export interface ListChangesetsRequest {
|
|
|
1739
1903
|
*/
|
|
1740
1904
|
export interface ChangesetSummary {
|
|
1741
1905
|
/**
|
|
1906
|
+
* @public
|
|
1742
1907
|
* <p>The unique identifier for a Changeset.</p>
|
|
1743
1908
|
*/
|
|
1744
1909
|
changesetId?: string;
|
|
1745
1910
|
/**
|
|
1911
|
+
* @public
|
|
1746
1912
|
* <p>The ARN identifier of the Changeset.</p>
|
|
1747
1913
|
*/
|
|
1748
1914
|
changesetArn?: string;
|
|
1749
1915
|
/**
|
|
1916
|
+
* @public
|
|
1750
1917
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
1751
1918
|
*/
|
|
1752
1919
|
datasetId?: string;
|
|
1753
1920
|
/**
|
|
1921
|
+
* @public
|
|
1754
1922
|
* <p>Type that indicates how a Changeset is applied to a Dataset.</p>
|
|
1755
1923
|
* <ul>
|
|
1756
1924
|
* <li>
|
|
@@ -1772,18 +1940,22 @@ export interface ChangesetSummary {
|
|
|
1772
1940
|
*/
|
|
1773
1941
|
changeType?: ChangeType | string;
|
|
1774
1942
|
/**
|
|
1943
|
+
* @public
|
|
1775
1944
|
* <p>Options that define the location of the data being ingested.</p>
|
|
1776
1945
|
*/
|
|
1777
1946
|
sourceParams?: Record<string, string>;
|
|
1778
1947
|
/**
|
|
1948
|
+
* @public
|
|
1779
1949
|
* <p>Options that define the structure of the source file(s).</p>
|
|
1780
1950
|
*/
|
|
1781
1951
|
formatParams?: Record<string, string>;
|
|
1782
1952
|
/**
|
|
1953
|
+
* @public
|
|
1783
1954
|
* <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1784
1955
|
*/
|
|
1785
1956
|
createTime?: number;
|
|
1786
1957
|
/**
|
|
1958
|
+
* @public
|
|
1787
1959
|
* <p>Status of the Changeset ingestion.</p>
|
|
1788
1960
|
* <ul>
|
|
1789
1961
|
* <li>
|
|
@@ -1810,22 +1982,27 @@ export interface ChangesetSummary {
|
|
|
1810
1982
|
*/
|
|
1811
1983
|
status?: IngestionStatus | string;
|
|
1812
1984
|
/**
|
|
1985
|
+
* @public
|
|
1813
1986
|
* <p>The structure with error messages.</p>
|
|
1814
1987
|
*/
|
|
1815
1988
|
errorInfo?: ChangesetErrorInfo;
|
|
1816
1989
|
/**
|
|
1990
|
+
* @public
|
|
1817
1991
|
* <p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1818
1992
|
*/
|
|
1819
1993
|
activeUntilTimestamp?: number;
|
|
1820
1994
|
/**
|
|
1995
|
+
* @public
|
|
1821
1996
|
* <p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1822
1997
|
*/
|
|
1823
1998
|
activeFromTimestamp?: number;
|
|
1824
1999
|
/**
|
|
2000
|
+
* @public
|
|
1825
2001
|
* <p>The unique identifier of the Changeset that is updated.</p>
|
|
1826
2002
|
*/
|
|
1827
2003
|
updatesChangesetId?: string;
|
|
1828
2004
|
/**
|
|
2005
|
+
* @public
|
|
1829
2006
|
* <p>The unique identifier of the updated Changeset.</p>
|
|
1830
2007
|
*/
|
|
1831
2008
|
updatedByChangesetId?: string;
|
|
@@ -1836,10 +2013,12 @@ export interface ChangesetSummary {
|
|
|
1836
2013
|
*/
|
|
1837
2014
|
export interface ListChangesetsResponse {
|
|
1838
2015
|
/**
|
|
2016
|
+
* @public
|
|
1839
2017
|
* <p>List of Changesets found.</p>
|
|
1840
2018
|
*/
|
|
1841
2019
|
changesets?: ChangesetSummary[];
|
|
1842
2020
|
/**
|
|
2021
|
+
* @public
|
|
1843
2022
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1844
2023
|
*/
|
|
1845
2024
|
nextToken?: string;
|
|
@@ -1850,10 +2029,12 @@ export interface ListChangesetsResponse {
|
|
|
1850
2029
|
*/
|
|
1851
2030
|
export interface ListDatasetsRequest {
|
|
1852
2031
|
/**
|
|
2032
|
+
* @public
|
|
1853
2033
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1854
2034
|
*/
|
|
1855
2035
|
nextToken?: string;
|
|
1856
2036
|
/**
|
|
2037
|
+
* @public
|
|
1857
2038
|
* <p>The maximum number of results per page.</p>
|
|
1858
2039
|
*/
|
|
1859
2040
|
maxResults?: number;
|
|
@@ -1864,18 +2045,22 @@ export interface ListDatasetsRequest {
|
|
|
1864
2045
|
*/
|
|
1865
2046
|
export interface Dataset {
|
|
1866
2047
|
/**
|
|
2048
|
+
* @public
|
|
1867
2049
|
* <p>An identifier for a Dataset.</p>
|
|
1868
2050
|
*/
|
|
1869
2051
|
datasetId?: string;
|
|
1870
2052
|
/**
|
|
2053
|
+
* @public
|
|
1871
2054
|
* <p>The ARN identifier of the Dataset.</p>
|
|
1872
2055
|
*/
|
|
1873
2056
|
datasetArn?: string;
|
|
1874
2057
|
/**
|
|
2058
|
+
* @public
|
|
1875
2059
|
* <p>Display title for a Dataset.</p>
|
|
1876
2060
|
*/
|
|
1877
2061
|
datasetTitle?: string;
|
|
1878
2062
|
/**
|
|
2063
|
+
* @public
|
|
1879
2064
|
* <p>The format in which Dataset data is structured.</p>
|
|
1880
2065
|
* <ul>
|
|
1881
2066
|
* <li>
|
|
@@ -1890,26 +2075,32 @@ export interface Dataset {
|
|
|
1890
2075
|
*/
|
|
1891
2076
|
kind?: DatasetKind | string;
|
|
1892
2077
|
/**
|
|
2078
|
+
* @public
|
|
1893
2079
|
* <p>Description for a Dataset.</p>
|
|
1894
2080
|
*/
|
|
1895
2081
|
datasetDescription?: string;
|
|
1896
2082
|
/**
|
|
2083
|
+
* @public
|
|
1897
2084
|
* <p>Contact information for a Dataset owner.</p>
|
|
1898
2085
|
*/
|
|
1899
2086
|
ownerInfo?: DatasetOwnerInfo;
|
|
1900
2087
|
/**
|
|
2088
|
+
* @public
|
|
1901
2089
|
* <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1902
2090
|
*/
|
|
1903
2091
|
createTime?: number;
|
|
1904
2092
|
/**
|
|
2093
|
+
* @public
|
|
1905
2094
|
* <p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1906
2095
|
*/
|
|
1907
2096
|
lastModifiedTime?: number;
|
|
1908
2097
|
/**
|
|
2098
|
+
* @public
|
|
1909
2099
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
1910
2100
|
*/
|
|
1911
2101
|
schemaDefinition?: SchemaUnion;
|
|
1912
2102
|
/**
|
|
2103
|
+
* @public
|
|
1913
2104
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
1914
2105
|
*/
|
|
1915
2106
|
alias?: string;
|
|
@@ -1920,10 +2111,12 @@ export interface Dataset {
|
|
|
1920
2111
|
*/
|
|
1921
2112
|
export interface ListDatasetsResponse {
|
|
1922
2113
|
/**
|
|
2114
|
+
* @public
|
|
1923
2115
|
* <p>List of Datasets.</p>
|
|
1924
2116
|
*/
|
|
1925
2117
|
datasets?: Dataset[];
|
|
1926
2118
|
/**
|
|
2119
|
+
* @public
|
|
1927
2120
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1928
2121
|
*/
|
|
1929
2122
|
nextToken?: string;
|
|
@@ -1934,14 +2127,17 @@ export interface ListDatasetsResponse {
|
|
|
1934
2127
|
*/
|
|
1935
2128
|
export interface ListDataViewsRequest {
|
|
1936
2129
|
/**
|
|
2130
|
+
* @public
|
|
1937
2131
|
* <p>The unique identifier of the Dataset for which to retrieve Dataviews.</p>
|
|
1938
2132
|
*/
|
|
1939
2133
|
datasetId: string | undefined;
|
|
1940
2134
|
/**
|
|
2135
|
+
* @public
|
|
1941
2136
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1942
2137
|
*/
|
|
1943
2138
|
nextToken?: string;
|
|
1944
2139
|
/**
|
|
2140
|
+
* @public
|
|
1945
2141
|
* <p>The maximum number of results per page.</p>
|
|
1946
2142
|
*/
|
|
1947
2143
|
maxResults?: number;
|
|
@@ -1952,30 +2148,37 @@ export interface ListDataViewsRequest {
|
|
|
1952
2148
|
*/
|
|
1953
2149
|
export interface DataViewSummary {
|
|
1954
2150
|
/**
|
|
2151
|
+
* @public
|
|
1955
2152
|
* <p>The unique identifier for the Dataview.</p>
|
|
1956
2153
|
*/
|
|
1957
2154
|
dataViewId?: string;
|
|
1958
2155
|
/**
|
|
2156
|
+
* @public
|
|
1959
2157
|
* <p>The ARN identifier of the Dataview.</p>
|
|
1960
2158
|
*/
|
|
1961
2159
|
dataViewArn?: string;
|
|
1962
2160
|
/**
|
|
2161
|
+
* @public
|
|
1963
2162
|
* <p>Th unique identifier for the Dataview Dataset.</p>
|
|
1964
2163
|
*/
|
|
1965
2164
|
datasetId?: string;
|
|
1966
2165
|
/**
|
|
2166
|
+
* @public
|
|
1967
2167
|
* <p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
1968
2168
|
*/
|
|
1969
2169
|
asOfTimestamp?: number;
|
|
1970
2170
|
/**
|
|
2171
|
+
* @public
|
|
1971
2172
|
* <p>Ordered set of column names used to partition data.</p>
|
|
1972
2173
|
*/
|
|
1973
2174
|
partitionColumns?: string[];
|
|
1974
2175
|
/**
|
|
2176
|
+
* @public
|
|
1975
2177
|
* <p>Columns to be used for sorting the data.</p>
|
|
1976
2178
|
*/
|
|
1977
2179
|
sortColumns?: string[];
|
|
1978
2180
|
/**
|
|
2181
|
+
* @public
|
|
1979
2182
|
* <p>The status of a Dataview creation.</p>
|
|
1980
2183
|
* <ul>
|
|
1981
2184
|
* <li>
|
|
@@ -2014,22 +2217,27 @@ export interface DataViewSummary {
|
|
|
2014
2217
|
*/
|
|
2015
2218
|
status?: DataViewStatus | string;
|
|
2016
2219
|
/**
|
|
2220
|
+
* @public
|
|
2017
2221
|
* <p>The structure with error messages.</p>
|
|
2018
2222
|
*/
|
|
2019
2223
|
errorInfo?: DataViewErrorInfo;
|
|
2020
2224
|
/**
|
|
2225
|
+
* @public
|
|
2021
2226
|
* <p>Information about the Dataview destination.</p>
|
|
2022
2227
|
*/
|
|
2023
2228
|
destinationTypeProperties?: DataViewDestinationTypeParams;
|
|
2024
2229
|
/**
|
|
2230
|
+
* @public
|
|
2025
2231
|
* <p>The flag to indicate Dataview should be updated automatically.</p>
|
|
2026
2232
|
*/
|
|
2027
2233
|
autoUpdate?: boolean;
|
|
2028
2234
|
/**
|
|
2235
|
+
* @public
|
|
2029
2236
|
* <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
2030
2237
|
*/
|
|
2031
2238
|
createTime?: number;
|
|
2032
2239
|
/**
|
|
2240
|
+
* @public
|
|
2033
2241
|
* <p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
|
|
2034
2242
|
*/
|
|
2035
2243
|
lastModifiedTime?: number;
|
|
@@ -2039,10 +2247,12 @@ export interface DataViewSummary {
|
|
|
2039
2247
|
*/
|
|
2040
2248
|
export interface ListDataViewsResponse {
|
|
2041
2249
|
/**
|
|
2250
|
+
* @public
|
|
2042
2251
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2043
2252
|
*/
|
|
2044
2253
|
nextToken?: string;
|
|
2045
2254
|
/**
|
|
2255
|
+
* @public
|
|
2046
2256
|
* <p>A list of Dataviews.</p>
|
|
2047
2257
|
*/
|
|
2048
2258
|
dataViews?: DataViewSummary[];
|
|
@@ -2052,10 +2262,12 @@ export interface ListDataViewsResponse {
|
|
|
2052
2262
|
*/
|
|
2053
2263
|
export interface ListPermissionGroupsRequest {
|
|
2054
2264
|
/**
|
|
2265
|
+
* @public
|
|
2055
2266
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2056
2267
|
*/
|
|
2057
2268
|
nextToken?: string;
|
|
2058
2269
|
/**
|
|
2270
|
+
* @public
|
|
2059
2271
|
* <p>The maximum number of results per page.</p>
|
|
2060
2272
|
*/
|
|
2061
2273
|
maxResults: number | undefined;
|
|
@@ -2065,10 +2277,12 @@ export interface ListPermissionGroupsRequest {
|
|
|
2065
2277
|
*/
|
|
2066
2278
|
export interface ListPermissionGroupsResponse {
|
|
2067
2279
|
/**
|
|
2280
|
+
* @public
|
|
2068
2281
|
* <p>A list of all the permission groups.</p>
|
|
2069
2282
|
*/
|
|
2070
2283
|
permissionGroups?: PermissionGroup[];
|
|
2071
2284
|
/**
|
|
2285
|
+
* @public
|
|
2072
2286
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2073
2287
|
*/
|
|
2074
2288
|
nextToken?: string;
|
|
@@ -2078,14 +2292,17 @@ export interface ListPermissionGroupsResponse {
|
|
|
2078
2292
|
*/
|
|
2079
2293
|
export interface ListPermissionGroupsByUserRequest {
|
|
2080
2294
|
/**
|
|
2295
|
+
* @public
|
|
2081
2296
|
* <p>The unique identifier for the user.</p>
|
|
2082
2297
|
*/
|
|
2083
2298
|
userId: string | undefined;
|
|
2084
2299
|
/**
|
|
2300
|
+
* @public
|
|
2085
2301
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2086
2302
|
*/
|
|
2087
2303
|
nextToken?: string;
|
|
2088
2304
|
/**
|
|
2305
|
+
* @public
|
|
2089
2306
|
* <p>The maximum number of results per page.</p>
|
|
2090
2307
|
*/
|
|
2091
2308
|
maxResults: number | undefined;
|
|
@@ -2096,14 +2313,17 @@ export interface ListPermissionGroupsByUserRequest {
|
|
|
2096
2313
|
*/
|
|
2097
2314
|
export interface PermissionGroupByUser {
|
|
2098
2315
|
/**
|
|
2316
|
+
* @public
|
|
2099
2317
|
* <p>The unique identifier for the permission group.</p>
|
|
2100
2318
|
*/
|
|
2101
2319
|
permissionGroupId?: string;
|
|
2102
2320
|
/**
|
|
2321
|
+
* @public
|
|
2103
2322
|
* <p>The name of the permission group.</p>
|
|
2104
2323
|
*/
|
|
2105
2324
|
name?: string;
|
|
2106
2325
|
/**
|
|
2326
|
+
* @public
|
|
2107
2327
|
* <p>Indicates the status of the user account within a permission group.</p>
|
|
2108
2328
|
* <ul>
|
|
2109
2329
|
* <li>
|
|
@@ -2127,10 +2347,12 @@ export interface PermissionGroupByUser {
|
|
|
2127
2347
|
*/
|
|
2128
2348
|
export interface ListPermissionGroupsByUserResponse {
|
|
2129
2349
|
/**
|
|
2350
|
+
* @public
|
|
2130
2351
|
* <p>A list of returned permission groups.</p>
|
|
2131
2352
|
*/
|
|
2132
2353
|
permissionGroups?: PermissionGroupByUser[];
|
|
2133
2354
|
/**
|
|
2355
|
+
* @public
|
|
2134
2356
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2135
2357
|
*/
|
|
2136
2358
|
nextToken?: string;
|
|
@@ -2140,10 +2362,12 @@ export interface ListPermissionGroupsByUserResponse {
|
|
|
2140
2362
|
*/
|
|
2141
2363
|
export interface ListUsersRequest {
|
|
2142
2364
|
/**
|
|
2365
|
+
* @public
|
|
2143
2366
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2144
2367
|
*/
|
|
2145
2368
|
nextToken?: string;
|
|
2146
2369
|
/**
|
|
2370
|
+
* @public
|
|
2147
2371
|
* <p>The maximum number of results per page.</p>
|
|
2148
2372
|
*/
|
|
2149
2373
|
maxResults: number | undefined;
|
|
@@ -2154,10 +2378,12 @@ export interface ListUsersRequest {
|
|
|
2154
2378
|
*/
|
|
2155
2379
|
export interface User {
|
|
2156
2380
|
/**
|
|
2381
|
+
* @public
|
|
2157
2382
|
* <p>The unique identifier for the user.</p>
|
|
2158
2383
|
*/
|
|
2159
2384
|
userId?: string;
|
|
2160
2385
|
/**
|
|
2386
|
+
* @public
|
|
2161
2387
|
* <p>The current status of the user account. </p>
|
|
2162
2388
|
* <ul>
|
|
2163
2389
|
* <li>
|
|
@@ -2176,18 +2402,22 @@ export interface User {
|
|
|
2176
2402
|
*/
|
|
2177
2403
|
status?: UserStatus | string;
|
|
2178
2404
|
/**
|
|
2405
|
+
* @public
|
|
2179
2406
|
* <p>The first name of the user.</p>
|
|
2180
2407
|
*/
|
|
2181
2408
|
firstName?: string;
|
|
2182
2409
|
/**
|
|
2410
|
+
* @public
|
|
2183
2411
|
* <p> The last name of the user.</p>
|
|
2184
2412
|
*/
|
|
2185
2413
|
lastName?: string;
|
|
2186
2414
|
/**
|
|
2415
|
+
* @public
|
|
2187
2416
|
* <p>The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>
|
|
2188
2417
|
*/
|
|
2189
2418
|
emailAddress?: string;
|
|
2190
2419
|
/**
|
|
2420
|
+
* @public
|
|
2191
2421
|
* <p> Indicates the type of user.</p>
|
|
2192
2422
|
* <ul>
|
|
2193
2423
|
* <li>
|
|
@@ -2202,6 +2432,7 @@ export interface User {
|
|
|
2202
2432
|
*/
|
|
2203
2433
|
type?: UserType | string;
|
|
2204
2434
|
/**
|
|
2435
|
+
* @public
|
|
2205
2436
|
* <p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p>
|
|
2206
2437
|
* <ul>
|
|
2207
2438
|
* <li>
|
|
@@ -2216,28 +2447,34 @@ export interface User {
|
|
|
2216
2447
|
*/
|
|
2217
2448
|
apiAccess?: ApiAccess | string;
|
|
2218
2449
|
/**
|
|
2450
|
+
* @public
|
|
2219
2451
|
* <p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>
|
|
2220
2452
|
*/
|
|
2221
2453
|
apiAccessPrincipalArn?: string;
|
|
2222
2454
|
/**
|
|
2455
|
+
* @public
|
|
2223
2456
|
* <p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
2224
2457
|
*/
|
|
2225
2458
|
createTime?: number;
|
|
2226
2459
|
/**
|
|
2460
|
+
* @public
|
|
2227
2461
|
* <p> Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
|
|
2228
2462
|
* </p>
|
|
2229
2463
|
*/
|
|
2230
2464
|
lastEnabledTime?: number;
|
|
2231
2465
|
/**
|
|
2466
|
+
* @public
|
|
2232
2467
|
* <p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>
|
|
2233
2468
|
*/
|
|
2234
2469
|
lastDisabledTime?: number;
|
|
2235
2470
|
/**
|
|
2471
|
+
* @public
|
|
2236
2472
|
* <p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
|
|
2237
2473
|
* </p>
|
|
2238
2474
|
*/
|
|
2239
2475
|
lastModifiedTime?: number;
|
|
2240
2476
|
/**
|
|
2477
|
+
* @public
|
|
2241
2478
|
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
|
|
2242
2479
|
* </p>
|
|
2243
2480
|
*/
|
|
@@ -2248,10 +2485,12 @@ export interface User {
|
|
|
2248
2485
|
*/
|
|
2249
2486
|
export interface ListUsersResponse {
|
|
2250
2487
|
/**
|
|
2488
|
+
* @public
|
|
2251
2489
|
* <p>A list of all the user accounts.</p>
|
|
2252
2490
|
*/
|
|
2253
2491
|
users?: User[];
|
|
2254
2492
|
/**
|
|
2493
|
+
* @public
|
|
2255
2494
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2256
2495
|
*/
|
|
2257
2496
|
nextToken?: string;
|
|
@@ -2261,14 +2500,17 @@ export interface ListUsersResponse {
|
|
|
2261
2500
|
*/
|
|
2262
2501
|
export interface ListUsersByPermissionGroupRequest {
|
|
2263
2502
|
/**
|
|
2503
|
+
* @public
|
|
2264
2504
|
* <p>The unique identifier for the permission group.</p>
|
|
2265
2505
|
*/
|
|
2266
2506
|
permissionGroupId: string | undefined;
|
|
2267
2507
|
/**
|
|
2508
|
+
* @public
|
|
2268
2509
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2269
2510
|
*/
|
|
2270
2511
|
nextToken?: string;
|
|
2271
2512
|
/**
|
|
2513
|
+
* @public
|
|
2272
2514
|
* <p>The maximum number of results per page.</p>
|
|
2273
2515
|
*/
|
|
2274
2516
|
maxResults: number | undefined;
|
|
@@ -2279,10 +2521,12 @@ export interface ListUsersByPermissionGroupRequest {
|
|
|
2279
2521
|
*/
|
|
2280
2522
|
export interface UserByPermissionGroup {
|
|
2281
2523
|
/**
|
|
2524
|
+
* @public
|
|
2282
2525
|
* <p>The unique identifier for the user.</p>
|
|
2283
2526
|
*/
|
|
2284
2527
|
userId?: string;
|
|
2285
2528
|
/**
|
|
2529
|
+
* @public
|
|
2286
2530
|
* <p>The current status of the user account. </p>
|
|
2287
2531
|
* <ul>
|
|
2288
2532
|
* <li>
|
|
@@ -2301,18 +2545,22 @@ export interface UserByPermissionGroup {
|
|
|
2301
2545
|
*/
|
|
2302
2546
|
status?: UserStatus | string;
|
|
2303
2547
|
/**
|
|
2548
|
+
* @public
|
|
2304
2549
|
* <p>The first name of the user.</p>
|
|
2305
2550
|
*/
|
|
2306
2551
|
firstName?: string;
|
|
2307
2552
|
/**
|
|
2553
|
+
* @public
|
|
2308
2554
|
* <p>The last name of the user.</p>
|
|
2309
2555
|
*/
|
|
2310
2556
|
lastName?: string;
|
|
2311
2557
|
/**
|
|
2558
|
+
* @public
|
|
2312
2559
|
* <p>The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.</p>
|
|
2313
2560
|
*/
|
|
2314
2561
|
emailAddress?: string;
|
|
2315
2562
|
/**
|
|
2563
|
+
* @public
|
|
2316
2564
|
* <p> Indicates the type of user.</p>
|
|
2317
2565
|
* <ul>
|
|
2318
2566
|
* <li>
|
|
@@ -2327,6 +2575,7 @@ export interface UserByPermissionGroup {
|
|
|
2327
2575
|
*/
|
|
2328
2576
|
type?: UserType | string;
|
|
2329
2577
|
/**
|
|
2578
|
+
* @public
|
|
2330
2579
|
* <p>Indicates whether the user can access FinSpace API operations.</p>
|
|
2331
2580
|
* <ul>
|
|
2332
2581
|
* <li>
|
|
@@ -2341,10 +2590,12 @@ export interface UserByPermissionGroup {
|
|
|
2341
2590
|
*/
|
|
2342
2591
|
apiAccess?: ApiAccess | string;
|
|
2343
2592
|
/**
|
|
2593
|
+
* @public
|
|
2344
2594
|
* <p>The IAM ARN identifier that is attached to FinSpace API calls.</p>
|
|
2345
2595
|
*/
|
|
2346
2596
|
apiAccessPrincipalArn?: string;
|
|
2347
2597
|
/**
|
|
2598
|
+
* @public
|
|
2348
2599
|
* <p>Indicates the status of the user account within a permission group.</p>
|
|
2349
2600
|
* <ul>
|
|
2350
2601
|
* <li>
|
|
@@ -2368,10 +2619,12 @@ export interface UserByPermissionGroup {
|
|
|
2368
2619
|
*/
|
|
2369
2620
|
export interface ListUsersByPermissionGroupResponse {
|
|
2370
2621
|
/**
|
|
2622
|
+
* @public
|
|
2371
2623
|
* <p>Lists details of all users in a specific permission group.</p>
|
|
2372
2624
|
*/
|
|
2373
2625
|
users?: UserByPermissionGroup[];
|
|
2374
2626
|
/**
|
|
2627
|
+
* @public
|
|
2375
2628
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2376
2629
|
*/
|
|
2377
2630
|
nextToken?: string;
|
|
@@ -2381,10 +2634,12 @@ export interface ListUsersByPermissionGroupResponse {
|
|
|
2381
2634
|
*/
|
|
2382
2635
|
export interface ResetUserPasswordRequest {
|
|
2383
2636
|
/**
|
|
2637
|
+
* @public
|
|
2384
2638
|
* <p>The unique identifier of the user that a temporary password is requested for.</p>
|
|
2385
2639
|
*/
|
|
2386
2640
|
userId: string | undefined;
|
|
2387
2641
|
/**
|
|
2642
|
+
* @public
|
|
2388
2643
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2389
2644
|
*/
|
|
2390
2645
|
clientToken?: string;
|
|
@@ -2394,10 +2649,12 @@ export interface ResetUserPasswordRequest {
|
|
|
2394
2649
|
*/
|
|
2395
2650
|
export interface ResetUserPasswordResponse {
|
|
2396
2651
|
/**
|
|
2652
|
+
* @public
|
|
2397
2653
|
* <p>The unique identifier of the user that a new password is generated for.</p>
|
|
2398
2654
|
*/
|
|
2399
2655
|
userId?: string;
|
|
2400
2656
|
/**
|
|
2657
|
+
* @public
|
|
2401
2658
|
* <p>A randomly generated temporary password for the requested user account. This password expires in 7 days.</p>
|
|
2402
2659
|
*/
|
|
2403
2660
|
temporaryPassword?: string;
|
|
@@ -2408,18 +2665,22 @@ export interface ResetUserPasswordResponse {
|
|
|
2408
2665
|
*/
|
|
2409
2666
|
export interface UpdateChangesetRequest {
|
|
2410
2667
|
/**
|
|
2668
|
+
* @public
|
|
2411
2669
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2412
2670
|
*/
|
|
2413
2671
|
clientToken?: string;
|
|
2414
2672
|
/**
|
|
2673
|
+
* @public
|
|
2415
2674
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
2416
2675
|
*/
|
|
2417
2676
|
datasetId: string | undefined;
|
|
2418
2677
|
/**
|
|
2678
|
+
* @public
|
|
2419
2679
|
* <p>The unique identifier for the Changeset to update.</p>
|
|
2420
2680
|
*/
|
|
2421
2681
|
changesetId: string | undefined;
|
|
2422
2682
|
/**
|
|
2683
|
+
* @public
|
|
2423
2684
|
* <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
|
|
2424
2685
|
* <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
|
|
2425
2686
|
* <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
|
|
@@ -2436,6 +2697,7 @@ export interface UpdateChangesetRequest {
|
|
|
2436
2697
|
*/
|
|
2437
2698
|
sourceParams: Record<string, string> | undefined;
|
|
2438
2699
|
/**
|
|
2700
|
+
* @public
|
|
2439
2701
|
* <p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>).
|
|
2440
2702
|
* </p>
|
|
2441
2703
|
* <p>
|
|
@@ -2491,10 +2753,12 @@ export interface UpdateChangesetRequest {
|
|
|
2491
2753
|
*/
|
|
2492
2754
|
export interface UpdateChangesetResponse {
|
|
2493
2755
|
/**
|
|
2756
|
+
* @public
|
|
2494
2757
|
* <p>The unique identifier for the Changeset to update.</p>
|
|
2495
2758
|
*/
|
|
2496
2759
|
changesetId?: string;
|
|
2497
2760
|
/**
|
|
2761
|
+
* @public
|
|
2498
2762
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
2499
2763
|
*/
|
|
2500
2764
|
datasetId?: string;
|
|
@@ -2505,18 +2769,22 @@ export interface UpdateChangesetResponse {
|
|
|
2505
2769
|
*/
|
|
2506
2770
|
export interface UpdateDatasetRequest {
|
|
2507
2771
|
/**
|
|
2772
|
+
* @public
|
|
2508
2773
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2509
2774
|
*/
|
|
2510
2775
|
clientToken?: string;
|
|
2511
2776
|
/**
|
|
2777
|
+
* @public
|
|
2512
2778
|
* <p>The unique identifier for the Dataset to update.</p>
|
|
2513
2779
|
*/
|
|
2514
2780
|
datasetId: string | undefined;
|
|
2515
2781
|
/**
|
|
2782
|
+
* @public
|
|
2516
2783
|
* <p>A display title for the Dataset.</p>
|
|
2517
2784
|
*/
|
|
2518
2785
|
datasetTitle: string | undefined;
|
|
2519
2786
|
/**
|
|
2787
|
+
* @public
|
|
2520
2788
|
* <p>The format in which the Dataset data is structured.</p>
|
|
2521
2789
|
* <ul>
|
|
2522
2790
|
* <li>
|
|
@@ -2531,14 +2799,17 @@ export interface UpdateDatasetRequest {
|
|
|
2531
2799
|
*/
|
|
2532
2800
|
kind: DatasetKind | string | undefined;
|
|
2533
2801
|
/**
|
|
2802
|
+
* @public
|
|
2534
2803
|
* <p>A description for the Dataset.</p>
|
|
2535
2804
|
*/
|
|
2536
2805
|
datasetDescription?: string;
|
|
2537
2806
|
/**
|
|
2807
|
+
* @public
|
|
2538
2808
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
2539
2809
|
*/
|
|
2540
2810
|
alias?: string;
|
|
2541
2811
|
/**
|
|
2812
|
+
* @public
|
|
2542
2813
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
2543
2814
|
*/
|
|
2544
2815
|
schemaDefinition?: SchemaUnion;
|
|
@@ -2549,6 +2820,7 @@ export interface UpdateDatasetRequest {
|
|
|
2549
2820
|
*/
|
|
2550
2821
|
export interface UpdateDatasetResponse {
|
|
2551
2822
|
/**
|
|
2823
|
+
* @public
|
|
2552
2824
|
* <p>The unique identifier for updated Dataset.</p>
|
|
2553
2825
|
*/
|
|
2554
2826
|
datasetId?: string;
|
|
@@ -2558,18 +2830,22 @@ export interface UpdateDatasetResponse {
|
|
|
2558
2830
|
*/
|
|
2559
2831
|
export interface UpdatePermissionGroupRequest {
|
|
2560
2832
|
/**
|
|
2833
|
+
* @public
|
|
2561
2834
|
* <p>The unique identifier for the permission group to update.</p>
|
|
2562
2835
|
*/
|
|
2563
2836
|
permissionGroupId: string | undefined;
|
|
2564
2837
|
/**
|
|
2838
|
+
* @public
|
|
2565
2839
|
* <p>The name of the permission group.</p>
|
|
2566
2840
|
*/
|
|
2567
2841
|
name?: string;
|
|
2568
2842
|
/**
|
|
2843
|
+
* @public
|
|
2569
2844
|
* <p>A brief description for the permission group.</p>
|
|
2570
2845
|
*/
|
|
2571
2846
|
description?: string;
|
|
2572
2847
|
/**
|
|
2848
|
+
* @public
|
|
2573
2849
|
* <p>The permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
2574
2850
|
* <important>
|
|
2575
2851
|
* <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p>
|
|
@@ -2607,6 +2883,7 @@ export interface UpdatePermissionGroupRequest {
|
|
|
2607
2883
|
*/
|
|
2608
2884
|
applicationPermissions?: (ApplicationPermission | string)[];
|
|
2609
2885
|
/**
|
|
2886
|
+
* @public
|
|
2610
2887
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2611
2888
|
*/
|
|
2612
2889
|
clientToken?: string;
|
|
@@ -2616,6 +2893,7 @@ export interface UpdatePermissionGroupRequest {
|
|
|
2616
2893
|
*/
|
|
2617
2894
|
export interface UpdatePermissionGroupResponse {
|
|
2618
2895
|
/**
|
|
2896
|
+
* @public
|
|
2619
2897
|
* <p>The unique identifier for the updated permission group.</p>
|
|
2620
2898
|
*/
|
|
2621
2899
|
permissionGroupId?: string;
|
|
@@ -2625,10 +2903,12 @@ export interface UpdatePermissionGroupResponse {
|
|
|
2625
2903
|
*/
|
|
2626
2904
|
export interface UpdateUserRequest {
|
|
2627
2905
|
/**
|
|
2906
|
+
* @public
|
|
2628
2907
|
* <p>The unique identifier for the user account to update.</p>
|
|
2629
2908
|
*/
|
|
2630
2909
|
userId: string | undefined;
|
|
2631
2910
|
/**
|
|
2911
|
+
* @public
|
|
2632
2912
|
* <p>The option to indicate the type of user.</p>
|
|
2633
2913
|
* <ul>
|
|
2634
2914
|
* <li>
|
|
@@ -2643,14 +2923,17 @@ export interface UpdateUserRequest {
|
|
|
2643
2923
|
*/
|
|
2644
2924
|
type?: UserType | string;
|
|
2645
2925
|
/**
|
|
2926
|
+
* @public
|
|
2646
2927
|
* <p>The first name of the user.</p>
|
|
2647
2928
|
*/
|
|
2648
2929
|
firstName?: string;
|
|
2649
2930
|
/**
|
|
2931
|
+
* @public
|
|
2650
2932
|
* <p>The last name of the user.</p>
|
|
2651
2933
|
*/
|
|
2652
2934
|
lastName?: string;
|
|
2653
2935
|
/**
|
|
2936
|
+
* @public
|
|
2654
2937
|
* <p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p>
|
|
2655
2938
|
* <ul>
|
|
2656
2939
|
* <li>
|
|
@@ -2665,10 +2948,12 @@ export interface UpdateUserRequest {
|
|
|
2665
2948
|
*/
|
|
2666
2949
|
apiAccess?: ApiAccess | string;
|
|
2667
2950
|
/**
|
|
2951
|
+
* @public
|
|
2668
2952
|
* <p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>
|
|
2669
2953
|
*/
|
|
2670
2954
|
apiAccessPrincipalArn?: string;
|
|
2671
2955
|
/**
|
|
2956
|
+
* @public
|
|
2672
2957
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2673
2958
|
*/
|
|
2674
2959
|
clientToken?: string;
|
|
@@ -2678,6 +2963,7 @@ export interface UpdateUserRequest {
|
|
|
2678
2963
|
*/
|
|
2679
2964
|
export interface UpdateUserResponse {
|
|
2680
2965
|
/**
|
|
2966
|
+
* @public
|
|
2681
2967
|
* <p>The unique identifier of the updated user account.</p>
|
|
2682
2968
|
*/
|
|
2683
2969
|
userId?: string;
|