@aws-sdk/client-finspace-data 3.533.0 → 3.535.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.
Files changed (67) hide show
  1. package/dist-types/FinspaceData.d.ts +3 -1
  2. package/dist-types/FinspaceDataClient.d.ts +1 -1
  3. package/dist-types/commands/AssociateUserToPermissionGroupCommand.d.ts +3 -3
  4. package/dist-types/commands/CreateChangesetCommand.d.ts +3 -3
  5. package/dist-types/commands/CreateDataViewCommand.d.ts +3 -3
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +3 -3
  7. package/dist-types/commands/CreatePermissionGroupCommand.d.ts +3 -3
  8. package/dist-types/commands/CreateUserCommand.d.ts +3 -3
  9. package/dist-types/commands/DeleteDatasetCommand.d.ts +3 -3
  10. package/dist-types/commands/DeletePermissionGroupCommand.d.ts +3 -3
  11. package/dist-types/commands/DisableUserCommand.d.ts +3 -3
  12. package/dist-types/commands/DisassociateUserFromPermissionGroupCommand.d.ts +3 -3
  13. package/dist-types/commands/EnableUserCommand.d.ts +3 -3
  14. package/dist-types/commands/GetChangesetCommand.d.ts +3 -3
  15. package/dist-types/commands/GetDataViewCommand.d.ts +3 -3
  16. package/dist-types/commands/GetDatasetCommand.d.ts +3 -3
  17. package/dist-types/commands/GetExternalDataViewAccessDetailsCommand.d.ts +3 -3
  18. package/dist-types/commands/GetPermissionGroupCommand.d.ts +3 -3
  19. package/dist-types/commands/GetProgrammaticAccessCredentialsCommand.d.ts +3 -3
  20. package/dist-types/commands/GetUserCommand.d.ts +3 -3
  21. package/dist-types/commands/GetWorkingLocationCommand.d.ts +3 -3
  22. package/dist-types/commands/ListChangesetsCommand.d.ts +3 -3
  23. package/dist-types/commands/ListDataViewsCommand.d.ts +3 -3
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
  25. package/dist-types/commands/ListPermissionGroupsByUserCommand.d.ts +3 -3
  26. package/dist-types/commands/ListPermissionGroupsCommand.d.ts +3 -3
  27. package/dist-types/commands/ListUsersByPermissionGroupCommand.d.ts +3 -3
  28. package/dist-types/commands/ListUsersCommand.d.ts +3 -3
  29. package/dist-types/commands/ResetUserPasswordCommand.d.ts +3 -3
  30. package/dist-types/commands/UpdateChangesetCommand.d.ts +3 -3
  31. package/dist-types/commands/UpdateDatasetCommand.d.ts +3 -3
  32. package/dist-types/commands/UpdatePermissionGroupCommand.d.ts +3 -3
  33. package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
  34. package/dist-types/models/models_0.d.ts +337 -337
  35. package/dist-types/ts3.4/FinspaceData.d.ts +2 -0
  36. package/dist-types/ts3.4/commands/AssociateUserToPermissionGroupCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/CreateChangesetCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/CreateDataViewCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/CreatePermissionGroupCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/DeletePermissionGroupCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/DisableUserCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/DisassociateUserFromPermissionGroupCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/EnableUserCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/GetChangesetCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/GetDataViewCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/GetDatasetCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/GetExternalDataViewAccessDetailsCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/GetPermissionGroupCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/GetProgrammaticAccessCredentialsCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/GetUserCommand.d.ts +7 -0
  54. package/dist-types/ts3.4/commands/GetWorkingLocationCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/ListChangesetsCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ListDataViewsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/ListPermissionGroupsByUserCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/ListPermissionGroupsCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/ListUsersByPermissionGroupCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/ResetUserPasswordCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/UpdateChangesetCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/UpdateDatasetCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/UpdatePermissionGroupCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +9 -0
  67. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { FinspaceDataServiceException as __BaseException } from "./FinspaceDataServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -46,18 +46,18 @@ export type ApplicationPermission = (typeof ApplicationPermission)[keyof typeof
46
46
  */
47
47
  export interface AssociateUserToPermissionGroupRequest {
48
48
  /**
49
- * @public
50
49
  * <p>The unique identifier for the permission group.</p>
50
+ * @public
51
51
  */
52
52
  permissionGroupId: string | undefined;
53
53
  /**
54
- * @public
55
54
  * <p>The unique identifier for the user.</p>
55
+ * @public
56
56
  */
57
57
  userId: string | undefined;
58
58
  /**
59
- * @public
60
59
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
60
+ * @public
61
61
  */
62
62
  clientToken?: string;
63
63
  }
@@ -66,14 +66,14 @@ export interface AssociateUserToPermissionGroupRequest {
66
66
  */
67
67
  export interface AssociateUserToPermissionGroupResponse {
68
68
  /**
69
- * @public
70
69
  * <p>The returned status code of the response.</p>
70
+ * @public
71
71
  */
72
72
  statusCode?: number;
73
73
  }
74
74
  /**
75
- * @public
76
75
  * <p>The request conflicts with an existing resource.</p>
76
+ * @public
77
77
  */
78
78
  export declare class ConflictException extends __BaseException {
79
79
  readonly name: "ConflictException";
@@ -85,9 +85,9 @@ export declare class ConflictException extends __BaseException {
85
85
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
86
86
  }
87
87
  /**
88
- * @public
89
88
  * <p>The request processing has failed because of an unknown error, exception or
90
89
  * failure.</p>
90
+ * @public
91
91
  */
92
92
  export declare class InternalServerException extends __BaseException {
93
93
  readonly name: "InternalServerException";
@@ -98,8 +98,8 @@ export declare class InternalServerException extends __BaseException {
98
98
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
99
99
  }
100
100
  /**
101
- * @public
102
101
  * <p>One or more resources can't be found.</p>
102
+ * @public
103
103
  */
104
104
  export declare class ResourceNotFoundException extends __BaseException {
105
105
  readonly name: "ResourceNotFoundException";
@@ -111,8 +111,8 @@ export declare class ResourceNotFoundException extends __BaseException {
111
111
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
112
112
  }
113
113
  /**
114
- * @public
115
114
  * <p>The request was denied due to request throttling.</p>
115
+ * @public
116
116
  */
117
117
  export declare class ThrottlingException extends __BaseException {
118
118
  readonly name: "ThrottlingException";
@@ -123,8 +123,8 @@ export declare class ThrottlingException extends __BaseException {
123
123
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
124
124
  }
125
125
  /**
126
- * @public
127
126
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
127
+ * @public
128
128
  */
129
129
  export declare class ValidationException extends __BaseException {
130
130
  readonly name: "ValidationException";
@@ -136,28 +136,28 @@ export declare class ValidationException extends __BaseException {
136
136
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
137
137
  }
138
138
  /**
139
- * @public
140
139
  * <p> The credentials required to access the external Dataview from the S3 location.</p>
140
+ * @public
141
141
  */
142
142
  export interface AwsCredentials {
143
143
  /**
144
- * @public
145
144
  * <p> The unique identifier for the security credentials.</p>
145
+ * @public
146
146
  */
147
147
  accessKeyId?: string;
148
148
  /**
149
- * @public
150
149
  * <p> The secret access key that can be used to sign requests.</p>
150
+ * @public
151
151
  */
152
152
  secretAccessKey?: string;
153
153
  /**
154
- * @public
155
154
  * <p> The token that users must pass to use the credentials.</p>
155
+ * @public
156
156
  */
157
157
  sessionToken?: string;
158
158
  /**
159
- * @public
160
159
  * <p> The Epoch time when the current credentials expire.</p>
160
+ * @public
161
161
  */
162
162
  expiration?: number;
163
163
  }
@@ -175,23 +175,22 @@ export declare const ChangeType: {
175
175
  */
176
176
  export type ChangeType = (typeof ChangeType)[keyof typeof ChangeType];
177
177
  /**
178
- * @public
179
178
  * The request for a CreateChangeset operation.
179
+ * @public
180
180
  */
181
181
  export interface CreateChangesetRequest {
182
182
  /**
183
- * @public
184
183
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
184
+ * @public
185
185
  */
186
186
  clientToken?: string;
187
187
  /**
188
- * @public
189
188
  * <p>The unique identifier for the FinSpace Dataset where the Changeset will be created.
190
189
  * </p>
190
+ * @public
191
191
  */
192
192
  datasetId: string | undefined;
193
193
  /**
194
- * @public
195
194
  * <p>The option to indicate how a Changeset will be applied to a Dataset.</p>
196
195
  * <ul>
197
196
  * <li>
@@ -209,10 +208,10 @@ export interface CreateChangesetRequest {
209
208
  * <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
210
209
  * </li>
211
210
  * </ul>
211
+ * @public
212
212
  */
213
213
  changeType: ChangeType | undefined;
214
214
  /**
215
- * @public
216
215
  * <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
217
216
  * <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
218
217
  * <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
@@ -226,10 +225,10 @@ export interface CreateChangesetRequest {
226
225
  * </code>
227
226
  * </p>
228
227
  * <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a> section.</p>
228
+ * @public
229
229
  */
230
230
  sourceParams: Record<string, string> | undefined;
231
231
  /**
232
- * @public
233
232
  * <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>).
234
233
  * </p>
235
234
  * <p>
@@ -275,28 +274,29 @@ export interface CreateChangesetRequest {
275
274
  * </code>
276
275
  * </p>
277
276
  * <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
277
+ * @public
278
278
  */
279
279
  formatParams: Record<string, string> | undefined;
280
280
  }
281
281
  /**
282
- * @public
283
282
  * The response from a CreateChangeset operation.
283
+ * @public
284
284
  */
285
285
  export interface CreateChangesetResponse {
286
286
  /**
287
- * @public
288
287
  * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
288
+ * @public
289
289
  */
290
290
  datasetId?: string;
291
291
  /**
292
- * @public
293
292
  * <p>The unique identifier of the Changeset that is created.</p>
293
+ * @public
294
294
  */
295
295
  changesetId?: string;
296
296
  }
297
297
  /**
298
- * @public
299
298
  * <p>A limit has exceeded.</p>
299
+ * @public
300
300
  */
301
301
  export declare class LimitExceededException extends __BaseException {
302
302
  readonly name: "LimitExceededException";
@@ -319,28 +319,27 @@ export declare const DatasetKind: {
319
319
  */
320
320
  export type DatasetKind = (typeof DatasetKind)[keyof typeof DatasetKind];
321
321
  /**
322
- * @public
323
322
  * <p>A structure for Dataset owner info.</p>
323
+ * @public
324
324
  */
325
325
  export interface DatasetOwnerInfo {
326
326
  /**
327
- * @public
328
327
  * <p>The name of the Dataset owner.</p>
328
+ * @public
329
329
  */
330
330
  name?: string;
331
331
  /**
332
- * @public
333
332
  * <p>Phone number for the Dataset owner.</p>
333
+ * @public
334
334
  */
335
335
  phoneNumber?: string;
336
336
  /**
337
- * @public
338
337
  * <p>Email address for the Dataset owner.</p>
338
+ * @public
339
339
  */
340
340
  email?: string;
341
341
  }
342
342
  /**
343
- * @public
344
343
  * <p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p>
345
344
  * <p>The following is a list of valid dataset permissions that you can apply:
346
345
  *
@@ -378,16 +377,16 @@ export interface DatasetOwnerInfo {
378
377
  * </li>
379
378
  * </ul>
380
379
  * <p>For more information on the dataset permissions, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>
380
+ * @public
381
381
  */
382
382
  export interface ResourcePermission {
383
383
  /**
384
- * @public
385
384
  * <p>Permission for a resource.</p>
385
+ * @public
386
386
  */
387
387
  permission?: string;
388
388
  }
389
389
  /**
390
- * @public
391
390
  * <p>Permission group parameters for Dataset permissions.</p>
392
391
  * <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p>
393
392
  * <p>
@@ -403,16 +402,17 @@ export interface ResourcePermission {
403
402
  * \}
404
403
  * </code>
405
404
  * </p>
405
+ * @public
406
406
  */
407
407
  export interface PermissionGroupParams {
408
408
  /**
409
- * @public
410
409
  * <p>The unique identifier for the <code>PermissionGroup</code>.</p>
410
+ * @public
411
411
  */
412
412
  permissionGroupId?: string;
413
413
  /**
414
- * @public
415
414
  * <p>List of resource permissions.</p>
415
+ * @public
416
416
  */
417
417
  datasetPermissions?: ResourcePermission[];
418
418
  }
@@ -439,12 +439,11 @@ export declare const ColumnDataType: {
439
439
  */
440
440
  export type ColumnDataType = (typeof ColumnDataType)[keyof typeof ColumnDataType];
441
441
  /**
442
- * @public
443
442
  * <p>The definition of a column in a tabular Dataset.</p>
443
+ * @public
444
444
  */
445
445
  export interface ColumnDefinition {
446
446
  /**
447
- * @public
448
447
  * <p>Data type of a column.</p>
449
448
  * <ul>
450
449
  * <li>
@@ -474,63 +473,63 @@ export interface ColumnDefinition {
474
473
  * <code>BINARY</code> – A binary data type.</p>
475
474
  * </li>
476
475
  * </ul>
476
+ * @public
477
477
  */
478
478
  dataType?: ColumnDataType;
479
479
  /**
480
- * @public
481
480
  * <p>The name of a column.</p>
481
+ * @public
482
482
  */
483
483
  columnName?: string;
484
484
  /**
485
- * @public
486
485
  * <p>Description for a column.</p>
486
+ * @public
487
487
  */
488
488
  columnDescription?: string;
489
489
  }
490
490
  /**
491
- * @public
492
491
  * <p>Definition for a schema on a tabular Dataset.</p>
492
+ * @public
493
493
  */
494
494
  export interface SchemaDefinition {
495
495
  /**
496
- * @public
497
496
  * <p>List of column definitions.</p>
497
+ * @public
498
498
  */
499
499
  columns?: ColumnDefinition[];
500
500
  /**
501
- * @public
502
501
  * <p>List of column names used for primary key.</p>
502
+ * @public
503
503
  */
504
504
  primaryKeyColumns?: string[];
505
505
  }
506
506
  /**
507
- * @public
508
507
  * <p>A union of schema types.</p>
508
+ * @public
509
509
  */
510
510
  export interface SchemaUnion {
511
511
  /**
512
- * @public
513
512
  * <p>The configuration for a schema on a tabular Dataset.</p>
513
+ * @public
514
514
  */
515
515
  tabularSchemaConfig?: SchemaDefinition;
516
516
  }
517
517
  /**
518
- * @public
519
518
  * The request for a CreateDataset operation
519
+ * @public
520
520
  */
521
521
  export interface CreateDatasetRequest {
522
522
  /**
523
- * @public
524
523
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
524
+ * @public
525
525
  */
526
526
  clientToken?: string;
527
527
  /**
528
- * @public
529
528
  * <p>Display title for a FinSpace Dataset.</p>
529
+ * @public
530
530
  */
531
531
  datasetTitle: string | undefined;
532
532
  /**
533
- * @public
534
533
  * <p>The format in which Dataset data is structured.</p>
535
534
  * <ul>
536
535
  * <li>
@@ -542,42 +541,43 @@ export interface CreateDatasetRequest {
542
541
  * <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
543
542
  * </li>
544
543
  * </ul>
544
+ * @public
545
545
  */
546
546
  kind: DatasetKind | undefined;
547
547
  /**
548
- * @public
549
548
  * <p>Description of a Dataset.</p>
549
+ * @public
550
550
  */
551
551
  datasetDescription?: string;
552
552
  /**
553
- * @public
554
553
  * <p>Contact information for a Dataset owner.</p>
554
+ * @public
555
555
  */
556
556
  ownerInfo?: DatasetOwnerInfo;
557
557
  /**
558
- * @public
559
558
  * <p>Permission group parameters for Dataset permissions.</p>
559
+ * @public
560
560
  */
561
561
  permissionGroupParams: PermissionGroupParams | undefined;
562
562
  /**
563
- * @public
564
563
  * <p>The unique resource identifier for a Dataset.</p>
564
+ * @public
565
565
  */
566
566
  alias?: string;
567
567
  /**
568
- * @public
569
568
  * <p>Definition for a schema on a tabular Dataset.</p>
569
+ * @public
570
570
  */
571
571
  schemaDefinition?: SchemaUnion;
572
572
  }
573
573
  /**
574
- * @public
575
574
  * The response from a CreateDataset operation
575
+ * @public
576
576
  */
577
577
  export interface CreateDatasetResponse {
578
578
  /**
579
- * @public
580
579
  * <p>The unique identifier for the created Dataset.</p>
580
+ * @public
581
581
  */
582
582
  datasetId?: string;
583
583
  }
@@ -594,12 +594,11 @@ export declare const ExportFileFormat: {
594
594
  */
595
595
  export type ExportFileFormat = (typeof ExportFileFormat)[keyof typeof ExportFileFormat];
596
596
  /**
597
- * @public
598
597
  * <p>Structure for the Dataview destination type parameters.</p>
598
+ * @public
599
599
  */
600
600
  export interface DataViewDestinationTypeParams {
601
601
  /**
602
- * @public
603
602
  * <p>Destination type for a Dataview.</p>
604
603
  * <ul>
605
604
  * <li>
@@ -611,10 +610,10 @@ export interface DataViewDestinationTypeParams {
611
610
  * <code>S3</code> – S3 destination type.</p>
612
611
  * </li>
613
612
  * </ul>
613
+ * @public
614
614
  */
615
615
  destinationType: string | undefined;
616
616
  /**
617
- * @public
618
617
  * <p>Dataview export file format.</p>
619
618
  * <ul>
620
619
  * <li>
@@ -626,10 +625,10 @@ export interface DataViewDestinationTypeParams {
626
625
  * <code>DELIMITED_TEXT</code> – Delimited text export file format.</p>
627
626
  * </li>
628
627
  * </ul>
628
+ * @public
629
629
  */
630
630
  s3DestinationExportFileFormat?: ExportFileFormat;
631
631
  /**
632
- * @public
633
632
  * <p>Format Options for S3 Destination type.</p>
634
633
  * <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code>
635
634
  * </p>
@@ -641,63 +640,64 @@ export interface DataViewDestinationTypeParams {
641
640
  * "compression": "gzip"
642
641
  * \}</code>
643
642
  * </p>
643
+ * @public
644
644
  */
645
645
  s3DestinationExportFileFormatOptions?: Record<string, string>;
646
646
  }
647
647
  /**
648
- * @public
649
648
  * Request for creating a data view.
649
+ * @public
650
650
  */
651
651
  export interface CreateDataViewRequest {
652
652
  /**
653
- * @public
654
653
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
654
+ * @public
655
655
  */
656
656
  clientToken?: string;
657
657
  /**
658
- * @public
659
658
  * <p>The unique Dataset identifier that is used to create a Dataview.</p>
659
+ * @public
660
660
  */
661
661
  datasetId: string | undefined;
662
662
  /**
663
- * @public
664
663
  * <p>Flag to indicate Dataview should be updated automatically.</p>
664
+ * @public
665
665
  */
666
666
  autoUpdate?: boolean;
667
667
  /**
668
- * @public
669
668
  * <p>Columns to be used for sorting the data.</p>
669
+ * @public
670
670
  */
671
671
  sortColumns?: string[];
672
672
  /**
673
- * @public
674
673
  * <p>Ordered set of column names used to partition data.</p>
674
+ * @public
675
675
  */
676
676
  partitionColumns?: string[];
677
677
  /**
678
- * @public
679
678
  * <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>
679
+ * @public
680
680
  */
681
681
  asOfTimestamp?: number;
682
682
  /**
683
- * @public
684
683
  * <p>Options that define the destination type for the Dataview.</p>
684
+ * @public
685
685
  */
686
686
  destinationTypeParams: DataViewDestinationTypeParams | undefined;
687
687
  }
688
688
  /**
689
- * @public
690
689
  * Response for creating a data view.
690
+ * @public
691
691
  */
692
692
  export interface CreateDataViewResponse {
693
693
  /**
694
- * @public
695
694
  * <p>The unique identifier of the Dataset used for the Dataview.</p>
695
+ * @public
696
696
  */
697
697
  datasetId?: string;
698
698
  /**
699
- * @public
700
699
  * <p>The unique identifier for the created Dataview.</p>
700
+ * @public
701
701
  */
702
702
  dataViewId?: string;
703
703
  }
@@ -706,17 +706,16 @@ export interface CreateDataViewResponse {
706
706
  */
707
707
  export interface CreatePermissionGroupRequest {
708
708
  /**
709
- * @public
710
709
  * <p>The name of the permission group.</p>
710
+ * @public
711
711
  */
712
712
  name: string | undefined;
713
713
  /**
714
- * @public
715
714
  * <p>A brief description for the permission group.</p>
715
+ * @public
716
716
  */
717
717
  description?: string;
718
718
  /**
719
- * @public
720
719
  * <p>The option to indicate FinSpace application permissions that are granted to a specific group.</p>
721
720
  * <important>
722
721
  * <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>
@@ -751,11 +750,12 @@ export interface CreatePermissionGroupRequest {
751
750
  * <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
752
751
  * </li>
753
752
  * </ul>
753
+ * @public
754
754
  */
755
755
  applicationPermissions: ApplicationPermission[] | undefined;
756
756
  /**
757
- * @public
758
757
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
758
+ * @public
759
759
  */
760
760
  clientToken?: string;
761
761
  }
@@ -764,8 +764,8 @@ export interface CreatePermissionGroupRequest {
764
764
  */
765
765
  export interface CreatePermissionGroupResponse {
766
766
  /**
767
- * @public
768
767
  * <p>The unique identifier for the permission group.</p>
768
+ * @public
769
769
  */
770
770
  permissionGroupId?: string;
771
771
  }
@@ -786,12 +786,11 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
786
786
  */
787
787
  export interface CreateUserRequest {
788
788
  /**
789
- * @public
790
789
  * <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>
790
+ * @public
791
791
  */
792
792
  emailAddress: string | undefined;
793
793
  /**
794
- * @public
795
794
  * <p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p>
796
795
  * <ul>
797
796
  * <li>
@@ -803,20 +802,20 @@ export interface CreateUserRequest {
803
802
  * <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
804
803
  * </li>
805
804
  * </ul>
805
+ * @public
806
806
  */
807
807
  type: UserType | undefined;
808
808
  /**
809
- * @public
810
809
  * <p>The first name of the user that you want to register.</p>
810
+ * @public
811
811
  */
812
812
  firstName?: string;
813
813
  /**
814
- * @public
815
814
  * <p>The last name of the user that you want to register.</p>
815
+ * @public
816
816
  */
817
817
  lastName?: string;
818
818
  /**
819
- * @public
820
819
  * <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>
821
820
  * <ul>
822
821
  * <li>
@@ -828,16 +827,17 @@ export interface CreateUserRequest {
828
827
  * <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
829
828
  * </li>
830
829
  * </ul>
830
+ * @public
831
831
  */
832
832
  apiAccess?: ApiAccess;
833
833
  /**
834
- * @public
835
834
  * <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>
835
+ * @public
836
836
  */
837
837
  apiAccessPrincipalArn?: string;
838
838
  /**
839
- * @public
840
839
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
840
+ * @public
841
841
  */
842
842
  clientToken?: string;
843
843
  }
@@ -846,35 +846,35 @@ export interface CreateUserRequest {
846
846
  */
847
847
  export interface CreateUserResponse {
848
848
  /**
849
- * @public
850
849
  * <p>The unique identifier for the user.</p>
850
+ * @public
851
851
  */
852
852
  userId?: string;
853
853
  }
854
854
  /**
855
- * @public
856
855
  * The request for a DeleteDataset operation.
856
+ * @public
857
857
  */
858
858
  export interface DeleteDatasetRequest {
859
859
  /**
860
- * @public
861
860
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
861
+ * @public
862
862
  */
863
863
  clientToken?: string;
864
864
  /**
865
- * @public
866
865
  * <p>The unique identifier of the Dataset to be deleted.</p>
866
+ * @public
867
867
  */
868
868
  datasetId: string | undefined;
869
869
  }
870
870
  /**
871
- * @public
872
871
  * The response from an DeleteDataset operation
872
+ * @public
873
873
  */
874
874
  export interface DeleteDatasetResponse {
875
875
  /**
876
- * @public
877
876
  * <p>The unique identifier for the deleted Dataset.</p>
877
+ * @public
878
878
  */
879
879
  datasetId?: string;
880
880
  }
@@ -883,13 +883,13 @@ export interface DeleteDatasetResponse {
883
883
  */
884
884
  export interface DeletePermissionGroupRequest {
885
885
  /**
886
- * @public
887
886
  * <p>The unique identifier for the permission group that you want to delete.</p>
887
+ * @public
888
888
  */
889
889
  permissionGroupId: string | undefined;
890
890
  /**
891
- * @public
892
891
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
892
+ * @public
893
893
  */
894
894
  clientToken?: string;
895
895
  }
@@ -898,8 +898,8 @@ export interface DeletePermissionGroupRequest {
898
898
  */
899
899
  export interface DeletePermissionGroupResponse {
900
900
  /**
901
- * @public
902
901
  * <p>The unique identifier for the deleted permission group.</p>
902
+ * @public
903
903
  */
904
904
  permissionGroupId?: string;
905
905
  }
@@ -908,13 +908,13 @@ export interface DeletePermissionGroupResponse {
908
908
  */
909
909
  export interface DisableUserRequest {
910
910
  /**
911
- * @public
912
911
  * <p>The unique identifier for the user that you want to deactivate.</p>
912
+ * @public
913
913
  */
914
914
  userId: string | undefined;
915
915
  /**
916
- * @public
917
916
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
917
+ * @public
918
918
  */
919
919
  clientToken?: string;
920
920
  }
@@ -923,8 +923,8 @@ export interface DisableUserRequest {
923
923
  */
924
924
  export interface DisableUserResponse {
925
925
  /**
926
- * @public
927
926
  * <p>The unique identifier for the deactivated user.</p>
927
+ * @public
928
928
  */
929
929
  userId?: string;
930
930
  }
@@ -933,18 +933,18 @@ export interface DisableUserResponse {
933
933
  */
934
934
  export interface DisassociateUserFromPermissionGroupRequest {
935
935
  /**
936
- * @public
937
936
  * <p>The unique identifier for the permission group.</p>
937
+ * @public
938
938
  */
939
939
  permissionGroupId: string | undefined;
940
940
  /**
941
- * @public
942
941
  * <p>The unique identifier for the user.</p>
942
+ * @public
943
943
  */
944
944
  userId: string | undefined;
945
945
  /**
946
- * @public
947
946
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
947
+ * @public
948
948
  */
949
949
  clientToken?: string;
950
950
  }
@@ -953,8 +953,8 @@ export interface DisassociateUserFromPermissionGroupRequest {
953
953
  */
954
954
  export interface DisassociateUserFromPermissionGroupResponse {
955
955
  /**
956
- * @public
957
956
  * <p>The returned status code of the response.</p>
957
+ * @public
958
958
  */
959
959
  statusCode?: number;
960
960
  }
@@ -963,13 +963,13 @@ export interface DisassociateUserFromPermissionGroupResponse {
963
963
  */
964
964
  export interface EnableUserRequest {
965
965
  /**
966
- * @public
967
966
  * <p>The unique identifier for the user that you want to activate.</p>
967
+ * @public
968
968
  */
969
969
  userId: string | undefined;
970
970
  /**
971
- * @public
972
971
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
972
+ * @public
973
973
  */
974
974
  clientToken?: string;
975
975
  }
@@ -978,24 +978,24 @@ export interface EnableUserRequest {
978
978
  */
979
979
  export interface EnableUserResponse {
980
980
  /**
981
- * @public
982
981
  * <p>The unique identifier for the active user.</p>
982
+ * @public
983
983
  */
984
984
  userId?: string;
985
985
  }
986
986
  /**
987
- * @public
988
987
  * Request to describe a changeset.
988
+ * @public
989
989
  */
990
990
  export interface GetChangesetRequest {
991
991
  /**
992
- * @public
993
992
  * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
993
+ * @public
994
994
  */
995
995
  datasetId: string | undefined;
996
996
  /**
997
- * @public
998
997
  * <p>The unique identifier of the Changeset for which to get data.</p>
998
+ * @public
999
999
  */
1000
1000
  changesetId: string | undefined;
1001
1001
  }
@@ -1018,17 +1018,16 @@ export declare const ErrorCategory: {
1018
1018
  */
1019
1019
  export type ErrorCategory = (typeof ErrorCategory)[keyof typeof ErrorCategory];
1020
1020
  /**
1021
- * @public
1022
1021
  * <p>The structure with error messages.</p>
1022
+ * @public
1023
1023
  */
1024
1024
  export interface ChangesetErrorInfo {
1025
1025
  /**
1026
- * @public
1027
1026
  * <p>The text of the error message.</p>
1027
+ * @public
1028
1028
  */
1029
1029
  errorMessage?: string;
1030
1030
  /**
1031
- * @public
1032
1031
  * <p>The category of the error.</p>
1033
1032
  * <ul>
1034
1033
  * <li>
@@ -1069,6 +1068,7 @@ export interface ChangesetErrorInfo {
1069
1068
  * <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p>
1070
1069
  * </li>
1071
1070
  * </ul>
1071
+ * @public
1072
1072
  */
1073
1073
  errorCategory?: ErrorCategory;
1074
1074
  }
@@ -1088,27 +1088,26 @@ export declare const IngestionStatus: {
1088
1088
  */
1089
1089
  export type IngestionStatus = (typeof IngestionStatus)[keyof typeof IngestionStatus];
1090
1090
  /**
1091
- * @public
1092
1091
  * The response from a describe changeset operation
1092
+ * @public
1093
1093
  */
1094
1094
  export interface GetChangesetResponse {
1095
1095
  /**
1096
- * @public
1097
1096
  * <p>The unique identifier for a Changeset.</p>
1097
+ * @public
1098
1098
  */
1099
1099
  changesetId?: string;
1100
1100
  /**
1101
- * @public
1102
1101
  * <p>The ARN identifier of the Changeset.</p>
1102
+ * @public
1103
1103
  */
1104
1104
  changesetArn?: string;
1105
1105
  /**
1106
- * @public
1107
1106
  * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
1107
+ * @public
1108
1108
  */
1109
1109
  datasetId?: string;
1110
1110
  /**
1111
- * @public
1112
1111
  * <p>Type that indicates how a Changeset is applied to a Dataset.</p>
1113
1112
  * <ul>
1114
1113
  * <li>
@@ -1124,62 +1123,63 @@ export interface GetChangesetResponse {
1124
1123
  * <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
1125
1124
  * </li>
1126
1125
  * </ul>
1126
+ * @public
1127
1127
  */
1128
1128
  changeType?: ChangeType;
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>Options that define the location of the data being ingested.</p>
1131
+ * @public
1132
1132
  */
1133
1133
  sourceParams?: Record<string, string>;
1134
1134
  /**
1135
- * @public
1136
1135
  * <p>Structure of the source file(s).</p>
1136
+ * @public
1137
1137
  */
1138
1138
  formatParams?: Record<string, string>;
1139
1139
  /**
1140
- * @public
1141
1140
  * <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>
1141
+ * @public
1142
1142
  */
1143
1143
  createTime?: number;
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>The status of Changeset creation operation.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  status?: IngestionStatus;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>The structure with error messages.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  errorInfo?: ChangesetErrorInfo;
1154
1154
  /**
1155
- * @public
1156
1155
  * <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>
1156
+ * @public
1157
1157
  */
1158
1158
  activeUntilTimestamp?: number;
1159
1159
  /**
1160
- * @public
1161
1160
  * <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>
1161
+ * @public
1162
1162
  */
1163
1163
  activeFromTimestamp?: number;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The unique identifier of the Changeset that is being updated.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  updatesChangesetId?: string;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The unique identifier of the updated Changeset.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  updatedByChangesetId?: string;
1174
1174
  }
1175
1175
  /**
1176
- * @public
1177
1176
  * Request for the GetDataset operation.
1177
+ * @public
1178
1178
  */
1179
1179
  export interface GetDatasetRequest {
1180
1180
  /**
1181
- * @public
1182
1181
  * <p>The unique identifier for a Dataset.</p>
1182
+ * @public
1183
1183
  */
1184
1184
  datasetId: string | undefined;
1185
1185
  }
@@ -1198,27 +1198,26 @@ export declare const DatasetStatus: {
1198
1198
  */
1199
1199
  export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
1200
1200
  /**
1201
- * @public
1202
1201
  * Response for the GetDataset operation
1202
+ * @public
1203
1203
  */
1204
1204
  export interface GetDatasetResponse {
1205
1205
  /**
1206
- * @public
1207
1206
  * <p>The unique identifier for a Dataset.</p>
1207
+ * @public
1208
1208
  */
1209
1209
  datasetId?: string;
1210
1210
  /**
1211
- * @public
1212
1211
  * <p>The ARN identifier of the Dataset.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  datasetArn?: string;
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>Display title for a Dataset.</p>
1217
+ * @public
1218
1218
  */
1219
1219
  datasetTitle?: string;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The format in which Dataset data is structured.</p>
1223
1222
  * <ul>
1224
1223
  * <li>
@@ -1230,35 +1229,35 @@ export interface GetDatasetResponse {
1230
1229
  * <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
1231
1230
  * </li>
1232
1231
  * </ul>
1232
+ * @public
1233
1233
  */
1234
1234
  kind?: DatasetKind;
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>A description of the Dataset.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  datasetDescription?: string;
1240
1240
  /**
1241
- * @public
1242
1241
  * <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>
1242
+ * @public
1243
1243
  */
1244
1244
  createTime?: number;
1245
1245
  /**
1246
- * @public
1247
1246
  * <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>
1247
+ * @public
1248
1248
  */
1249
1249
  lastModifiedTime?: number;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>Definition for a schema on a tabular Dataset.</p>
1252
+ * @public
1253
1253
  */
1254
1254
  schemaDefinition?: SchemaUnion;
1255
1255
  /**
1256
- * @public
1257
1256
  * <p>The unique resource identifier for a Dataset.</p>
1257
+ * @public
1258
1258
  */
1259
1259
  alias?: string;
1260
1260
  /**
1261
- * @public
1262
1261
  * <p>Status of the Dataset creation.</p>
1263
1262
  * <ul>
1264
1263
  * <li>
@@ -1278,37 +1277,37 @@ export interface GetDatasetResponse {
1278
1277
  * <code>RUNNING</code> – Dataset creation is running.</p>
1279
1278
  * </li>
1280
1279
  * </ul>
1280
+ * @public
1281
1281
  */
1282
1282
  status?: DatasetStatus;
1283
1283
  }
1284
1284
  /**
1285
- * @public
1286
1285
  * Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
1286
+ * @public
1287
1287
  */
1288
1288
  export interface GetDataViewRequest {
1289
1289
  /**
1290
- * @public
1291
1290
  * <p>The unique identifier for the Dataview.</p>
1291
+ * @public
1292
1292
  */
1293
1293
  dataViewId: string | undefined;
1294
1294
  /**
1295
- * @public
1296
1295
  * <p>The unique identifier for the Dataset used in the Dataview.</p>
1296
+ * @public
1297
1297
  */
1298
1298
  datasetId: string | undefined;
1299
1299
  }
1300
1300
  /**
1301
- * @public
1302
1301
  * <p>The structure with error messages.</p>
1302
+ * @public
1303
1303
  */
1304
1304
  export interface DataViewErrorInfo {
1305
1305
  /**
1306
- * @public
1307
1306
  * <p>The text of the error message.</p>
1307
+ * @public
1308
1308
  */
1309
1309
  errorMessage?: string;
1310
1310
  /**
1311
- * @public
1312
1311
  * <p>The category of the error.</p>
1313
1312
  * <ul>
1314
1313
  * <li>
@@ -1349,6 +1348,7 @@ export interface DataViewErrorInfo {
1349
1348
  * <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p>
1350
1349
  * </li>
1351
1350
  * </ul>
1351
+ * @public
1352
1352
  */
1353
1353
  errorCategory?: ErrorCategory;
1354
1354
  }
@@ -1371,67 +1371,66 @@ export declare const DataViewStatus: {
1371
1371
  */
1372
1372
  export type DataViewStatus = (typeof DataViewStatus)[keyof typeof DataViewStatus];
1373
1373
  /**
1374
- * @public
1375
1374
  * Response from retrieving a dataview, which includes details on the target database and table name
1375
+ * @public
1376
1376
  */
1377
1377
  export interface GetDataViewResponse {
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>Flag to indicate Dataview should be updated automatically.</p>
1380
+ * @public
1381
1381
  */
1382
1382
  autoUpdate?: boolean;
1383
1383
  /**
1384
- * @public
1385
1384
  * <p>Ordered set of column names used to partition data.</p>
1385
+ * @public
1386
1386
  */
1387
1387
  partitionColumns?: string[];
1388
1388
  /**
1389
- * @public
1390
1389
  * <p>The unique identifier for the Dataset used in the Dataview.</p>
1390
+ * @public
1391
1391
  */
1392
1392
  datasetId?: string;
1393
1393
  /**
1394
- * @public
1395
1394
  * <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>
1395
+ * @public
1396
1396
  */
1397
1397
  asOfTimestamp?: number;
1398
1398
  /**
1399
- * @public
1400
1399
  * <p>Information about an error that occurred for the Dataview.</p>
1400
+ * @public
1401
1401
  */
1402
1402
  errorInfo?: DataViewErrorInfo;
1403
1403
  /**
1404
- * @public
1405
1404
  * <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>
1405
+ * @public
1406
1406
  */
1407
1407
  lastModifiedTime?: number;
1408
1408
  /**
1409
- * @public
1410
1409
  * <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>
1410
+ * @public
1411
1411
  */
1412
1412
  createTime?: number;
1413
1413
  /**
1414
- * @public
1415
1414
  * <p>Columns to be used for sorting the data.</p>
1415
+ * @public
1416
1416
  */
1417
1417
  sortColumns?: string[];
1418
1418
  /**
1419
- * @public
1420
1419
  * <p>The unique identifier for the Dataview.</p>
1420
+ * @public
1421
1421
  */
1422
1422
  dataViewId?: string;
1423
1423
  /**
1424
- * @public
1425
1424
  * <p>The ARN identifier of the Dataview.</p>
1425
+ * @public
1426
1426
  */
1427
1427
  dataViewArn?: string;
1428
1428
  /**
1429
- * @public
1430
1429
  * <p>Options that define the destination type for the Dataview.</p>
1430
+ * @public
1431
1431
  */
1432
1432
  destinationTypeParams?: DataViewDestinationTypeParams;
1433
1433
  /**
1434
- * @public
1435
1434
  * <p>The status of a Dataview creation.</p>
1436
1435
  * <ul>
1437
1436
  * <li>
@@ -1467,6 +1466,7 @@ export interface GetDataViewResponse {
1467
1466
  * <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p>
1468
1467
  * </li>
1469
1468
  * </ul>
1469
+ * @public
1470
1470
  */
1471
1471
  status?: DataViewStatus;
1472
1472
  }
@@ -1475,29 +1475,29 @@ export interface GetDataViewResponse {
1475
1475
  */
1476
1476
  export interface GetExternalDataViewAccessDetailsRequest {
1477
1477
  /**
1478
- * @public
1479
1478
  * <p>The unique identifier for the Dataview that you want to access.</p>
1479
+ * @public
1480
1480
  */
1481
1481
  dataViewId: string | undefined;
1482
1482
  /**
1483
- * @public
1484
1483
  * <p>The unique identifier for the Dataset.</p>
1484
+ * @public
1485
1485
  */
1486
1486
  datasetId: string | undefined;
1487
1487
  }
1488
1488
  /**
1489
- * @public
1490
1489
  * <p>The location of an external Dataview in an S3 bucket.</p>
1490
+ * @public
1491
1491
  */
1492
1492
  export interface S3Location {
1493
1493
  /**
1494
- * @public
1495
1494
  * <p> The name of the S3 bucket.</p>
1495
+ * @public
1496
1496
  */
1497
1497
  bucket: string | undefined;
1498
1498
  /**
1499
- * @public
1500
1499
  * <p> The path of the folder, within the S3 bucket that contains the Dataset.</p>
1500
+ * @public
1501
1501
  */
1502
1502
  key: string | undefined;
1503
1503
  }
@@ -1506,13 +1506,13 @@ export interface S3Location {
1506
1506
  */
1507
1507
  export interface GetExternalDataViewAccessDetailsResponse {
1508
1508
  /**
1509
- * @public
1510
1509
  * <p>The credentials required to access the external Dataview from the S3 location.</p>
1510
+ * @public
1511
1511
  */
1512
1512
  credentials?: AwsCredentials;
1513
1513
  /**
1514
- * @public
1515
1514
  * <p>The location where the external Dataview is stored.</p>
1515
+ * @public
1516
1516
  */
1517
1517
  s3Location?: S3Location;
1518
1518
  }
@@ -1521,8 +1521,8 @@ export interface GetExternalDataViewAccessDetailsResponse {
1521
1521
  */
1522
1522
  export interface GetPermissionGroupRequest {
1523
1523
  /**
1524
- * @public
1525
1524
  * <p>The unique identifier for the permission group.</p>
1525
+ * @public
1526
1526
  */
1527
1527
  permissionGroupId: string | undefined;
1528
1528
  }
@@ -1540,27 +1540,26 @@ export declare const PermissionGroupMembershipStatus: {
1540
1540
  */
1541
1541
  export type PermissionGroupMembershipStatus = (typeof PermissionGroupMembershipStatus)[keyof typeof PermissionGroupMembershipStatus];
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>The structure for a permission group.</p>
1544
+ * @public
1545
1545
  */
1546
1546
  export interface PermissionGroup {
1547
1547
  /**
1548
- * @public
1549
1548
  * <p> The unique identifier for the permission group.</p>
1549
+ * @public
1550
1550
  */
1551
1551
  permissionGroupId?: string;
1552
1552
  /**
1553
- * @public
1554
1553
  * <p>The name of the permission group.</p>
1554
+ * @public
1555
1555
  */
1556
1556
  name?: string;
1557
1557
  /**
1558
- * @public
1559
1558
  * <p> A brief description for the permission group.</p>
1559
+ * @public
1560
1560
  */
1561
1561
  description?: string;
1562
1562
  /**
1563
- * @public
1564
1563
  * <p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p>
1565
1564
  * <important>
1566
1565
  * <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>
@@ -1595,22 +1594,22 @@ export interface PermissionGroup {
1595
1594
  * <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
1596
1595
  * </li>
1597
1596
  * </ul>
1597
+ * @public
1598
1598
  */
1599
1599
  applicationPermissions?: ApplicationPermission[];
1600
1600
  /**
1601
- * @public
1602
1601
  * <p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
1603
1602
  * </p>
1603
+ * @public
1604
1604
  */
1605
1605
  createTime?: number;
1606
1606
  /**
1607
- * @public
1608
1607
  * <p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
1609
1608
  * </p>
1609
+ * @public
1610
1610
  */
1611
1611
  lastModifiedTime?: number;
1612
1612
  /**
1613
- * @public
1614
1613
  * <p>Indicates the status of the user within a permission group.</p>
1615
1614
  * <ul>
1616
1615
  * <li>
@@ -1626,6 +1625,7 @@ export interface PermissionGroup {
1626
1625
  * <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p>
1627
1626
  * </li>
1628
1627
  * </ul>
1628
+ * @public
1629
1629
  */
1630
1630
  membershipStatus?: PermissionGroupMembershipStatus;
1631
1631
  }
@@ -1634,61 +1634,61 @@ export interface PermissionGroup {
1634
1634
  */
1635
1635
  export interface GetPermissionGroupResponse {
1636
1636
  /**
1637
- * @public
1638
1637
  * <p>The structure for a permission group.</p>
1638
+ * @public
1639
1639
  */
1640
1640
  permissionGroup?: PermissionGroup;
1641
1641
  }
1642
1642
  /**
1643
- * @public
1644
1643
  * Request for GetProgrammaticAccessCredentials operation
1644
+ * @public
1645
1645
  */
1646
1646
  export interface GetProgrammaticAccessCredentialsRequest {
1647
1647
  /**
1648
- * @public
1649
1648
  * <p>The time duration in which the credentials remain valid. </p>
1649
+ * @public
1650
1650
  */
1651
1651
  durationInMinutes?: number;
1652
1652
  /**
1653
- * @public
1654
1653
  * <p>The FinSpace environment identifier.</p>
1654
+ * @public
1655
1655
  */
1656
1656
  environmentId: string | undefined;
1657
1657
  }
1658
1658
  /**
1659
- * @public
1660
1659
  * <p>Short term API credentials.</p>
1660
+ * @public
1661
1661
  */
1662
1662
  export interface Credentials {
1663
1663
  /**
1664
- * @public
1665
1664
  * <p>The access key identifier.</p>
1665
+ * @public
1666
1666
  */
1667
1667
  accessKeyId?: string;
1668
1668
  /**
1669
- * @public
1670
1669
  * <p>The access key.</p>
1670
+ * @public
1671
1671
  */
1672
1672
  secretAccessKey?: string;
1673
1673
  /**
1674
- * @public
1675
1674
  * <p>The session token.</p>
1675
+ * @public
1676
1676
  */
1677
1677
  sessionToken?: string;
1678
1678
  }
1679
1679
  /**
1680
- * @public
1681
1680
  * Response for GetProgrammaticAccessCredentials operation
1681
+ * @public
1682
1682
  */
1683
1683
  export interface GetProgrammaticAccessCredentialsResponse {
1684
1684
  /**
1685
- * @public
1686
1685
  * <p>Returns the programmatic credentials.</p>
1686
+ * @public
1687
1687
  */
1688
1688
  credentials?: Credentials;
1689
1689
  /**
1690
- * @public
1691
1690
  * <p>Returns the duration in which the credentials will remain valid.</p>
1691
+ * @public
1692
1692
  */
1693
1693
  durationInMinutes?: number;
1694
1694
  }
@@ -1697,8 +1697,8 @@ export interface GetProgrammaticAccessCredentialsResponse {
1697
1697
  */
1698
1698
  export interface GetUserRequest {
1699
1699
  /**
1700
- * @public
1701
1700
  * <p>The unique identifier of the user to get data for.</p>
1701
+ * @public
1702
1702
  */
1703
1703
  userId: string | undefined;
1704
1704
  }
@@ -1720,12 +1720,11 @@ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
1720
1720
  */
1721
1721
  export interface GetUserResponse {
1722
1722
  /**
1723
- * @public
1724
1723
  * <p>The unique identifier for the user that is retrieved.</p>
1724
+ * @public
1725
1725
  */
1726
1726
  userId?: string;
1727
1727
  /**
1728
- * @public
1729
1728
  * <p>The current status of the user. </p>
1730
1729
  * <ul>
1731
1730
  * <li>
@@ -1741,25 +1740,25 @@ export interface GetUserResponse {
1741
1740
  * <code>DISABLED</code> – The user is currently inactive.</p>
1742
1741
  * </li>
1743
1742
  * </ul>
1743
+ * @public
1744
1744
  */
1745
1745
  status?: UserStatus;
1746
1746
  /**
1747
- * @public
1748
1747
  * <p>The first name of the user.</p>
1748
+ * @public
1749
1749
  */
1750
1750
  firstName?: string;
1751
1751
  /**
1752
- * @public
1753
1752
  * <p>The last name of the user.</p>
1753
+ * @public
1754
1754
  */
1755
1755
  lastName?: string;
1756
1756
  /**
1757
- * @public
1758
1757
  * <p>The email address that is associated with the user.</p>
1758
+ * @public
1759
1759
  */
1760
1760
  emailAddress?: string;
1761
1761
  /**
1762
- * @public
1763
1762
  * <p>Indicates the type of user. </p>
1764
1763
  * <ul>
1765
1764
  * <li>
@@ -1773,10 +1772,10 @@ export interface GetUserResponse {
1773
1772
  * <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
1774
1773
  * </li>
1775
1774
  * </ul>
1775
+ * @public
1776
1776
  */
1777
1777
  type?: UserType;
1778
1778
  /**
1779
- * @public
1780
1779
  * <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>
1781
1780
  * <ul>
1782
1781
  * <li>
@@ -1788,36 +1787,37 @@ export interface GetUserResponse {
1788
1787
  * <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
1789
1788
  * </li>
1790
1789
  * </ul>
1790
+ * @public
1791
1791
  */
1792
1792
  apiAccess?: ApiAccess;
1793
1793
  /**
1794
- * @public
1795
1794
  * <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>
1795
+ * @public
1796
1796
  */
1797
1797
  apiAccessPrincipalArn?: string;
1798
1798
  /**
1799
- * @public
1800
1799
  * <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
1800
+ * @public
1801
1801
  */
1802
1802
  createTime?: number;
1803
1803
  /**
1804
- * @public
1805
1804
  * <p>Describes the last time the user was activated. The value is determined as epoch time in milliseconds.</p>
1805
+ * @public
1806
1806
  */
1807
1807
  lastEnabledTime?: number;
1808
1808
  /**
1809
- * @public
1810
1809
  * <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
1810
+ * @public
1811
1811
  */
1812
1812
  lastDisabledTime?: number;
1813
1813
  /**
1814
- * @public
1815
1814
  * <p>Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.</p>
1815
+ * @public
1816
1816
  */
1817
1817
  lastModifiedTime?: number;
1818
1818
  /**
1819
- * @public
1820
1819
  * <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>
1820
+ * @public
1821
1821
  */
1822
1822
  lastLoginTime?: number;
1823
1823
  }
@@ -1838,7 +1838,6 @@ export type LocationType = (typeof LocationType)[keyof typeof LocationType];
1838
1838
  */
1839
1839
  export interface GetWorkingLocationRequest {
1840
1840
  /**
1841
- * @public
1842
1841
  * <p>Specify the type of the working location.</p>
1843
1842
  * <ul>
1844
1843
  * <li>
@@ -1852,6 +1851,7 @@ export interface GetWorkingLocationRequest {
1852
1851
  * data content and then use the location with the Changeset creation operation.</p>
1853
1852
  * </li>
1854
1853
  * </ul>
1854
+ * @public
1855
1855
  */
1856
1856
  locationType?: LocationType;
1857
1857
  }
@@ -1860,64 +1860,63 @@ export interface GetWorkingLocationRequest {
1860
1860
  */
1861
1861
  export interface GetWorkingLocationResponse {
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>Returns the Amazon S3 URI for the working location.</p>
1864
+ * @public
1865
1865
  */
1866
1866
  s3Uri?: string;
1867
1867
  /**
1868
- * @public
1869
1868
  * <p>Returns the Amazon S3 Path for the working location.</p>
1869
+ * @public
1870
1870
  */
1871
1871
  s3Path?: string;
1872
1872
  /**
1873
- * @public
1874
1873
  * <p>Returns the Amazon S3 bucket name for the working location.</p>
1874
+ * @public
1875
1875
  */
1876
1876
  s3Bucket?: string;
1877
1877
  }
1878
1878
  /**
1879
- * @public
1880
1879
  * Request to ListChangesetsRequest. It exposes minimal query filters.
1880
+ * @public
1881
1881
  */
1882
1882
  export interface ListChangesetsRequest {
1883
1883
  /**
1884
- * @public
1885
1884
  * <p>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</p>
1885
+ * @public
1886
1886
  */
1887
1887
  datasetId: string | undefined;
1888
1888
  /**
1889
- * @public
1890
1889
  * <p>The maximum number of results per page.</p>
1890
+ * @public
1891
1891
  */
1892
1892
  maxResults?: number;
1893
1893
  /**
1894
- * @public
1895
1894
  * <p>A token that indicates where a results page should begin.</p>
1895
+ * @public
1896
1896
  */
1897
1897
  nextToken?: string;
1898
1898
  }
1899
1899
  /**
1900
- * @public
1901
1900
  * <p>A Changeset is unit of data in a Dataset.</p>
1901
+ * @public
1902
1902
  */
1903
1903
  export interface ChangesetSummary {
1904
1904
  /**
1905
- * @public
1906
1905
  * <p>The unique identifier for a Changeset.</p>
1906
+ * @public
1907
1907
  */
1908
1908
  changesetId?: string;
1909
1909
  /**
1910
- * @public
1911
1910
  * <p>The ARN identifier of the Changeset.</p>
1911
+ * @public
1912
1912
  */
1913
1913
  changesetArn?: string;
1914
1914
  /**
1915
- * @public
1916
1915
  * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
1916
+ * @public
1917
1917
  */
1918
1918
  datasetId?: string;
1919
1919
  /**
1920
- * @public
1921
1920
  * <p>Type that indicates how a Changeset is applied to a Dataset.</p>
1922
1921
  * <ul>
1923
1922
  * <li>
@@ -1936,25 +1935,25 @@ export interface ChangesetSummary {
1936
1935
  * ingested Changeset.</p>
1937
1936
  * </li>
1938
1937
  * </ul>
1938
+ * @public
1939
1939
  */
1940
1940
  changeType?: ChangeType;
1941
1941
  /**
1942
- * @public
1943
1942
  * <p>Options that define the location of the data being ingested.</p>
1943
+ * @public
1944
1944
  */
1945
1945
  sourceParams?: Record<string, string>;
1946
1946
  /**
1947
- * @public
1948
1947
  * <p>Options that define the structure of the source file(s).</p>
1948
+ * @public
1949
1949
  */
1950
1950
  formatParams?: Record<string, string>;
1951
1951
  /**
1952
- * @public
1953
1952
  * <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>
1953
+ * @public
1954
1954
  */
1955
1955
  createTime?: number;
1956
1956
  /**
1957
- * @public
1958
1957
  * <p>Status of the Changeset ingestion.</p>
1959
1958
  * <ul>
1960
1959
  * <li>
@@ -1978,88 +1977,88 @@ export interface ChangesetSummary {
1978
1977
  * <code>STOP_REQUESTED</code> – User requested Changeset creation to stop.</p>
1979
1978
  * </li>
1980
1979
  * </ul>
1980
+ * @public
1981
1981
  */
1982
1982
  status?: IngestionStatus;
1983
1983
  /**
1984
- * @public
1985
1984
  * <p>The structure with error messages.</p>
1985
+ * @public
1986
1986
  */
1987
1987
  errorInfo?: ChangesetErrorInfo;
1988
1988
  /**
1989
- * @public
1990
1989
  * <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>
1990
+ * @public
1991
1991
  */
1992
1992
  activeUntilTimestamp?: number;
1993
1993
  /**
1994
- * @public
1995
1994
  * <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>
1995
+ * @public
1996
1996
  */
1997
1997
  activeFromTimestamp?: number;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>The unique identifier of the Changeset that is updated.</p>
2000
+ * @public
2001
2001
  */
2002
2002
  updatesChangesetId?: string;
2003
2003
  /**
2004
- * @public
2005
2004
  * <p>The unique identifier of the updated Changeset.</p>
2005
+ * @public
2006
2006
  */
2007
2007
  updatedByChangesetId?: string;
2008
2008
  }
2009
2009
  /**
2010
- * @public
2011
2010
  * Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
2011
+ * @public
2012
2012
  */
2013
2013
  export interface ListChangesetsResponse {
2014
2014
  /**
2015
- * @public
2016
2015
  * <p>List of Changesets found.</p>
2016
+ * @public
2017
2017
  */
2018
2018
  changesets?: ChangesetSummary[];
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>A token that indicates where a results page should begin.</p>
2021
+ * @public
2022
2022
  */
2023
2023
  nextToken?: string;
2024
2024
  }
2025
2025
  /**
2026
- * @public
2027
2026
  * Request for the ListDatasets operation.
2027
+ * @public
2028
2028
  */
2029
2029
  export interface ListDatasetsRequest {
2030
2030
  /**
2031
- * @public
2032
2031
  * <p>A token that indicates where a results page should begin.</p>
2032
+ * @public
2033
2033
  */
2034
2034
  nextToken?: string;
2035
2035
  /**
2036
- * @public
2037
2036
  * <p>The maximum number of results per page.</p>
2037
+ * @public
2038
2038
  */
2039
2039
  maxResults?: number;
2040
2040
  }
2041
2041
  /**
2042
- * @public
2043
2042
  * <p>The structure for a Dataset.</p>
2043
+ * @public
2044
2044
  */
2045
2045
  export interface Dataset {
2046
2046
  /**
2047
- * @public
2048
2047
  * <p>An identifier for a Dataset.</p>
2048
+ * @public
2049
2049
  */
2050
2050
  datasetId?: string;
2051
2051
  /**
2052
- * @public
2053
2052
  * <p>The ARN identifier of the Dataset.</p>
2053
+ * @public
2054
2054
  */
2055
2055
  datasetArn?: string;
2056
2056
  /**
2057
- * @public
2058
2057
  * <p>Display title for a Dataset.</p>
2058
+ * @public
2059
2059
  */
2060
2060
  datasetTitle?: string;
2061
2061
  /**
2062
- * @public
2063
2062
  * <p>The format in which Dataset data is structured.</p>
2064
2063
  * <ul>
2065
2064
  * <li>
@@ -2071,113 +2070,113 @@ export interface Dataset {
2071
2070
  * <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
2072
2071
  * </li>
2073
2072
  * </ul>
2073
+ * @public
2074
2074
  */
2075
2075
  kind?: DatasetKind;
2076
2076
  /**
2077
- * @public
2078
2077
  * <p>Description for a Dataset.</p>
2078
+ * @public
2079
2079
  */
2080
2080
  datasetDescription?: string;
2081
2081
  /**
2082
- * @public
2083
2082
  * <p>Contact information for a Dataset owner.</p>
2083
+ * @public
2084
2084
  */
2085
2085
  ownerInfo?: DatasetOwnerInfo;
2086
2086
  /**
2087
- * @public
2088
2087
  * <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>
2088
+ * @public
2089
2089
  */
2090
2090
  createTime?: number;
2091
2091
  /**
2092
- * @public
2093
2092
  * <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>
2093
+ * @public
2094
2094
  */
2095
2095
  lastModifiedTime?: number;
2096
2096
  /**
2097
- * @public
2098
2097
  * <p>Definition for a schema on a tabular Dataset.</p>
2098
+ * @public
2099
2099
  */
2100
2100
  schemaDefinition?: SchemaUnion;
2101
2101
  /**
2102
- * @public
2103
2102
  * <p>The unique resource identifier for a Dataset.</p>
2103
+ * @public
2104
2104
  */
2105
2105
  alias?: string;
2106
2106
  }
2107
2107
  /**
2108
- * @public
2109
2108
  * Response for the ListDatasets operation
2109
+ * @public
2110
2110
  */
2111
2111
  export interface ListDatasetsResponse {
2112
2112
  /**
2113
- * @public
2114
2113
  * <p>List of Datasets.</p>
2114
+ * @public
2115
2115
  */
2116
2116
  datasets?: Dataset[];
2117
2117
  /**
2118
- * @public
2119
2118
  * <p>A token that indicates where a results page should begin.</p>
2119
+ * @public
2120
2120
  */
2121
2121
  nextToken?: string;
2122
2122
  }
2123
2123
  /**
2124
- * @public
2125
2124
  * Request for a list data views.
2125
+ * @public
2126
2126
  */
2127
2127
  export interface ListDataViewsRequest {
2128
2128
  /**
2129
- * @public
2130
2129
  * <p>The unique identifier of the Dataset for which to retrieve Dataviews.</p>
2130
+ * @public
2131
2131
  */
2132
2132
  datasetId: string | undefined;
2133
2133
  /**
2134
- * @public
2135
2134
  * <p>A token that indicates where a results page should begin.</p>
2135
+ * @public
2136
2136
  */
2137
2137
  nextToken?: string;
2138
2138
  /**
2139
- * @public
2140
2139
  * <p>The maximum number of results per page.</p>
2140
+ * @public
2141
2141
  */
2142
2142
  maxResults?: number;
2143
2143
  }
2144
2144
  /**
2145
- * @public
2146
2145
  * <p>Structure for the summary of a Dataview.</p>
2146
+ * @public
2147
2147
  */
2148
2148
  export interface DataViewSummary {
2149
2149
  /**
2150
- * @public
2151
2150
  * <p>The unique identifier for the Dataview.</p>
2151
+ * @public
2152
2152
  */
2153
2153
  dataViewId?: string;
2154
2154
  /**
2155
- * @public
2156
2155
  * <p>The ARN identifier of the Dataview.</p>
2156
+ * @public
2157
2157
  */
2158
2158
  dataViewArn?: string;
2159
2159
  /**
2160
- * @public
2161
2160
  * <p>Th unique identifier for the Dataview Dataset.</p>
2161
+ * @public
2162
2162
  */
2163
2163
  datasetId?: string;
2164
2164
  /**
2165
- * @public
2166
2165
  * <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>
2166
+ * @public
2167
2167
  */
2168
2168
  asOfTimestamp?: number;
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>Ordered set of column names used to partition data.</p>
2171
+ * @public
2172
2172
  */
2173
2173
  partitionColumns?: string[];
2174
2174
  /**
2175
- * @public
2176
2175
  * <p>Columns to be used for sorting the data.</p>
2176
+ * @public
2177
2177
  */
2178
2178
  sortColumns?: string[];
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>The status of a Dataview creation.</p>
2182
2181
  * <ul>
2183
2182
  * <li>
@@ -2213,31 +2212,32 @@ export interface DataViewSummary {
2213
2212
  * <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p>
2214
2213
  * </li>
2215
2214
  * </ul>
2215
+ * @public
2216
2216
  */
2217
2217
  status?: DataViewStatus;
2218
2218
  /**
2219
- * @public
2220
2219
  * <p>The structure with error messages.</p>
2220
+ * @public
2221
2221
  */
2222
2222
  errorInfo?: DataViewErrorInfo;
2223
2223
  /**
2224
- * @public
2225
2224
  * <p>Information about the Dataview destination.</p>
2225
+ * @public
2226
2226
  */
2227
2227
  destinationTypeProperties?: DataViewDestinationTypeParams;
2228
2228
  /**
2229
- * @public
2230
2229
  * <p>The flag to indicate Dataview should be updated automatically.</p>
2230
+ * @public
2231
2231
  */
2232
2232
  autoUpdate?: boolean;
2233
2233
  /**
2234
- * @public
2235
2234
  * <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>
2235
+ * @public
2236
2236
  */
2237
2237
  createTime?: number;
2238
2238
  /**
2239
- * @public
2240
2239
  * <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>
2240
+ * @public
2241
2241
  */
2242
2242
  lastModifiedTime?: number;
2243
2243
  }
@@ -2246,13 +2246,13 @@ export interface DataViewSummary {
2246
2246
  */
2247
2247
  export interface ListDataViewsResponse {
2248
2248
  /**
2249
- * @public
2250
2249
  * <p>A token that indicates where a results page should begin.</p>
2250
+ * @public
2251
2251
  */
2252
2252
  nextToken?: string;
2253
2253
  /**
2254
- * @public
2255
2254
  * <p>A list of Dataviews.</p>
2255
+ * @public
2256
2256
  */
2257
2257
  dataViews?: DataViewSummary[];
2258
2258
  }
@@ -2261,13 +2261,13 @@ export interface ListDataViewsResponse {
2261
2261
  */
2262
2262
  export interface ListPermissionGroupsRequest {
2263
2263
  /**
2264
- * @public
2265
2264
  * <p>A token that indicates where a results page should begin.</p>
2265
+ * @public
2266
2266
  */
2267
2267
  nextToken?: string;
2268
2268
  /**
2269
- * @public
2270
2269
  * <p>The maximum number of results per page.</p>
2270
+ * @public
2271
2271
  */
2272
2272
  maxResults: number | undefined;
2273
2273
  }
@@ -2276,13 +2276,13 @@ export interface ListPermissionGroupsRequest {
2276
2276
  */
2277
2277
  export interface ListPermissionGroupsResponse {
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>A list of all the permission groups.</p>
2280
+ * @public
2281
2281
  */
2282
2282
  permissionGroups?: PermissionGroup[];
2283
2283
  /**
2284
- * @public
2285
2284
  * <p>A token that indicates where a results page should begin.</p>
2285
+ * @public
2286
2286
  */
2287
2287
  nextToken?: string;
2288
2288
  }
@@ -2291,38 +2291,37 @@ export interface ListPermissionGroupsResponse {
2291
2291
  */
2292
2292
  export interface ListPermissionGroupsByUserRequest {
2293
2293
  /**
2294
- * @public
2295
2294
  * <p>The unique identifier for the user.</p>
2295
+ * @public
2296
2296
  */
2297
2297
  userId: string | undefined;
2298
2298
  /**
2299
- * @public
2300
2299
  * <p>A token that indicates where a results page should begin.</p>
2300
+ * @public
2301
2301
  */
2302
2302
  nextToken?: string;
2303
2303
  /**
2304
- * @public
2305
2304
  * <p>The maximum number of results per page.</p>
2305
+ * @public
2306
2306
  */
2307
2307
  maxResults: number | undefined;
2308
2308
  }
2309
2309
  /**
2310
- * @public
2311
2310
  * <p>The structure of a permission group associated with a user.</p>
2311
+ * @public
2312
2312
  */
2313
2313
  export interface PermissionGroupByUser {
2314
2314
  /**
2315
- * @public
2316
2315
  * <p>The unique identifier for the permission group.</p>
2316
+ * @public
2317
2317
  */
2318
2318
  permissionGroupId?: string;
2319
2319
  /**
2320
- * @public
2321
2320
  * <p>The name of the permission group.</p>
2321
+ * @public
2322
2322
  */
2323
2323
  name?: string;
2324
2324
  /**
2325
- * @public
2326
2325
  * <p>Indicates the status of the user within a permission group.</p>
2327
2326
  * <ul>
2328
2327
  * <li>
@@ -2338,6 +2337,7 @@ export interface PermissionGroupByUser {
2338
2337
  * <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p>
2339
2338
  * </li>
2340
2339
  * </ul>
2340
+ * @public
2341
2341
  */
2342
2342
  membershipStatus?: PermissionGroupMembershipStatus;
2343
2343
  }
@@ -2346,13 +2346,13 @@ export interface PermissionGroupByUser {
2346
2346
  */
2347
2347
  export interface ListPermissionGroupsByUserResponse {
2348
2348
  /**
2349
- * @public
2350
2349
  * <p>A list of returned permission groups.</p>
2350
+ * @public
2351
2351
  */
2352
2352
  permissionGroups?: PermissionGroupByUser[];
2353
2353
  /**
2354
- * @public
2355
2354
  * <p>A token that indicates where a results page should begin.</p>
2355
+ * @public
2356
2356
  */
2357
2357
  nextToken?: string;
2358
2358
  }
@@ -2361,28 +2361,27 @@ export interface ListPermissionGroupsByUserResponse {
2361
2361
  */
2362
2362
  export interface ListUsersRequest {
2363
2363
  /**
2364
- * @public
2365
2364
  * <p>A token that indicates where a results page should begin.</p>
2365
+ * @public
2366
2366
  */
2367
2367
  nextToken?: string;
2368
2368
  /**
2369
- * @public
2370
2369
  * <p>The maximum number of results per page.</p>
2370
+ * @public
2371
2371
  */
2372
2372
  maxResults: number | undefined;
2373
2373
  }
2374
2374
  /**
2375
- * @public
2376
2375
  * <p>The details of the user.</p>
2376
+ * @public
2377
2377
  */
2378
2378
  export interface User {
2379
2379
  /**
2380
- * @public
2381
2380
  * <p>The unique identifier for the user.</p>
2381
+ * @public
2382
2382
  */
2383
2383
  userId?: string;
2384
2384
  /**
2385
- * @public
2386
2385
  * <p>The current status of the user. </p>
2387
2386
  * <ul>
2388
2387
  * <li>
@@ -2398,25 +2397,25 @@ export interface User {
2398
2397
  * <code>DISABLED</code> – The user is currently inactive.</p>
2399
2398
  * </li>
2400
2399
  * </ul>
2400
+ * @public
2401
2401
  */
2402
2402
  status?: UserStatus;
2403
2403
  /**
2404
- * @public
2405
2404
  * <p>The first name of the user.</p>
2405
+ * @public
2406
2406
  */
2407
2407
  firstName?: string;
2408
2408
  /**
2409
- * @public
2410
2409
  * <p> The last name of the user.</p>
2410
+ * @public
2411
2411
  */
2412
2412
  lastName?: string;
2413
2413
  /**
2414
- * @public
2415
2414
  * <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>
2415
+ * @public
2416
2416
  */
2417
2417
  emailAddress?: string;
2418
2418
  /**
2419
- * @public
2420
2419
  * <p> Indicates the type of user.</p>
2421
2420
  * <ul>
2422
2421
  * <li>
@@ -2428,10 +2427,10 @@ export interface User {
2428
2427
  * <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
2429
2428
  * </li>
2430
2429
  * </ul>
2430
+ * @public
2431
2431
  */
2432
2432
  type?: UserType;
2433
2433
  /**
2434
- * @public
2435
2434
  * <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>
2436
2435
  * <ul>
2437
2436
  * <li>
@@ -2443,39 +2442,40 @@ export interface User {
2443
2442
  * <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
2444
2443
  * </li>
2445
2444
  * </ul>
2445
+ * @public
2446
2446
  */
2447
2447
  apiAccess?: ApiAccess;
2448
2448
  /**
2449
- * @public
2450
2449
  * <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>
2450
+ * @public
2451
2451
  */
2452
2452
  apiAccessPrincipalArn?: string;
2453
2453
  /**
2454
- * @public
2455
2454
  * <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
2455
+ * @public
2456
2456
  */
2457
2457
  createTime?: number;
2458
2458
  /**
2459
- * @public
2460
2459
  * <p> Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
2461
2460
  * </p>
2461
+ * @public
2462
2462
  */
2463
2463
  lastEnabledTime?: number;
2464
2464
  /**
2465
- * @public
2466
2465
  * <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
2466
+ * @public
2467
2467
  */
2468
2468
  lastDisabledTime?: number;
2469
2469
  /**
2470
- * @public
2471
2470
  * <p>Describes the last time the user was updated. The value is determined as epoch time in milliseconds.
2472
2471
  * </p>
2472
+ * @public
2473
2473
  */
2474
2474
  lastModifiedTime?: number;
2475
2475
  /**
2476
- * @public
2477
2476
  * <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
2478
2477
  * </p>
2478
+ * @public
2479
2479
  */
2480
2480
  lastLoginTime?: number;
2481
2481
  }
@@ -2484,13 +2484,13 @@ export interface User {
2484
2484
  */
2485
2485
  export interface ListUsersResponse {
2486
2486
  /**
2487
- * @public
2488
2487
  * <p>A list of all the users.</p>
2488
+ * @public
2489
2489
  */
2490
2490
  users?: User[];
2491
2491
  /**
2492
- * @public
2493
2492
  * <p>A token that indicates where a results page should begin.</p>
2493
+ * @public
2494
2494
  */
2495
2495
  nextToken?: string;
2496
2496
  }
@@ -2499,33 +2499,32 @@ export interface ListUsersResponse {
2499
2499
  */
2500
2500
  export interface ListUsersByPermissionGroupRequest {
2501
2501
  /**
2502
- * @public
2503
2502
  * <p>The unique identifier for the permission group.</p>
2503
+ * @public
2504
2504
  */
2505
2505
  permissionGroupId: string | undefined;
2506
2506
  /**
2507
- * @public
2508
2507
  * <p>A token that indicates where a results page should begin.</p>
2508
+ * @public
2509
2509
  */
2510
2510
  nextToken?: string;
2511
2511
  /**
2512
- * @public
2513
2512
  * <p>The maximum number of results per page.</p>
2513
+ * @public
2514
2514
  */
2515
2515
  maxResults: number | undefined;
2516
2516
  }
2517
2517
  /**
2518
- * @public
2519
2518
  * <p>The structure of a user associated with a permission group.</p>
2519
+ * @public
2520
2520
  */
2521
2521
  export interface UserByPermissionGroup {
2522
2522
  /**
2523
- * @public
2524
2523
  * <p>The unique identifier for the user.</p>
2524
+ * @public
2525
2525
  */
2526
2526
  userId?: string;
2527
2527
  /**
2528
- * @public
2529
2528
  * <p>The current status of the user. </p>
2530
2529
  * <ul>
2531
2530
  * <li>
@@ -2541,25 +2540,25 @@ export interface UserByPermissionGroup {
2541
2540
  * <code>DISABLED</code> – The user is currently inactive.</p>
2542
2541
  * </li>
2543
2542
  * </ul>
2543
+ * @public
2544
2544
  */
2545
2545
  status?: UserStatus;
2546
2546
  /**
2547
- * @public
2548
2547
  * <p>The first name of the user.</p>
2548
+ * @public
2549
2549
  */
2550
2550
  firstName?: string;
2551
2551
  /**
2552
- * @public
2553
2552
  * <p>The last name of the user.</p>
2553
+ * @public
2554
2554
  */
2555
2555
  lastName?: string;
2556
2556
  /**
2557
- * @public
2558
2557
  * <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>
2558
+ * @public
2559
2559
  */
2560
2560
  emailAddress?: string;
2561
2561
  /**
2562
- * @public
2563
2562
  * <p> Indicates the type of user.</p>
2564
2563
  * <ul>
2565
2564
  * <li>
@@ -2571,10 +2570,10 @@ export interface UserByPermissionGroup {
2571
2570
  * <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
2572
2571
  * </li>
2573
2572
  * </ul>
2573
+ * @public
2574
2574
  */
2575
2575
  type?: UserType;
2576
2576
  /**
2577
- * @public
2578
2577
  * <p>Indicates whether the user can access FinSpace API operations.</p>
2579
2578
  * <ul>
2580
2579
  * <li>
@@ -2586,15 +2585,15 @@ export interface UserByPermissionGroup {
2586
2585
  * <code>DISABLED</code> – The user does not have permissions to use any API operations.</p>
2587
2586
  * </li>
2588
2587
  * </ul>
2588
+ * @public
2589
2589
  */
2590
2590
  apiAccess?: ApiAccess;
2591
2591
  /**
2592
- * @public
2593
2592
  * <p>The IAM ARN identifier that is attached to FinSpace API calls.</p>
2593
+ * @public
2594
2594
  */
2595
2595
  apiAccessPrincipalArn?: string;
2596
2596
  /**
2597
- * @public
2598
2597
  * <p>Indicates the status of the user within a permission group.</p>
2599
2598
  * <ul>
2600
2599
  * <li>
@@ -2610,6 +2609,7 @@ export interface UserByPermissionGroup {
2610
2609
  * <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p>
2611
2610
  * </li>
2612
2611
  * </ul>
2612
+ * @public
2613
2613
  */
2614
2614
  membershipStatus?: PermissionGroupMembershipStatus;
2615
2615
  }
@@ -2618,13 +2618,13 @@ export interface UserByPermissionGroup {
2618
2618
  */
2619
2619
  export interface ListUsersByPermissionGroupResponse {
2620
2620
  /**
2621
- * @public
2622
2621
  * <p>Lists details of all users in a specific permission group.</p>
2622
+ * @public
2623
2623
  */
2624
2624
  users?: UserByPermissionGroup[];
2625
2625
  /**
2626
- * @public
2627
2626
  * <p>A token that indicates where a results page should begin.</p>
2627
+ * @public
2628
2628
  */
2629
2629
  nextToken?: string;
2630
2630
  }
@@ -2633,13 +2633,13 @@ export interface ListUsersByPermissionGroupResponse {
2633
2633
  */
2634
2634
  export interface ResetUserPasswordRequest {
2635
2635
  /**
2636
- * @public
2637
2636
  * <p>The unique identifier of the user that a temporary password is requested for.</p>
2637
+ * @public
2638
2638
  */
2639
2639
  userId: string | undefined;
2640
2640
  /**
2641
- * @public
2642
2641
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2642
+ * @public
2643
2643
  */
2644
2644
  clientToken?: string;
2645
2645
  }
@@ -2648,38 +2648,37 @@ export interface ResetUserPasswordRequest {
2648
2648
  */
2649
2649
  export interface ResetUserPasswordResponse {
2650
2650
  /**
2651
- * @public
2652
2651
  * <p>The unique identifier of the user that a new password is generated for.</p>
2652
+ * @public
2653
2653
  */
2654
2654
  userId?: string;
2655
2655
  /**
2656
- * @public
2657
2656
  * <p>A randomly generated temporary password for the requested user. This password expires in 7 days.</p>
2657
+ * @public
2658
2658
  */
2659
2659
  temporaryPassword?: string;
2660
2660
  }
2661
2661
  /**
2662
- * @public
2663
2662
  * Request to update an existing changeset.
2663
+ * @public
2664
2664
  */
2665
2665
  export interface UpdateChangesetRequest {
2666
2666
  /**
2667
- * @public
2668
2667
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2668
+ * @public
2669
2669
  */
2670
2670
  clientToken?: string;
2671
2671
  /**
2672
- * @public
2673
2672
  * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
2673
+ * @public
2674
2674
  */
2675
2675
  datasetId: string | undefined;
2676
2676
  /**
2677
- * @public
2678
2677
  * <p>The unique identifier for the Changeset to update.</p>
2678
+ * @public
2679
2679
  */
2680
2680
  changesetId: string | undefined;
2681
2681
  /**
2682
- * @public
2683
2682
  * <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
2684
2683
  * <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
2685
2684
  * <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
@@ -2693,10 +2692,10 @@ export interface UpdateChangesetRequest {
2693
2692
  * </code>
2694
2693
  * </p>
2695
2694
  * <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>
2695
+ * @public
2696
2696
  */
2697
2697
  sourceParams: Record<string, string> | undefined;
2698
2698
  /**
2699
- * @public
2700
2699
  * <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>).
2701
2700
  * </p>
2702
2701
  * <p>
@@ -2742,47 +2741,47 @@ export interface UpdateChangesetRequest {
2742
2741
  * </code>
2743
2742
  * </p>
2744
2743
  * <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
2744
+ * @public
2745
2745
  */
2746
2746
  formatParams: Record<string, string> | undefined;
2747
2747
  }
2748
2748
  /**
2749
- * @public
2750
2749
  * The response from a update changeset operation.
2750
+ * @public
2751
2751
  */
2752
2752
  export interface UpdateChangesetResponse {
2753
2753
  /**
2754
- * @public
2755
2754
  * <p>The unique identifier for the Changeset to update.</p>
2755
+ * @public
2756
2756
  */
2757
2757
  changesetId?: string;
2758
2758
  /**
2759
- * @public
2760
2759
  * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
2760
+ * @public
2761
2761
  */
2762
2762
  datasetId?: string;
2763
2763
  }
2764
2764
  /**
2765
- * @public
2766
2765
  * The request for an UpdateDataset operation
2766
+ * @public
2767
2767
  */
2768
2768
  export interface UpdateDatasetRequest {
2769
2769
  /**
2770
- * @public
2771
2770
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2771
+ * @public
2772
2772
  */
2773
2773
  clientToken?: string;
2774
2774
  /**
2775
- * @public
2776
2775
  * <p>The unique identifier for the Dataset to update.</p>
2776
+ * @public
2777
2777
  */
2778
2778
  datasetId: string | undefined;
2779
2779
  /**
2780
- * @public
2781
2780
  * <p>A display title for the Dataset.</p>
2781
+ * @public
2782
2782
  */
2783
2783
  datasetTitle: string | undefined;
2784
2784
  /**
2785
- * @public
2786
2785
  * <p>The format in which the Dataset data is structured.</p>
2787
2786
  * <ul>
2788
2787
  * <li>
@@ -2794,32 +2793,33 @@ export interface UpdateDatasetRequest {
2794
2793
  * <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
2795
2794
  * </li>
2796
2795
  * </ul>
2796
+ * @public
2797
2797
  */
2798
2798
  kind: DatasetKind | undefined;
2799
2799
  /**
2800
- * @public
2801
2800
  * <p>A description for the Dataset.</p>
2801
+ * @public
2802
2802
  */
2803
2803
  datasetDescription?: string;
2804
2804
  /**
2805
- * @public
2806
2805
  * <p>The unique resource identifier for a Dataset.</p>
2806
+ * @public
2807
2807
  */
2808
2808
  alias?: string;
2809
2809
  /**
2810
- * @public
2811
2810
  * <p>Definition for a schema on a tabular Dataset.</p>
2811
+ * @public
2812
2812
  */
2813
2813
  schemaDefinition?: SchemaUnion;
2814
2814
  }
2815
2815
  /**
2816
- * @public
2817
2816
  * The response from an UpdateDataset operation
2817
+ * @public
2818
2818
  */
2819
2819
  export interface UpdateDatasetResponse {
2820
2820
  /**
2821
- * @public
2822
2821
  * <p>The unique identifier for updated Dataset.</p>
2822
+ * @public
2823
2823
  */
2824
2824
  datasetId?: string;
2825
2825
  }
@@ -2828,22 +2828,21 @@ export interface UpdateDatasetResponse {
2828
2828
  */
2829
2829
  export interface UpdatePermissionGroupRequest {
2830
2830
  /**
2831
- * @public
2832
2831
  * <p>The unique identifier for the permission group to update.</p>
2832
+ * @public
2833
2833
  */
2834
2834
  permissionGroupId: string | undefined;
2835
2835
  /**
2836
- * @public
2837
2836
  * <p>The name of the permission group.</p>
2837
+ * @public
2838
2838
  */
2839
2839
  name?: string;
2840
2840
  /**
2841
- * @public
2842
2841
  * <p>A brief description for the permission group.</p>
2842
+ * @public
2843
2843
  */
2844
2844
  description?: string;
2845
2845
  /**
2846
- * @public
2847
2846
  * <p>The permissions that are granted to a specific group for accessing the FinSpace application.</p>
2848
2847
  * <important>
2849
2848
  * <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>
@@ -2878,11 +2877,12 @@ export interface UpdatePermissionGroupRequest {
2878
2877
  * <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
2879
2878
  * </li>
2880
2879
  * </ul>
2880
+ * @public
2881
2881
  */
2882
2882
  applicationPermissions?: ApplicationPermission[];
2883
2883
  /**
2884
- * @public
2885
2884
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2885
+ * @public
2886
2886
  */
2887
2887
  clientToken?: string;
2888
2888
  }
@@ -2891,8 +2891,8 @@ export interface UpdatePermissionGroupRequest {
2891
2891
  */
2892
2892
  export interface UpdatePermissionGroupResponse {
2893
2893
  /**
2894
- * @public
2895
2894
  * <p>The unique identifier for the updated permission group.</p>
2895
+ * @public
2896
2896
  */
2897
2897
  permissionGroupId?: string;
2898
2898
  }
@@ -2901,12 +2901,11 @@ export interface UpdatePermissionGroupResponse {
2901
2901
  */
2902
2902
  export interface UpdateUserRequest {
2903
2903
  /**
2904
- * @public
2905
2904
  * <p>The unique identifier for the user that you want to update.</p>
2905
+ * @public
2906
2906
  */
2907
2907
  userId: string | undefined;
2908
2908
  /**
2909
- * @public
2910
2909
  * <p>The option to indicate the type of user.</p>
2911
2910
  * <ul>
2912
2911
  * <li>
@@ -2918,20 +2917,20 @@ export interface UpdateUserRequest {
2918
2917
  * <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
2919
2918
  * </li>
2920
2919
  * </ul>
2920
+ * @public
2921
2921
  */
2922
2922
  type?: UserType;
2923
2923
  /**
2924
- * @public
2925
2924
  * <p>The first name of the user.</p>
2925
+ * @public
2926
2926
  */
2927
2927
  firstName?: string;
2928
2928
  /**
2929
- * @public
2930
2929
  * <p>The last name of the user.</p>
2930
+ * @public
2931
2931
  */
2932
2932
  lastName?: string;
2933
2933
  /**
2934
- * @public
2935
2934
  * <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>
2936
2935
  * <ul>
2937
2936
  * <li>
@@ -2943,16 +2942,17 @@ export interface UpdateUserRequest {
2943
2942
  * <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
2944
2943
  * </li>
2945
2944
  * </ul>
2945
+ * @public
2946
2946
  */
2947
2947
  apiAccess?: ApiAccess;
2948
2948
  /**
2949
- * @public
2950
2949
  * <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>
2950
+ * @public
2951
2951
  */
2952
2952
  apiAccessPrincipalArn?: string;
2953
2953
  /**
2954
- * @public
2955
2954
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2955
+ * @public
2956
2956
  */
2957
2957
  clientToken?: string;
2958
2958
  }
@@ -2961,8 +2961,8 @@ export interface UpdateUserRequest {
2961
2961
  */
2962
2962
  export interface UpdateUserResponse {
2963
2963
  /**
2964
- * @public
2965
2964
  * <p>The unique identifier of the updated user.</p>
2965
+ * @public
2966
2966
  */
2967
2967
  userId?: string;
2968
2968
  }