@aws-sdk/client-finspace-data 3.53.0 → 3.55.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/CHANGELOG.md +27 -0
- package/dist-cjs/FinspaceData.js +165 -0
- package/dist-cjs/FinspaceDataClient.js +13 -13
- package/dist-cjs/commands/CreateChangesetCommand.js +3 -3
- package/dist-cjs/commands/CreateDataViewCommand.js +3 -3
- package/dist-cjs/commands/CreateDatasetCommand.js +3 -3
- package/dist-cjs/commands/CreatePermissionGroupCommand.js +36 -0
- package/dist-cjs/commands/CreateUserCommand.js +36 -0
- package/dist-cjs/commands/DeleteDatasetCommand.js +3 -3
- package/dist-cjs/commands/DeletePermissionGroupCommand.js +36 -0
- package/dist-cjs/commands/DisableUserCommand.js +36 -0
- package/dist-cjs/commands/EnableUserCommand.js +36 -0
- package/dist-cjs/commands/GetChangesetCommand.js +3 -3
- package/dist-cjs/commands/GetDataViewCommand.js +3 -3
- package/dist-cjs/commands/GetDatasetCommand.js +3 -3
- package/dist-cjs/commands/GetProgrammaticAccessCredentialsCommand.js +3 -3
- package/dist-cjs/commands/GetUserCommand.js +36 -0
- package/dist-cjs/commands/GetWorkingLocationCommand.js +3 -3
- package/dist-cjs/commands/ListChangesetsCommand.js +3 -3
- package/dist-cjs/commands/ListDataViewsCommand.js +3 -3
- package/dist-cjs/commands/ListDatasetsCommand.js +3 -3
- package/dist-cjs/commands/ListPermissionGroupsCommand.js +36 -0
- package/dist-cjs/commands/ListUsersCommand.js +36 -0
- package/dist-cjs/commands/ResetUserPasswordCommand.js +36 -0
- package/dist-cjs/commands/UpdateChangesetCommand.js +3 -3
- package/dist-cjs/commands/UpdateDatasetCommand.js +3 -3
- package/dist-cjs/commands/UpdatePermissionGroupCommand.js +36 -0
- package/dist-cjs/commands/UpdateUserCommand.js +36 -0
- package/dist-cjs/commands/index.js +11 -0
- package/dist-cjs/endpoints.js +1 -1
- package/dist-cjs/models/models_0.js +202 -2
- package/dist-cjs/pagination/ListPermissionGroupsPaginator.js +35 -0
- package/dist-cjs/pagination/ListUsersPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1352 -321
- package/dist-cjs/runtimeConfig.browser.js +4 -4
- package/dist-cjs/runtimeConfig.js +9 -9
- package/dist-cjs/runtimeConfig.native.js +1 -1
- package/dist-es/FinspaceData.js +179 -14
- package/dist-es/commands/CreatePermissionGroupCommand.js +39 -0
- package/dist-es/commands/CreateUserCommand.js +39 -0
- package/dist-es/commands/DeletePermissionGroupCommand.js +39 -0
- package/dist-es/commands/DisableUserCommand.js +39 -0
- package/dist-es/commands/EnableUserCommand.js +39 -0
- package/dist-es/commands/GetUserCommand.js +39 -0
- package/dist-es/commands/ListPermissionGroupsCommand.js +39 -0
- package/dist-es/commands/ListUsersCommand.js +39 -0
- package/dist-es/commands/ResetUserPasswordCommand.js +39 -0
- package/dist-es/commands/UpdatePermissionGroupCommand.js +39 -0
- package/dist-es/commands/UpdateUserCommand.js +39 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/models_0.js +132 -4
- package/dist-es/pagination/ListChangesetsPaginator.js +4 -4
- package/dist-es/pagination/ListDataViewsPaginator.js +4 -4
- package/dist-es/pagination/ListDatasetsPaginator.js +4 -4
- package/dist-es/pagination/ListPermissionGroupsPaginator.js +74 -0
- package/dist-es/pagination/ListUsersPaginator.js +74 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +1636 -322
- package/dist-types/FinspaceData.d.ts +77 -0
- package/dist-types/FinspaceDataClient.d.ts +15 -4
- package/dist-types/commands/CreatePermissionGroupCommand.d.ts +35 -0
- package/dist-types/commands/CreateUserCommand.d.ts +35 -0
- package/dist-types/commands/DeletePermissionGroupCommand.d.ts +35 -0
- package/dist-types/commands/DisableUserCommand.d.ts +35 -0
- package/dist-types/commands/EnableUserCommand.d.ts +35 -0
- package/dist-types/commands/GetUserCommand.d.ts +35 -0
- package/dist-types/commands/ListPermissionGroupsCommand.d.ts +35 -0
- package/dist-types/commands/ListUsersCommand.d.ts +35 -0
- package/dist-types/commands/ResetUserPasswordCommand.d.ts +35 -0
- package/dist-types/commands/UpdatePermissionGroupCommand.d.ts +35 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +865 -113
- package/dist-types/pagination/ListPermissionGroupsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListUsersPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +33 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +3 -3
- package/dist-types/ts3.4/FinspaceData.d.ts +55 -0
- package/dist-types/ts3.4/FinspaceDataClient.d.ts +15 -4
- package/dist-types/ts3.4/commands/CreatePermissionGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeletePermissionGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DisableUserCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/EnableUserCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListPermissionGroupsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ResetUserPasswordCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdatePermissionGroupCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/models_0.d.ts +333 -0
- package/dist-types/ts3.4/pagination/ListPermissionGroupsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +33 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
- package/package.json +34 -34
|
@@ -11,12 +11,26 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
11
11
|
*/
|
|
12
12
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
13
13
|
}
|
|
14
|
+
export declare enum ApiAccess {
|
|
15
|
+
DISABLED = "DISABLED",
|
|
16
|
+
ENABLED = "ENABLED"
|
|
17
|
+
}
|
|
18
|
+
export declare enum ApplicationPermission {
|
|
19
|
+
AccessNotebooks = "AccessNotebooks",
|
|
20
|
+
CreateDataset = "CreateDataset",
|
|
21
|
+
GetTemporaryCredentials = "GetTemporaryCredentials",
|
|
22
|
+
ManageAttributeSets = "ManageAttributeSets",
|
|
23
|
+
ManageClusters = "ManageClusters",
|
|
24
|
+
ManageUsersAndGroups = "ManageUsersAndGroups",
|
|
25
|
+
ViewAuditData = "ViewAuditData"
|
|
26
|
+
}
|
|
14
27
|
/**
|
|
15
28
|
* <p>The request conflicts with an existing resource.</p>
|
|
16
29
|
*/
|
|
17
30
|
export declare class ConflictException extends __BaseException {
|
|
18
31
|
readonly name: "ConflictException";
|
|
19
32
|
readonly $fault: "client";
|
|
33
|
+
reason?: string;
|
|
20
34
|
/**
|
|
21
35
|
* @internal
|
|
22
36
|
*/
|
|
@@ -41,21 +55,21 @@ export interface CreateChangesetRequest {
|
|
|
41
55
|
*/
|
|
42
56
|
datasetId: string | undefined;
|
|
43
57
|
/**
|
|
44
|
-
* <p>
|
|
58
|
+
* <p>The option to indicate how a Changeset will be applied to a Dataset.</p>
|
|
45
59
|
* <ul>
|
|
46
60
|
* <li>
|
|
47
61
|
* <p>
|
|
48
|
-
* <code>REPLACE</code>
|
|
62
|
+
* <code>REPLACE</code> – Changeset will be considered as a replacement to all prior
|
|
49
63
|
* loaded Changesets.</p>
|
|
50
64
|
* </li>
|
|
51
65
|
* <li>
|
|
52
66
|
* <p>
|
|
53
|
-
* <code>APPEND</code>
|
|
67
|
+
* <code>APPEND</code> – Changeset will be considered as an addition to the end of all
|
|
54
68
|
* prior loaded Changesets.</p>
|
|
55
69
|
* </li>
|
|
56
70
|
* <li>
|
|
57
71
|
* <p>
|
|
58
|
-
* <code>MODIFY</code>
|
|
72
|
+
* <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
|
|
59
73
|
* </li>
|
|
60
74
|
* </ul>
|
|
61
75
|
*/
|
|
@@ -73,7 +87,7 @@ export interface CreateChangesetRequest {
|
|
|
73
87
|
* }
|
|
74
88
|
* </code>
|
|
75
89
|
* </p>
|
|
76
|
-
* <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>
|
|
90
|
+
* <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>
|
|
77
91
|
*/
|
|
78
92
|
sourceParams: {
|
|
79
93
|
[key: string]: string;
|
|
@@ -87,19 +101,19 @@ export interface CreateChangesetRequest {
|
|
|
87
101
|
* <ul>
|
|
88
102
|
* <li>
|
|
89
103
|
* <p>
|
|
90
|
-
* <code>PARQUET</code>
|
|
104
|
+
* <code>PARQUET</code> – Parquet source file format.</p>
|
|
91
105
|
* </li>
|
|
92
106
|
* <li>
|
|
93
107
|
* <p>
|
|
94
|
-
* <code>CSV</code>
|
|
108
|
+
* <code>CSV</code> – CSV source file format.</p>
|
|
95
109
|
* </li>
|
|
96
110
|
* <li>
|
|
97
111
|
* <p>
|
|
98
|
-
* <code>JSON</code>
|
|
112
|
+
* <code>JSON</code> – JSON source file format.</p>
|
|
99
113
|
* </li>
|
|
100
114
|
* <li>
|
|
101
115
|
* <p>
|
|
102
|
-
* <code>XML</code>
|
|
116
|
+
* <code>XML</code> – XML source file format.</p>
|
|
103
117
|
* </li>
|
|
104
118
|
* </ul>
|
|
105
119
|
*
|
|
@@ -184,6 +198,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
184
198
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
185
199
|
readonly name: "ResourceNotFoundException";
|
|
186
200
|
readonly $fault: "client";
|
|
201
|
+
reason?: string;
|
|
187
202
|
/**
|
|
188
203
|
* @internal
|
|
189
204
|
*/
|
|
@@ -206,6 +221,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
206
221
|
export declare class ValidationException extends __BaseException {
|
|
207
222
|
readonly name: "ValidationException";
|
|
208
223
|
readonly $fault: "client";
|
|
224
|
+
reason?: string;
|
|
209
225
|
/**
|
|
210
226
|
* @internal
|
|
211
227
|
*/
|
|
@@ -220,7 +236,7 @@ export declare enum DatasetKind {
|
|
|
220
236
|
*/
|
|
221
237
|
export interface DatasetOwnerInfo {
|
|
222
238
|
/**
|
|
223
|
-
* <p>
|
|
239
|
+
* <p>The name of the Dataset owner.</p>
|
|
224
240
|
*/
|
|
225
241
|
name?: string;
|
|
226
242
|
/**
|
|
@@ -275,7 +291,7 @@ export declare namespace DatasetOwnerInfo {
|
|
|
275
291
|
* </p>
|
|
276
292
|
* </li>
|
|
277
293
|
* </ul>
|
|
278
|
-
* <p>For more information on the
|
|
294
|
+
* <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>
|
|
279
295
|
*/
|
|
280
296
|
export interface ResourcePermission {
|
|
281
297
|
/**
|
|
@@ -308,7 +324,7 @@ export declare namespace ResourcePermission {
|
|
|
308
324
|
*/
|
|
309
325
|
export interface PermissionGroupParams {
|
|
310
326
|
/**
|
|
311
|
-
* <p>The unique identifier
|
|
327
|
+
* <p>The unique identifier for the <code>PermissionGroup</code>.</p>
|
|
312
328
|
*/
|
|
313
329
|
permissionGroupId?: string;
|
|
314
330
|
/**
|
|
@@ -345,35 +361,35 @@ export interface ColumnDefinition {
|
|
|
345
361
|
* <ul>
|
|
346
362
|
* <li>
|
|
347
363
|
* <p>
|
|
348
|
-
* <code>STRING</code>
|
|
364
|
+
* <code>STRING</code> – A String data type.</p>
|
|
349
365
|
* <p>
|
|
350
|
-
* <code>CHAR</code>
|
|
366
|
+
* <code>CHAR</code> – A char data type.</p>
|
|
351
367
|
* <p>
|
|
352
|
-
* <code>INTEGER</code>
|
|
368
|
+
* <code>INTEGER</code> – An integer data type.</p>
|
|
353
369
|
* <p>
|
|
354
|
-
* <code>TINYINT</code>
|
|
370
|
+
* <code>TINYINT</code> – A tinyint data type.</p>
|
|
355
371
|
* <p>
|
|
356
|
-
* <code>SMALLINT</code>
|
|
372
|
+
* <code>SMALLINT</code> – A smallint data type.</p>
|
|
357
373
|
* <p>
|
|
358
|
-
* <code>BIGINT</code>
|
|
374
|
+
* <code>BIGINT</code> – A bigint data type.</p>
|
|
359
375
|
* <p>
|
|
360
|
-
* <code>FLOAT</code>
|
|
376
|
+
* <code>FLOAT</code> – A float data type.</p>
|
|
361
377
|
* <p>
|
|
362
|
-
* <code>DOUBLE</code>
|
|
378
|
+
* <code>DOUBLE</code> – A double data type.</p>
|
|
363
379
|
* <p>
|
|
364
|
-
* <code>DATE</code>
|
|
380
|
+
* <code>DATE</code> – A date data type.</p>
|
|
365
381
|
* <p>
|
|
366
|
-
* <code>DATETIME</code>
|
|
382
|
+
* <code>DATETIME</code> – A datetime data type.</p>
|
|
367
383
|
* <p>
|
|
368
|
-
* <code>BOOLEAN</code>
|
|
384
|
+
* <code>BOOLEAN</code> – A boolean data type.</p>
|
|
369
385
|
* <p>
|
|
370
|
-
* <code>BINARY</code>
|
|
386
|
+
* <code>BINARY</code> – A binary data type.</p>
|
|
371
387
|
* </li>
|
|
372
388
|
* </ul>
|
|
373
389
|
*/
|
|
374
390
|
dataType?: ColumnDataType | string;
|
|
375
391
|
/**
|
|
376
|
-
* <p>
|
|
392
|
+
* <p>The name of a column.</p>
|
|
377
393
|
*/
|
|
378
394
|
columnName?: string;
|
|
379
395
|
/**
|
|
@@ -438,11 +454,11 @@ export interface CreateDatasetRequest {
|
|
|
438
454
|
* <ul>
|
|
439
455
|
* <li>
|
|
440
456
|
* <p>
|
|
441
|
-
* <code>TABULAR</code>
|
|
457
|
+
* <code>TABULAR</code> – Data is structured in a tabular format.</p>
|
|
442
458
|
* </li>
|
|
443
459
|
* <li>
|
|
444
460
|
* <p>
|
|
445
|
-
* <code>NON_TABULAR</code>
|
|
461
|
+
* <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
|
|
446
462
|
* </li>
|
|
447
463
|
* </ul>
|
|
448
464
|
*/
|
|
@@ -502,11 +518,11 @@ export interface DataViewDestinationTypeParams {
|
|
|
502
518
|
* <ul>
|
|
503
519
|
* <li>
|
|
504
520
|
* <p>
|
|
505
|
-
* <code>GLUE_TABLE</code>
|
|
521
|
+
* <code>GLUE_TABLE</code> – Glue table destination type.</p>
|
|
506
522
|
* </li>
|
|
507
523
|
* <li>
|
|
508
524
|
* <p>
|
|
509
|
-
* <code>S3</code>
|
|
525
|
+
* <code>S3</code> – S3 destination type.</p>
|
|
510
526
|
* </li>
|
|
511
527
|
* </ul>
|
|
512
528
|
*/
|
|
@@ -516,11 +532,11 @@ export interface DataViewDestinationTypeParams {
|
|
|
516
532
|
* <ul>
|
|
517
533
|
* <li>
|
|
518
534
|
* <p>
|
|
519
|
-
* <code>PARQUET</code>
|
|
535
|
+
* <code>PARQUET</code> – Parquet export file format.</p>
|
|
520
536
|
* </li>
|
|
521
537
|
* <li>
|
|
522
538
|
* <p>
|
|
523
|
-
* <code>DELIMITED_TEXT</code>
|
|
539
|
+
* <code>DELIMITED_TEXT</code> – Delimited text export file format.</p>
|
|
524
540
|
* </li>
|
|
525
541
|
* </ul>
|
|
526
542
|
*/
|
|
@@ -573,7 +589,7 @@ export interface CreateDataViewRequest {
|
|
|
573
589
|
*/
|
|
574
590
|
partitionColumns?: string[];
|
|
575
591
|
/**
|
|
576
|
-
* <p>Beginning time to use for the Dataview. The value is determined as
|
|
592
|
+
* <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>
|
|
577
593
|
*/
|
|
578
594
|
asOfTimestamp?: number;
|
|
579
595
|
/**
|
|
@@ -606,6 +622,144 @@ export declare namespace CreateDataViewResponse {
|
|
|
606
622
|
*/
|
|
607
623
|
const filterSensitiveLog: (obj: CreateDataViewResponse) => any;
|
|
608
624
|
}
|
|
625
|
+
export interface CreatePermissionGroupRequest {
|
|
626
|
+
/**
|
|
627
|
+
* <p>The name of the permission group.</p>
|
|
628
|
+
*/
|
|
629
|
+
name: string | undefined;
|
|
630
|
+
/**
|
|
631
|
+
* <p>A brief description for the permission group.</p>
|
|
632
|
+
*/
|
|
633
|
+
description?: string;
|
|
634
|
+
/**
|
|
635
|
+
* <p>The option to indicate FinSpace application permissions that are granted to a specific group.</p>
|
|
636
|
+
* <ul>
|
|
637
|
+
* <li>
|
|
638
|
+
* <p>
|
|
639
|
+
* <code>CreateDataset</code> – Group members can create new datasets.</p>
|
|
640
|
+
* </li>
|
|
641
|
+
* <li>
|
|
642
|
+
* <p>
|
|
643
|
+
* <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p>
|
|
644
|
+
* </li>
|
|
645
|
+
* <li>
|
|
646
|
+
* <p>
|
|
647
|
+
* <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p>
|
|
648
|
+
* </li>
|
|
649
|
+
* <li>
|
|
650
|
+
* <p>
|
|
651
|
+
* <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p>
|
|
652
|
+
* </li>
|
|
653
|
+
* <li>
|
|
654
|
+
* <p>
|
|
655
|
+
* <code>ViewAuditData</code> – Group members can view audit data.</p>
|
|
656
|
+
* </li>
|
|
657
|
+
* <li>
|
|
658
|
+
* <p>
|
|
659
|
+
* <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p>
|
|
660
|
+
* </li>
|
|
661
|
+
* <li>
|
|
662
|
+
* <p>
|
|
663
|
+
* <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
|
|
664
|
+
* </li>
|
|
665
|
+
* </ul>
|
|
666
|
+
*/
|
|
667
|
+
applicationPermissions: (ApplicationPermission | string)[] | undefined;
|
|
668
|
+
/**
|
|
669
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
670
|
+
*/
|
|
671
|
+
clientToken?: string;
|
|
672
|
+
}
|
|
673
|
+
export declare namespace CreatePermissionGroupRequest {
|
|
674
|
+
/**
|
|
675
|
+
* @internal
|
|
676
|
+
*/
|
|
677
|
+
const filterSensitiveLog: (obj: CreatePermissionGroupRequest) => any;
|
|
678
|
+
}
|
|
679
|
+
export interface CreatePermissionGroupResponse {
|
|
680
|
+
/**
|
|
681
|
+
* <p>The unique identifier for the permission group.</p>
|
|
682
|
+
*/
|
|
683
|
+
permissionGroupId?: string;
|
|
684
|
+
}
|
|
685
|
+
export declare namespace CreatePermissionGroupResponse {
|
|
686
|
+
/**
|
|
687
|
+
* @internal
|
|
688
|
+
*/
|
|
689
|
+
const filterSensitiveLog: (obj: CreatePermissionGroupResponse) => any;
|
|
690
|
+
}
|
|
691
|
+
export declare enum UserType {
|
|
692
|
+
APP_USER = "APP_USER",
|
|
693
|
+
SUPER_USER = "SUPER_USER"
|
|
694
|
+
}
|
|
695
|
+
export interface CreateUserRequest {
|
|
696
|
+
/**
|
|
697
|
+
* <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>
|
|
698
|
+
*/
|
|
699
|
+
emailAddress: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* <p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p>
|
|
702
|
+
* <ul>
|
|
703
|
+
* <li>
|
|
704
|
+
* <p>
|
|
705
|
+
* <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p>
|
|
706
|
+
* </li>
|
|
707
|
+
* <li>
|
|
708
|
+
* <p>
|
|
709
|
+
* <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p>
|
|
710
|
+
* </li>
|
|
711
|
+
* </ul>
|
|
712
|
+
*/
|
|
713
|
+
type: UserType | string | undefined;
|
|
714
|
+
/**
|
|
715
|
+
* <p>The first name of the user that you want to register.</p>
|
|
716
|
+
*/
|
|
717
|
+
firstName?: string;
|
|
718
|
+
/**
|
|
719
|
+
* <p>The last name of the user that you want to register.</p>
|
|
720
|
+
*/
|
|
721
|
+
lastName?: string;
|
|
722
|
+
/**
|
|
723
|
+
* <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>
|
|
724
|
+
* <ul>
|
|
725
|
+
* <li>
|
|
726
|
+
* <p>
|
|
727
|
+
* <code>ENABLED</code> – The user has permissions to use the APIs.</p>
|
|
728
|
+
* </li>
|
|
729
|
+
* <li>
|
|
730
|
+
* <p>
|
|
731
|
+
* <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
|
|
732
|
+
* </li>
|
|
733
|
+
* </ul>
|
|
734
|
+
*/
|
|
735
|
+
ApiAccess?: ApiAccess | string;
|
|
736
|
+
/**
|
|
737
|
+
* <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>
|
|
738
|
+
*/
|
|
739
|
+
apiAccessPrincipalArn?: string;
|
|
740
|
+
/**
|
|
741
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
742
|
+
*/
|
|
743
|
+
clientToken?: string;
|
|
744
|
+
}
|
|
745
|
+
export declare namespace CreateUserRequest {
|
|
746
|
+
/**
|
|
747
|
+
* @internal
|
|
748
|
+
*/
|
|
749
|
+
const filterSensitiveLog: (obj: CreateUserRequest) => any;
|
|
750
|
+
}
|
|
751
|
+
export interface CreateUserResponse {
|
|
752
|
+
/**
|
|
753
|
+
* <p>The unique identifier for the user.</p>
|
|
754
|
+
*/
|
|
755
|
+
userId?: string;
|
|
756
|
+
}
|
|
757
|
+
export declare namespace CreateUserResponse {
|
|
758
|
+
/**
|
|
759
|
+
* @internal
|
|
760
|
+
*/
|
|
761
|
+
const filterSensitiveLog: (obj: CreateUserResponse) => any;
|
|
762
|
+
}
|
|
609
763
|
/**
|
|
610
764
|
* The request for a DeleteDataset operation.
|
|
611
765
|
*/
|
|
@@ -640,6 +794,90 @@ export declare namespace DeleteDatasetResponse {
|
|
|
640
794
|
*/
|
|
641
795
|
const filterSensitiveLog: (obj: DeleteDatasetResponse) => any;
|
|
642
796
|
}
|
|
797
|
+
export interface DeletePermissionGroupRequest {
|
|
798
|
+
/**
|
|
799
|
+
* <p>The unique identifier for the permission group that you want to delete.</p>
|
|
800
|
+
*/
|
|
801
|
+
permissionGroupId: string | undefined;
|
|
802
|
+
/**
|
|
803
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
804
|
+
*/
|
|
805
|
+
clientToken?: string;
|
|
806
|
+
}
|
|
807
|
+
export declare namespace DeletePermissionGroupRequest {
|
|
808
|
+
/**
|
|
809
|
+
* @internal
|
|
810
|
+
*/
|
|
811
|
+
const filterSensitiveLog: (obj: DeletePermissionGroupRequest) => any;
|
|
812
|
+
}
|
|
813
|
+
export interface DeletePermissionGroupResponse {
|
|
814
|
+
/**
|
|
815
|
+
* <p>The unique identifier for the deleted permission group.</p>
|
|
816
|
+
*/
|
|
817
|
+
permissionGroupId?: string;
|
|
818
|
+
}
|
|
819
|
+
export declare namespace DeletePermissionGroupResponse {
|
|
820
|
+
/**
|
|
821
|
+
* @internal
|
|
822
|
+
*/
|
|
823
|
+
const filterSensitiveLog: (obj: DeletePermissionGroupResponse) => any;
|
|
824
|
+
}
|
|
825
|
+
export interface DisableUserRequest {
|
|
826
|
+
/**
|
|
827
|
+
* <p>The unique identifier for the user account that you want to disable.</p>
|
|
828
|
+
*/
|
|
829
|
+
userId: string | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
832
|
+
*/
|
|
833
|
+
clientToken?: string;
|
|
834
|
+
}
|
|
835
|
+
export declare namespace DisableUserRequest {
|
|
836
|
+
/**
|
|
837
|
+
* @internal
|
|
838
|
+
*/
|
|
839
|
+
const filterSensitiveLog: (obj: DisableUserRequest) => any;
|
|
840
|
+
}
|
|
841
|
+
export interface DisableUserResponse {
|
|
842
|
+
/**
|
|
843
|
+
* <p>The unique identifier for the disabled user account.</p>
|
|
844
|
+
*/
|
|
845
|
+
userId?: string;
|
|
846
|
+
}
|
|
847
|
+
export declare namespace DisableUserResponse {
|
|
848
|
+
/**
|
|
849
|
+
* @internal
|
|
850
|
+
*/
|
|
851
|
+
const filterSensitiveLog: (obj: DisableUserResponse) => any;
|
|
852
|
+
}
|
|
853
|
+
export interface EnableUserRequest {
|
|
854
|
+
/**
|
|
855
|
+
* <p>The unique identifier for the user account that you want to enable.</p>
|
|
856
|
+
*/
|
|
857
|
+
userId: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
860
|
+
*/
|
|
861
|
+
clientToken?: string;
|
|
862
|
+
}
|
|
863
|
+
export declare namespace EnableUserRequest {
|
|
864
|
+
/**
|
|
865
|
+
* @internal
|
|
866
|
+
*/
|
|
867
|
+
const filterSensitiveLog: (obj: EnableUserRequest) => any;
|
|
868
|
+
}
|
|
869
|
+
export interface EnableUserResponse {
|
|
870
|
+
/**
|
|
871
|
+
* <p>The unique identifier for the enabled user account.</p>
|
|
872
|
+
*/
|
|
873
|
+
userId?: string;
|
|
874
|
+
}
|
|
875
|
+
export declare namespace EnableUserResponse {
|
|
876
|
+
/**
|
|
877
|
+
* @internal
|
|
878
|
+
*/
|
|
879
|
+
const filterSensitiveLog: (obj: EnableUserResponse) => any;
|
|
880
|
+
}
|
|
643
881
|
/**
|
|
644
882
|
* Request to describe a changeset.
|
|
645
883
|
*/
|
|
@@ -682,40 +920,40 @@ export interface ChangesetErrorInfo {
|
|
|
682
920
|
* <ul>
|
|
683
921
|
* <li>
|
|
684
922
|
* <p>
|
|
685
|
-
* <code>VALIDATION</code>
|
|
923
|
+
* <code>VALIDATION</code> – The inputs to this request are invalid.</p>
|
|
686
924
|
* </li>
|
|
687
925
|
* <li>
|
|
688
926
|
* <p>
|
|
689
|
-
* <code>SERVICE_QUOTA_EXCEEDED</code>
|
|
927
|
+
* <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please
|
|
690
928
|
* contact AWS support to increase quotas.</p>
|
|
691
929
|
* </li>
|
|
692
930
|
* <li>
|
|
693
931
|
* <p>
|
|
694
|
-
* <code>ACCESS_DENIED</code>
|
|
932
|
+
* <code>ACCESS_DENIED</code> – Missing required permission to perform this
|
|
695
933
|
* request.</p>
|
|
696
934
|
* </li>
|
|
697
935
|
* <li>
|
|
698
936
|
* <p>
|
|
699
|
-
* <code>RESOURCE_NOT_FOUND</code>
|
|
937
|
+
* <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not
|
|
700
938
|
* found.</p>
|
|
701
939
|
* </li>
|
|
702
940
|
* <li>
|
|
703
941
|
* <p>
|
|
704
|
-
* <code>THROTTLING</code>
|
|
942
|
+
* <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process
|
|
705
943
|
* the request.</p>
|
|
706
944
|
* </li>
|
|
707
945
|
* <li>
|
|
708
946
|
* <p>
|
|
709
|
-
* <code>INTERNAL_SERVICE_EXCEPTION</code>
|
|
947
|
+
* <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has
|
|
710
948
|
* occurred.</p>
|
|
711
949
|
* </li>
|
|
712
950
|
* <li>
|
|
713
951
|
* <p>
|
|
714
|
-
* <code>CANCELLED</code>
|
|
952
|
+
* <code>CANCELLED</code> – Cancelled.</p>
|
|
715
953
|
* </li>
|
|
716
954
|
* <li>
|
|
717
955
|
* <p>
|
|
718
|
-
* <code>USER_RECOVERABLE</code>
|
|
956
|
+
* <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p>
|
|
719
957
|
* </li>
|
|
720
958
|
* </ul>
|
|
721
959
|
*/
|
|
@@ -755,15 +993,15 @@ export interface GetChangesetResponse {
|
|
|
755
993
|
* <ul>
|
|
756
994
|
* <li>
|
|
757
995
|
* <p>
|
|
758
|
-
* <code>REPLACE</code>
|
|
996
|
+
* <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p>
|
|
759
997
|
* </li>
|
|
760
998
|
* <li>
|
|
761
999
|
* <p>
|
|
762
|
-
* <code>APPEND</code>
|
|
1000
|
+
* <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p>
|
|
763
1001
|
* </li>
|
|
764
1002
|
* <li>
|
|
765
1003
|
* <p>
|
|
766
|
-
* <code>MODIFY</code>
|
|
1004
|
+
* <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
|
|
767
1005
|
* </li>
|
|
768
1006
|
* </ul>
|
|
769
1007
|
*/
|
|
@@ -781,7 +1019,7 @@ export interface GetChangesetResponse {
|
|
|
781
1019
|
[key: string]: string;
|
|
782
1020
|
};
|
|
783
1021
|
/**
|
|
784
|
-
* <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as
|
|
1022
|
+
* <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>
|
|
785
1023
|
*/
|
|
786
1024
|
createTime?: number;
|
|
787
1025
|
/**
|
|
@@ -793,11 +1031,11 @@ export interface GetChangesetResponse {
|
|
|
793
1031
|
*/
|
|
794
1032
|
errorInfo?: ChangesetErrorInfo;
|
|
795
1033
|
/**
|
|
796
|
-
* <p>Time until which the Changeset is active. The value is determined as
|
|
1034
|
+
* <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>
|
|
797
1035
|
*/
|
|
798
1036
|
activeUntilTimestamp?: number;
|
|
799
1037
|
/**
|
|
800
|
-
* <p>Beginning time from which the Changeset is active. The value is determined as
|
|
1038
|
+
* <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>
|
|
801
1039
|
*/
|
|
802
1040
|
activeFromTimestamp?: number;
|
|
803
1041
|
/**
|
|
@@ -857,11 +1095,11 @@ export interface GetDatasetResponse {
|
|
|
857
1095
|
* <ul>
|
|
858
1096
|
* <li>
|
|
859
1097
|
* <p>
|
|
860
|
-
* <code>TABULAR</code>
|
|
1098
|
+
* <code>TABULAR</code> – Data is structured in a tabular format.</p>
|
|
861
1099
|
* </li>
|
|
862
1100
|
* <li>
|
|
863
1101
|
* <p>
|
|
864
|
-
* <code>NON_TABULAR</code>
|
|
1102
|
+
* <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
|
|
865
1103
|
* </li>
|
|
866
1104
|
* </ul>
|
|
867
1105
|
*/
|
|
@@ -871,11 +1109,11 @@ export interface GetDatasetResponse {
|
|
|
871
1109
|
*/
|
|
872
1110
|
datasetDescription?: string;
|
|
873
1111
|
/**
|
|
874
|
-
* <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as
|
|
1112
|
+
* <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>
|
|
875
1113
|
*/
|
|
876
1114
|
createTime?: number;
|
|
877
1115
|
/**
|
|
878
|
-
* <p>The last time that the Dataset was modified. The value is determined as
|
|
1116
|
+
* <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>
|
|
879
1117
|
*/
|
|
880
1118
|
lastModifiedTime?: number;
|
|
881
1119
|
/**
|
|
@@ -891,19 +1129,19 @@ export interface GetDatasetResponse {
|
|
|
891
1129
|
* <ul>
|
|
892
1130
|
* <li>
|
|
893
1131
|
* <p>
|
|
894
|
-
* <code>PENDING</code>
|
|
1132
|
+
* <code>PENDING</code> – Dataset is pending creation.</p>
|
|
895
1133
|
* </li>
|
|
896
1134
|
* <li>
|
|
897
1135
|
* <p>
|
|
898
|
-
* <code>FAILED</code>
|
|
1136
|
+
* <code>FAILED</code> – Dataset creation has failed.</p>
|
|
899
1137
|
* </li>
|
|
900
1138
|
* <li>
|
|
901
1139
|
* <p>
|
|
902
|
-
* <code>SUCCESS</code>
|
|
1140
|
+
* <code>SUCCESS</code> – Dataset creation has succeeded.</p>
|
|
903
1141
|
* </li>
|
|
904
1142
|
* <li>
|
|
905
1143
|
* <p>
|
|
906
|
-
* <code>RUNNING</code>
|
|
1144
|
+
* <code>RUNNING</code> – Dataset creation is running.</p>
|
|
907
1145
|
* </li>
|
|
908
1146
|
* </ul>
|
|
909
1147
|
*/
|
|
@@ -947,40 +1185,40 @@ export interface DataViewErrorInfo {
|
|
|
947
1185
|
* <ul>
|
|
948
1186
|
* <li>
|
|
949
1187
|
* <p>
|
|
950
|
-
* <code>VALIDATION</code>
|
|
1188
|
+
* <code>VALIDATION</code> – The inputs to this request are invalid.</p>
|
|
951
1189
|
* </li>
|
|
952
1190
|
* <li>
|
|
953
1191
|
* <p>
|
|
954
|
-
* <code>SERVICE_QUOTA_EXCEEDED</code>
|
|
1192
|
+
* <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please
|
|
955
1193
|
* contact AWS support to increase quotas.</p>
|
|
956
1194
|
* </li>
|
|
957
1195
|
* <li>
|
|
958
1196
|
* <p>
|
|
959
|
-
* <code>ACCESS_DENIED</code>
|
|
1197
|
+
* <code>ACCESS_DENIED</code> – Missing required permission to perform this
|
|
960
1198
|
* request.</p>
|
|
961
1199
|
* </li>
|
|
962
1200
|
* <li>
|
|
963
1201
|
* <p>
|
|
964
|
-
* <code>RESOURCE_NOT_FOUND</code>
|
|
1202
|
+
* <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not
|
|
965
1203
|
* found.</p>
|
|
966
1204
|
* </li>
|
|
967
1205
|
* <li>
|
|
968
1206
|
* <p>
|
|
969
|
-
* <code>THROTTLING</code>
|
|
1207
|
+
* <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process
|
|
970
1208
|
* the request.</p>
|
|
971
1209
|
* </li>
|
|
972
1210
|
* <li>
|
|
973
1211
|
* <p>
|
|
974
|
-
* <code>INTERNAL_SERVICE_EXCEPTION</code>
|
|
1212
|
+
* <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has
|
|
975
1213
|
* occurred.</p>
|
|
976
1214
|
* </li>
|
|
977
1215
|
* <li>
|
|
978
1216
|
* <p>
|
|
979
|
-
* <code>CANCELLED</code>
|
|
1217
|
+
* <code>CANCELLED</code> – Cancelled.</p>
|
|
980
1218
|
* </li>
|
|
981
1219
|
* <li>
|
|
982
1220
|
* <p>
|
|
983
|
-
* <code>USER_RECOVERABLE</code>
|
|
1221
|
+
* <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p>
|
|
984
1222
|
* </li>
|
|
985
1223
|
* </ul>
|
|
986
1224
|
*/
|
|
@@ -1019,7 +1257,7 @@ export interface GetDataViewResponse {
|
|
|
1019
1257
|
*/
|
|
1020
1258
|
datasetId?: string;
|
|
1021
1259
|
/**
|
|
1022
|
-
* <p>Time range to use for the Dataview. The value is determined as
|
|
1260
|
+
* <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>
|
|
1023
1261
|
*/
|
|
1024
1262
|
asOfTimestamp?: number;
|
|
1025
1263
|
/**
|
|
@@ -1027,11 +1265,11 @@ export interface GetDataViewResponse {
|
|
|
1027
1265
|
*/
|
|
1028
1266
|
errorInfo?: DataViewErrorInfo;
|
|
1029
1267
|
/**
|
|
1030
|
-
* <p>The last time that a Dataview was modified. The value is determined as
|
|
1268
|
+
* <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>
|
|
1031
1269
|
*/
|
|
1032
1270
|
lastModifiedTime?: number;
|
|
1033
1271
|
/**
|
|
1034
|
-
* <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as
|
|
1272
|
+
* <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>
|
|
1035
1273
|
*/
|
|
1036
1274
|
createTime?: number;
|
|
1037
1275
|
/**
|
|
@@ -1055,35 +1293,35 @@ export interface GetDataViewResponse {
|
|
|
1055
1293
|
* <ul>
|
|
1056
1294
|
* <li>
|
|
1057
1295
|
* <p>
|
|
1058
|
-
* <code>RUNNING</code>
|
|
1296
|
+
* <code>RUNNING</code> – Dataview creation is running.</p>
|
|
1059
1297
|
* </li>
|
|
1060
1298
|
* <li>
|
|
1061
1299
|
* <p>
|
|
1062
|
-
* <code>STARTING</code>
|
|
1300
|
+
* <code>STARTING</code> – Dataview creation is starting.</p>
|
|
1063
1301
|
* </li>
|
|
1064
1302
|
* <li>
|
|
1065
1303
|
* <p>
|
|
1066
|
-
* <code>FAILED</code>
|
|
1304
|
+
* <code>FAILED</code> – Dataview creation has failed.</p>
|
|
1067
1305
|
* </li>
|
|
1068
1306
|
* <li>
|
|
1069
1307
|
* <p>
|
|
1070
|
-
* <code>CANCELLED</code>
|
|
1308
|
+
* <code>CANCELLED</code> – Dataview creation has been cancelled.</p>
|
|
1071
1309
|
* </li>
|
|
1072
1310
|
* <li>
|
|
1073
1311
|
* <p>
|
|
1074
|
-
* <code>TIMEOUT</code>
|
|
1312
|
+
* <code>TIMEOUT</code> – Dataview creation has timed out.</p>
|
|
1075
1313
|
* </li>
|
|
1076
1314
|
* <li>
|
|
1077
1315
|
* <p>
|
|
1078
|
-
* <code>SUCCESS</code>
|
|
1316
|
+
* <code>SUCCESS</code> – Dataview creation has succeeded.</p>
|
|
1079
1317
|
* </li>
|
|
1080
1318
|
* <li>
|
|
1081
1319
|
* <p>
|
|
1082
|
-
* <code>PENDING</code>
|
|
1320
|
+
* <code>PENDING</code> – Dataview creation is pending.</p>
|
|
1083
1321
|
* </li>
|
|
1084
1322
|
* <li>
|
|
1085
1323
|
* <p>
|
|
1086
|
-
* <code>FAILED_CLEANUP_FAILED</code>
|
|
1324
|
+
* <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p>
|
|
1087
1325
|
* </li>
|
|
1088
1326
|
* </ul>
|
|
1089
1327
|
*/
|
|
@@ -1156,6 +1394,119 @@ export declare namespace GetProgrammaticAccessCredentialsResponse {
|
|
|
1156
1394
|
*/
|
|
1157
1395
|
const filterSensitiveLog: (obj: GetProgrammaticAccessCredentialsResponse) => any;
|
|
1158
1396
|
}
|
|
1397
|
+
export interface GetUserRequest {
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The unique identifier of the user to get data for.</p>
|
|
1400
|
+
*/
|
|
1401
|
+
userId: string | undefined;
|
|
1402
|
+
}
|
|
1403
|
+
export declare namespace GetUserRequest {
|
|
1404
|
+
/**
|
|
1405
|
+
* @internal
|
|
1406
|
+
*/
|
|
1407
|
+
const filterSensitiveLog: (obj: GetUserRequest) => any;
|
|
1408
|
+
}
|
|
1409
|
+
export declare enum UserStatus {
|
|
1410
|
+
CREATING = "CREATING",
|
|
1411
|
+
DISABLED = "DISABLED",
|
|
1412
|
+
ENABLED = "ENABLED"
|
|
1413
|
+
}
|
|
1414
|
+
export interface GetUserResponse {
|
|
1415
|
+
/**
|
|
1416
|
+
* <p>The unique identifier for the user account that is retrieved.</p>
|
|
1417
|
+
*/
|
|
1418
|
+
userId?: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* <p>The current status of the user account. </p>
|
|
1421
|
+
* <ul>
|
|
1422
|
+
* <li>
|
|
1423
|
+
* <p>
|
|
1424
|
+
* <code>CREATING</code> – The user account creation is in progress.</p>
|
|
1425
|
+
* </li>
|
|
1426
|
+
* <li>
|
|
1427
|
+
* <p>
|
|
1428
|
+
* <code>ENABLED</code> – The user account is created and is currently active.</p>
|
|
1429
|
+
* </li>
|
|
1430
|
+
* <li>
|
|
1431
|
+
* <p>
|
|
1432
|
+
* <code>DISABLED</code> – The user account is currently inactive.</p>
|
|
1433
|
+
* </li>
|
|
1434
|
+
* </ul>
|
|
1435
|
+
*/
|
|
1436
|
+
status?: UserStatus | string;
|
|
1437
|
+
/**
|
|
1438
|
+
* <p>The first name of the user.</p>
|
|
1439
|
+
*/
|
|
1440
|
+
firstName?: string;
|
|
1441
|
+
/**
|
|
1442
|
+
* <p>The last name of the user.</p>
|
|
1443
|
+
*/
|
|
1444
|
+
lastName?: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>The email address that is associated with the user.</p>
|
|
1447
|
+
*/
|
|
1448
|
+
emailAddress?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>Indicates the type of user. </p>
|
|
1451
|
+
* <ul>
|
|
1452
|
+
* <li>
|
|
1453
|
+
* <p>
|
|
1454
|
+
* <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p>
|
|
1455
|
+
* </li>
|
|
1456
|
+
* </ul>
|
|
1457
|
+
* <ul>
|
|
1458
|
+
* <li>
|
|
1459
|
+
* <p>
|
|
1460
|
+
* <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p>
|
|
1461
|
+
* </li>
|
|
1462
|
+
* </ul>
|
|
1463
|
+
*/
|
|
1464
|
+
type?: UserType | string;
|
|
1465
|
+
/**
|
|
1466
|
+
* <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>
|
|
1467
|
+
* <ul>
|
|
1468
|
+
* <li>
|
|
1469
|
+
* <p>
|
|
1470
|
+
* <code>ENABLED</code> – The user has permissions to use the APIs.</p>
|
|
1471
|
+
* </li>
|
|
1472
|
+
* <li>
|
|
1473
|
+
* <p>
|
|
1474
|
+
* <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
|
|
1475
|
+
* </li>
|
|
1476
|
+
* </ul>
|
|
1477
|
+
*/
|
|
1478
|
+
apiAccess?: ApiAccess | string;
|
|
1479
|
+
/**
|
|
1480
|
+
* <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>
|
|
1481
|
+
*/
|
|
1482
|
+
apiAccessPrincipalArn?: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* <p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
1485
|
+
*/
|
|
1486
|
+
createTime?: number;
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.</p>
|
|
1489
|
+
*/
|
|
1490
|
+
lastEnabledTime?: number;
|
|
1491
|
+
/**
|
|
1492
|
+
* <p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>
|
|
1493
|
+
*/
|
|
1494
|
+
lastDisabledTime?: number;
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.</p>
|
|
1497
|
+
*/
|
|
1498
|
+
lastModifiedTime?: number;
|
|
1499
|
+
/**
|
|
1500
|
+
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>
|
|
1501
|
+
*/
|
|
1502
|
+
lastLoginTime?: number;
|
|
1503
|
+
}
|
|
1504
|
+
export declare namespace GetUserResponse {
|
|
1505
|
+
/**
|
|
1506
|
+
* @internal
|
|
1507
|
+
*/
|
|
1508
|
+
const filterSensitiveLog: (obj: GetUserResponse) => any;
|
|
1509
|
+
}
|
|
1159
1510
|
export declare enum LocationType {
|
|
1160
1511
|
INGESTION = "INGESTION",
|
|
1161
1512
|
SAGEMAKER = "SAGEMAKER"
|
|
@@ -1166,12 +1517,12 @@ export interface GetWorkingLocationRequest {
|
|
|
1166
1517
|
* <ul>
|
|
1167
1518
|
* <li>
|
|
1168
1519
|
* <p>
|
|
1169
|
-
* <code>SAGEMAKER</code>
|
|
1520
|
+
* <code>SAGEMAKER</code> – Use the Amazon S3 location as a temporary location to store data content when
|
|
1170
1521
|
* working with FinSpace Notebooks that run on SageMaker studio.</p>
|
|
1171
1522
|
* </li>
|
|
1172
1523
|
* <li>
|
|
1173
1524
|
* <p>
|
|
1174
|
-
* <code>INGESTION</code>
|
|
1525
|
+
* <code>INGESTION</code> – Use the Amazon S3 location as a staging location to copy your
|
|
1175
1526
|
* data content and then use the location with the Changeset creation operation.</p>
|
|
1176
1527
|
* </li>
|
|
1177
1528
|
* </ul>
|
|
@@ -1217,7 +1568,7 @@ export interface ListChangesetsRequest {
|
|
|
1217
1568
|
*/
|
|
1218
1569
|
maxResults?: number;
|
|
1219
1570
|
/**
|
|
1220
|
-
* <p>A token
|
|
1571
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1221
1572
|
*/
|
|
1222
1573
|
nextToken?: string;
|
|
1223
1574
|
}
|
|
@@ -1248,17 +1599,17 @@ export interface ChangesetSummary {
|
|
|
1248
1599
|
* <ul>
|
|
1249
1600
|
* <li>
|
|
1250
1601
|
* <p>
|
|
1251
|
-
* <code>REPLACE</code>
|
|
1602
|
+
* <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded
|
|
1252
1603
|
* Changesets.</p>
|
|
1253
1604
|
* </li>
|
|
1254
1605
|
* <li>
|
|
1255
1606
|
* <p>
|
|
1256
|
-
* <code>APPEND</code>
|
|
1607
|
+
* <code>APPEND</code> – Changeset is considered as an addition to the end of all prior
|
|
1257
1608
|
* loaded Changesets.</p>
|
|
1258
1609
|
* </li>
|
|
1259
1610
|
* <li>
|
|
1260
1611
|
* <p>
|
|
1261
|
-
* <code>MODIFY</code>
|
|
1612
|
+
* <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior
|
|
1262
1613
|
* ingested Changeset.</p>
|
|
1263
1614
|
* </li>
|
|
1264
1615
|
* </ul>
|
|
@@ -1277,7 +1628,7 @@ export interface ChangesetSummary {
|
|
|
1277
1628
|
[key: string]: string;
|
|
1278
1629
|
};
|
|
1279
1630
|
/**
|
|
1280
|
-
* <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as
|
|
1631
|
+
* <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>
|
|
1281
1632
|
*/
|
|
1282
1633
|
createTime?: number;
|
|
1283
1634
|
/**
|
|
@@ -1285,23 +1636,23 @@ export interface ChangesetSummary {
|
|
|
1285
1636
|
* <ul>
|
|
1286
1637
|
* <li>
|
|
1287
1638
|
* <p>
|
|
1288
|
-
* <code>PENDING</code>
|
|
1639
|
+
* <code>PENDING</code> – Changeset is pending creation.</p>
|
|
1289
1640
|
* </li>
|
|
1290
1641
|
* <li>
|
|
1291
1642
|
* <p>
|
|
1292
|
-
* <code>FAILED</code>
|
|
1643
|
+
* <code>FAILED</code> – Changeset creation has failed.</p>
|
|
1293
1644
|
* </li>
|
|
1294
1645
|
* <li>
|
|
1295
1646
|
* <p>
|
|
1296
|
-
* <code>SUCCESS</code>
|
|
1647
|
+
* <code>SUCCESS</code> – Changeset creation has succeeded.</p>
|
|
1297
1648
|
* </li>
|
|
1298
1649
|
* <li>
|
|
1299
1650
|
* <p>
|
|
1300
|
-
* <code>RUNNING</code>
|
|
1651
|
+
* <code>RUNNING</code> – Changeset creation is running.</p>
|
|
1301
1652
|
* </li>
|
|
1302
1653
|
* <li>
|
|
1303
1654
|
* <p>
|
|
1304
|
-
* <code>STOP_REQUESTED</code>
|
|
1655
|
+
* <code>STOP_REQUESTED</code> – User requested Changeset creation to stop.</p>
|
|
1305
1656
|
* </li>
|
|
1306
1657
|
* </ul>
|
|
1307
1658
|
*/
|
|
@@ -1311,11 +1662,11 @@ export interface ChangesetSummary {
|
|
|
1311
1662
|
*/
|
|
1312
1663
|
errorInfo?: ChangesetErrorInfo;
|
|
1313
1664
|
/**
|
|
1314
|
-
* <p>Time until which the Changeset is active. The value is determined as
|
|
1665
|
+
* <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>
|
|
1315
1666
|
*/
|
|
1316
1667
|
activeUntilTimestamp?: number;
|
|
1317
1668
|
/**
|
|
1318
|
-
* <p>Beginning time from which the Changeset is active. The value is determined as
|
|
1669
|
+
* <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>
|
|
1319
1670
|
*/
|
|
1320
1671
|
activeFromTimestamp?: number;
|
|
1321
1672
|
/**
|
|
@@ -1342,7 +1693,7 @@ export interface ListChangesetsResponse {
|
|
|
1342
1693
|
*/
|
|
1343
1694
|
changesets?: ChangesetSummary[];
|
|
1344
1695
|
/**
|
|
1345
|
-
* <p>A token
|
|
1696
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1346
1697
|
*/
|
|
1347
1698
|
nextToken?: string;
|
|
1348
1699
|
}
|
|
@@ -1357,7 +1708,7 @@ export declare namespace ListChangesetsResponse {
|
|
|
1357
1708
|
*/
|
|
1358
1709
|
export interface ListDatasetsRequest {
|
|
1359
1710
|
/**
|
|
1360
|
-
* <p>A token
|
|
1711
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1361
1712
|
*/
|
|
1362
1713
|
nextToken?: string;
|
|
1363
1714
|
/**
|
|
@@ -1392,11 +1743,11 @@ export interface Dataset {
|
|
|
1392
1743
|
* <ul>
|
|
1393
1744
|
* <li>
|
|
1394
1745
|
* <p>
|
|
1395
|
-
* <code>TABULAR</code>
|
|
1746
|
+
* <code>TABULAR</code> – Data is structured in a tabular format.</p>
|
|
1396
1747
|
* </li>
|
|
1397
1748
|
* <li>
|
|
1398
1749
|
* <p>
|
|
1399
|
-
* <code>NON_TABULAR</code>
|
|
1750
|
+
* <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
|
|
1400
1751
|
* </li>
|
|
1401
1752
|
* </ul>
|
|
1402
1753
|
*/
|
|
@@ -1410,11 +1761,11 @@ export interface Dataset {
|
|
|
1410
1761
|
*/
|
|
1411
1762
|
ownerInfo?: DatasetOwnerInfo;
|
|
1412
1763
|
/**
|
|
1413
|
-
* <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as
|
|
1764
|
+
* <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>
|
|
1414
1765
|
*/
|
|
1415
1766
|
createTime?: number;
|
|
1416
1767
|
/**
|
|
1417
|
-
* <p>The last time that the Dataset was modified. The value is determined as
|
|
1768
|
+
* <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>
|
|
1418
1769
|
*/
|
|
1419
1770
|
lastModifiedTime?: number;
|
|
1420
1771
|
/**
|
|
@@ -1441,7 +1792,7 @@ export interface ListDatasetsResponse {
|
|
|
1441
1792
|
*/
|
|
1442
1793
|
datasets?: Dataset[];
|
|
1443
1794
|
/**
|
|
1444
|
-
* <p>A token
|
|
1795
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1445
1796
|
*/
|
|
1446
1797
|
nextToken?: string;
|
|
1447
1798
|
}
|
|
@@ -1460,7 +1811,7 @@ export interface ListDataViewsRequest {
|
|
|
1460
1811
|
*/
|
|
1461
1812
|
datasetId: string | undefined;
|
|
1462
1813
|
/**
|
|
1463
|
-
* <p>A token
|
|
1814
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1464
1815
|
*/
|
|
1465
1816
|
nextToken?: string;
|
|
1466
1817
|
/**
|
|
@@ -1491,7 +1842,7 @@ export interface DataViewSummary {
|
|
|
1491
1842
|
*/
|
|
1492
1843
|
datasetId?: string;
|
|
1493
1844
|
/**
|
|
1494
|
-
* <p>Time range to use for the Dataview. The value is determined as
|
|
1845
|
+
* <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>
|
|
1495
1846
|
*/
|
|
1496
1847
|
asOfTimestamp?: number;
|
|
1497
1848
|
/**
|
|
@@ -1507,35 +1858,35 @@ export interface DataViewSummary {
|
|
|
1507
1858
|
* <ul>
|
|
1508
1859
|
* <li>
|
|
1509
1860
|
* <p>
|
|
1510
|
-
* <code>RUNNING</code>
|
|
1861
|
+
* <code>RUNNING</code> – Dataview creation is running.</p>
|
|
1511
1862
|
* </li>
|
|
1512
1863
|
* <li>
|
|
1513
1864
|
* <p>
|
|
1514
|
-
* <code>STARTING</code>
|
|
1865
|
+
* <code>STARTING</code> – Dataview creation is starting.</p>
|
|
1515
1866
|
* </li>
|
|
1516
1867
|
* <li>
|
|
1517
1868
|
* <p>
|
|
1518
|
-
* <code>FAILED</code>
|
|
1869
|
+
* <code>FAILED</code> – Dataview creation has failed.</p>
|
|
1519
1870
|
* </li>
|
|
1520
1871
|
* <li>
|
|
1521
1872
|
* <p>
|
|
1522
|
-
* <code>CANCELLED</code>
|
|
1873
|
+
* <code>CANCELLED</code> – Dataview creation has been cancelled.</p>
|
|
1523
1874
|
* </li>
|
|
1524
1875
|
* <li>
|
|
1525
1876
|
* <p>
|
|
1526
|
-
* <code>TIMEOUT</code>
|
|
1877
|
+
* <code>TIMEOUT</code> – Dataview creation has timed out.</p>
|
|
1527
1878
|
* </li>
|
|
1528
1879
|
* <li>
|
|
1529
1880
|
* <p>
|
|
1530
|
-
* <code>SUCCESS</code>
|
|
1881
|
+
* <code>SUCCESS</code> – Dataview creation has succeeded.</p>
|
|
1531
1882
|
* </li>
|
|
1532
1883
|
* <li>
|
|
1533
1884
|
* <p>
|
|
1534
|
-
* <code>PENDING</code>
|
|
1885
|
+
* <code>PENDING</code> – Dataview creation is pending.</p>
|
|
1535
1886
|
* </li>
|
|
1536
1887
|
* <li>
|
|
1537
1888
|
* <p>
|
|
1538
|
-
* <code>FAILED_CLEANUP_FAILED</code>
|
|
1889
|
+
* <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p>
|
|
1539
1890
|
* </li>
|
|
1540
1891
|
* </ul>
|
|
1541
1892
|
*/
|
|
@@ -1553,11 +1904,11 @@ export interface DataViewSummary {
|
|
|
1553
1904
|
*/
|
|
1554
1905
|
autoUpdate?: boolean;
|
|
1555
1906
|
/**
|
|
1556
|
-
* <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as
|
|
1907
|
+
* <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>
|
|
1557
1908
|
*/
|
|
1558
1909
|
createTime?: number;
|
|
1559
1910
|
/**
|
|
1560
|
-
* <p>The last time that a Dataview was modified. The value is determined as
|
|
1911
|
+
* <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>
|
|
1561
1912
|
*/
|
|
1562
1913
|
lastModifiedTime?: number;
|
|
1563
1914
|
}
|
|
@@ -1569,7 +1920,7 @@ export declare namespace DataViewSummary {
|
|
|
1569
1920
|
}
|
|
1570
1921
|
export interface ListDataViewsResponse {
|
|
1571
1922
|
/**
|
|
1572
|
-
* <p>A token
|
|
1923
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1573
1924
|
*/
|
|
1574
1925
|
nextToken?: string;
|
|
1575
1926
|
/**
|
|
@@ -1583,6 +1934,269 @@ export declare namespace ListDataViewsResponse {
|
|
|
1583
1934
|
*/
|
|
1584
1935
|
const filterSensitiveLog: (obj: ListDataViewsResponse) => any;
|
|
1585
1936
|
}
|
|
1937
|
+
export interface ListPermissionGroupsRequest {
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
1940
|
+
*/
|
|
1941
|
+
nextToken?: string;
|
|
1942
|
+
/**
|
|
1943
|
+
* <p>The maximum number of results per page.</p>
|
|
1944
|
+
*/
|
|
1945
|
+
maxResults: number | undefined;
|
|
1946
|
+
}
|
|
1947
|
+
export declare namespace ListPermissionGroupsRequest {
|
|
1948
|
+
/**
|
|
1949
|
+
* @internal
|
|
1950
|
+
*/
|
|
1951
|
+
const filterSensitiveLog: (obj: ListPermissionGroupsRequest) => any;
|
|
1952
|
+
}
|
|
1953
|
+
/**
|
|
1954
|
+
* <p>The structure for a permission group.</p>
|
|
1955
|
+
*/
|
|
1956
|
+
export interface PermissionGroup {
|
|
1957
|
+
/**
|
|
1958
|
+
* <p> The unique identifier for the permission group.</p>
|
|
1959
|
+
*/
|
|
1960
|
+
permissionGroupId?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* <p>The name of the permission group.</p>
|
|
1963
|
+
*/
|
|
1964
|
+
name?: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* <p> A brief description for the permission group.</p>
|
|
1967
|
+
*/
|
|
1968
|
+
description?: string;
|
|
1969
|
+
/**
|
|
1970
|
+
* <p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
1971
|
+
* <ul>
|
|
1972
|
+
* <li>
|
|
1973
|
+
* <p>
|
|
1974
|
+
* <code>CreateDataset</code> – Group members can create new datasets.</p>
|
|
1975
|
+
* </li>
|
|
1976
|
+
* <li>
|
|
1977
|
+
* <p>
|
|
1978
|
+
* <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p>
|
|
1979
|
+
* </li>
|
|
1980
|
+
* <li>
|
|
1981
|
+
* <p>
|
|
1982
|
+
* <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p>
|
|
1983
|
+
* </li>
|
|
1984
|
+
* <li>
|
|
1985
|
+
* <p>
|
|
1986
|
+
* <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p>
|
|
1987
|
+
* </li>
|
|
1988
|
+
* <li>
|
|
1989
|
+
* <p>
|
|
1990
|
+
* <code>ViewAuditData</code> – Group members can view audit data.</p>
|
|
1991
|
+
* </li>
|
|
1992
|
+
* <li>
|
|
1993
|
+
* <p>
|
|
1994
|
+
* <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p>
|
|
1995
|
+
* </li>
|
|
1996
|
+
* <li>
|
|
1997
|
+
* <p>
|
|
1998
|
+
* <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
|
|
1999
|
+
* </li>
|
|
2000
|
+
* </ul>
|
|
2001
|
+
*/
|
|
2002
|
+
applicationPermissions?: (ApplicationPermission | string)[];
|
|
2003
|
+
/**
|
|
2004
|
+
* <p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
|
|
2005
|
+
* </p>
|
|
2006
|
+
*/
|
|
2007
|
+
createTime?: number;
|
|
2008
|
+
/**
|
|
2009
|
+
* <p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
|
|
2010
|
+
* </p>
|
|
2011
|
+
*/
|
|
2012
|
+
lastModifiedTime?: number;
|
|
2013
|
+
}
|
|
2014
|
+
export declare namespace PermissionGroup {
|
|
2015
|
+
/**
|
|
2016
|
+
* @internal
|
|
2017
|
+
*/
|
|
2018
|
+
const filterSensitiveLog: (obj: PermissionGroup) => any;
|
|
2019
|
+
}
|
|
2020
|
+
export interface ListPermissionGroupsResponse {
|
|
2021
|
+
/**
|
|
2022
|
+
* <p>A list of all the permission groups.</p>
|
|
2023
|
+
*/
|
|
2024
|
+
permissionGroups?: PermissionGroup[];
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
2027
|
+
*/
|
|
2028
|
+
nextToken?: string;
|
|
2029
|
+
}
|
|
2030
|
+
export declare namespace ListPermissionGroupsResponse {
|
|
2031
|
+
/**
|
|
2032
|
+
* @internal
|
|
2033
|
+
*/
|
|
2034
|
+
const filterSensitiveLog: (obj: ListPermissionGroupsResponse) => any;
|
|
2035
|
+
}
|
|
2036
|
+
export interface ListUsersRequest {
|
|
2037
|
+
/**
|
|
2038
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
2039
|
+
*/
|
|
2040
|
+
nextToken?: string;
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>The maximum number of results per page.</p>
|
|
2043
|
+
*/
|
|
2044
|
+
maxResults: number | undefined;
|
|
2045
|
+
}
|
|
2046
|
+
export declare namespace ListUsersRequest {
|
|
2047
|
+
/**
|
|
2048
|
+
* @internal
|
|
2049
|
+
*/
|
|
2050
|
+
const filterSensitiveLog: (obj: ListUsersRequest) => any;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* <p>The details of the user account.</p>
|
|
2054
|
+
*/
|
|
2055
|
+
export interface User {
|
|
2056
|
+
/**
|
|
2057
|
+
* <p>The unique identifier for the user.</p>
|
|
2058
|
+
*/
|
|
2059
|
+
userId?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* <p>The current status of the user account. </p>
|
|
2062
|
+
* <ul>
|
|
2063
|
+
* <li>
|
|
2064
|
+
* <p>
|
|
2065
|
+
* <code>CREATING</code> – The user account creation is in progress.</p>
|
|
2066
|
+
* </li>
|
|
2067
|
+
* <li>
|
|
2068
|
+
* <p>
|
|
2069
|
+
* <code>ENABLED</code> – The user account is created and is currently active.</p>
|
|
2070
|
+
* </li>
|
|
2071
|
+
* <li>
|
|
2072
|
+
* <p>
|
|
2073
|
+
* <code>DISABLED</code> – The user account is currently inactive.</p>
|
|
2074
|
+
* </li>
|
|
2075
|
+
* </ul>
|
|
2076
|
+
*/
|
|
2077
|
+
status?: UserStatus | string;
|
|
2078
|
+
/**
|
|
2079
|
+
* <p>The first name of the user.</p>
|
|
2080
|
+
*/
|
|
2081
|
+
firstName?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* <p> The last name of the user.</p>
|
|
2084
|
+
*/
|
|
2085
|
+
lastName?: string;
|
|
2086
|
+
/**
|
|
2087
|
+
* <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>
|
|
2088
|
+
*/
|
|
2089
|
+
emailAddress?: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* <p> Indicates the type of user.</p>
|
|
2092
|
+
* <ul>
|
|
2093
|
+
* <li>
|
|
2094
|
+
* <p>
|
|
2095
|
+
* <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p>
|
|
2096
|
+
* </li>
|
|
2097
|
+
* <li>
|
|
2098
|
+
* <p>
|
|
2099
|
+
* <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p>
|
|
2100
|
+
* </li>
|
|
2101
|
+
* </ul>
|
|
2102
|
+
*/
|
|
2103
|
+
type?: UserType | string;
|
|
2104
|
+
/**
|
|
2105
|
+
* <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>
|
|
2106
|
+
* <ul>
|
|
2107
|
+
* <li>
|
|
2108
|
+
* <p>
|
|
2109
|
+
* <code>ENABLED</code> – The user has permissions to use the APIs.</p>
|
|
2110
|
+
* </li>
|
|
2111
|
+
* <li>
|
|
2112
|
+
* <p>
|
|
2113
|
+
* <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
|
|
2114
|
+
* </li>
|
|
2115
|
+
* </ul>
|
|
2116
|
+
*/
|
|
2117
|
+
apiAccess?: ApiAccess | string;
|
|
2118
|
+
/**
|
|
2119
|
+
* <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>
|
|
2120
|
+
*/
|
|
2121
|
+
apiAccessPrincipalArn?: string;
|
|
2122
|
+
/**
|
|
2123
|
+
* <p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
2124
|
+
*/
|
|
2125
|
+
createTime?: number;
|
|
2126
|
+
/**
|
|
2127
|
+
* <p> Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
|
|
2128
|
+
* </p>
|
|
2129
|
+
*/
|
|
2130
|
+
lastEnabledTime?: number;
|
|
2131
|
+
/**
|
|
2132
|
+
* <p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>
|
|
2133
|
+
*/
|
|
2134
|
+
lastDisabledTime?: number;
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
|
|
2137
|
+
* </p>
|
|
2138
|
+
*/
|
|
2139
|
+
lastModifiedTime?: number;
|
|
2140
|
+
/**
|
|
2141
|
+
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
|
|
2142
|
+
* </p>
|
|
2143
|
+
*/
|
|
2144
|
+
lastLoginTime?: number;
|
|
2145
|
+
}
|
|
2146
|
+
export declare namespace User {
|
|
2147
|
+
/**
|
|
2148
|
+
* @internal
|
|
2149
|
+
*/
|
|
2150
|
+
const filterSensitiveLog: (obj: User) => any;
|
|
2151
|
+
}
|
|
2152
|
+
export interface ListUsersResponse {
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>A list of all the user accounts.</p>
|
|
2155
|
+
*/
|
|
2156
|
+
users?: User[];
|
|
2157
|
+
/**
|
|
2158
|
+
* <p>A token that indicates where a results page should begin.</p>
|
|
2159
|
+
*/
|
|
2160
|
+
nextToken?: string;
|
|
2161
|
+
}
|
|
2162
|
+
export declare namespace ListUsersResponse {
|
|
2163
|
+
/**
|
|
2164
|
+
* @internal
|
|
2165
|
+
*/
|
|
2166
|
+
const filterSensitiveLog: (obj: ListUsersResponse) => any;
|
|
2167
|
+
}
|
|
2168
|
+
export interface ResetUserPasswordRequest {
|
|
2169
|
+
/**
|
|
2170
|
+
* <p>The unique identifier of the user that a temporary password is requested for.</p>
|
|
2171
|
+
*/
|
|
2172
|
+
userId: string | undefined;
|
|
2173
|
+
/**
|
|
2174
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2175
|
+
*/
|
|
2176
|
+
clientToken?: string;
|
|
2177
|
+
}
|
|
2178
|
+
export declare namespace ResetUserPasswordRequest {
|
|
2179
|
+
/**
|
|
2180
|
+
* @internal
|
|
2181
|
+
*/
|
|
2182
|
+
const filterSensitiveLog: (obj: ResetUserPasswordRequest) => any;
|
|
2183
|
+
}
|
|
2184
|
+
export interface ResetUserPasswordResponse {
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>The unique identifier of the user that a new password is generated for.</p>
|
|
2187
|
+
*/
|
|
2188
|
+
userId?: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* <p>A randomly generated temporary password for the requested user account. This password expires in 7 days.</p>
|
|
2191
|
+
*/
|
|
2192
|
+
temporaryPassword?: string;
|
|
2193
|
+
}
|
|
2194
|
+
export declare namespace ResetUserPasswordResponse {
|
|
2195
|
+
/**
|
|
2196
|
+
* @internal
|
|
2197
|
+
*/
|
|
2198
|
+
const filterSensitiveLog: (obj: ResetUserPasswordResponse) => any;
|
|
2199
|
+
}
|
|
1586
2200
|
/**
|
|
1587
2201
|
* Request to update an existing changeset.
|
|
1588
2202
|
*/
|
|
@@ -1626,19 +2240,19 @@ export interface UpdateChangesetRequest {
|
|
|
1626
2240
|
* <ul>
|
|
1627
2241
|
* <li>
|
|
1628
2242
|
* <p>
|
|
1629
|
-
* <code>PARQUET</code>
|
|
2243
|
+
* <code>PARQUET</code> – Parquet source file format.</p>
|
|
1630
2244
|
* </li>
|
|
1631
2245
|
* <li>
|
|
1632
2246
|
* <p>
|
|
1633
|
-
* <code>CSV</code>
|
|
2247
|
+
* <code>CSV</code> – CSV source file format.</p>
|
|
1634
2248
|
* </li>
|
|
1635
2249
|
* <li>
|
|
1636
2250
|
* <p>
|
|
1637
|
-
* <code>JSON</code>
|
|
2251
|
+
* <code>JSON</code> – JSON source file format.</p>
|
|
1638
2252
|
* </li>
|
|
1639
2253
|
* <li>
|
|
1640
2254
|
* <p>
|
|
1641
|
-
* <code>XML</code>
|
|
2255
|
+
* <code>XML</code> – XML source file format.</p>
|
|
1642
2256
|
* </li>
|
|
1643
2257
|
* </ul>
|
|
1644
2258
|
*
|
|
@@ -1715,11 +2329,11 @@ export interface UpdateDatasetRequest {
|
|
|
1715
2329
|
* <ul>
|
|
1716
2330
|
* <li>
|
|
1717
2331
|
* <p>
|
|
1718
|
-
* <code>TABULAR</code>
|
|
2332
|
+
* <code>TABULAR</code> – Data is structured in a tabular format.</p>
|
|
1719
2333
|
* </li>
|
|
1720
2334
|
* <li>
|
|
1721
2335
|
* <p>
|
|
1722
|
-
* <code>NON_TABULAR</code>
|
|
2336
|
+
* <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p>
|
|
1723
2337
|
* </li>
|
|
1724
2338
|
* </ul>
|
|
1725
2339
|
*/
|
|
@@ -1758,3 +2372,141 @@ export declare namespace UpdateDatasetResponse {
|
|
|
1758
2372
|
*/
|
|
1759
2373
|
const filterSensitiveLog: (obj: UpdateDatasetResponse) => any;
|
|
1760
2374
|
}
|
|
2375
|
+
export interface UpdatePermissionGroupRequest {
|
|
2376
|
+
/**
|
|
2377
|
+
* <p>The unique identifier for the permission group to update.</p>
|
|
2378
|
+
*/
|
|
2379
|
+
permissionGroupId: string | undefined;
|
|
2380
|
+
/**
|
|
2381
|
+
* <p>The name of the permission group.</p>
|
|
2382
|
+
*/
|
|
2383
|
+
name?: string;
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>A brief description for the permission group.</p>
|
|
2386
|
+
*/
|
|
2387
|
+
description?: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* <p>The permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
2390
|
+
* <ul>
|
|
2391
|
+
* <li>
|
|
2392
|
+
* <p>
|
|
2393
|
+
* <code>CreateDataset</code> – Group members can create new datasets.</p>
|
|
2394
|
+
* </li>
|
|
2395
|
+
* <li>
|
|
2396
|
+
* <p>
|
|
2397
|
+
* <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p>
|
|
2398
|
+
* </li>
|
|
2399
|
+
* <li>
|
|
2400
|
+
* <p>
|
|
2401
|
+
* <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p>
|
|
2402
|
+
* </li>
|
|
2403
|
+
* <li>
|
|
2404
|
+
* <p>
|
|
2405
|
+
* <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p>
|
|
2406
|
+
* </li>
|
|
2407
|
+
* <li>
|
|
2408
|
+
* <p>
|
|
2409
|
+
* <code>ViewAuditData</code> – Group members can view audit data.</p>
|
|
2410
|
+
* </li>
|
|
2411
|
+
* <li>
|
|
2412
|
+
* <p>
|
|
2413
|
+
* <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p>
|
|
2414
|
+
* </li>
|
|
2415
|
+
* <li>
|
|
2416
|
+
* <p>
|
|
2417
|
+
* <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p>
|
|
2418
|
+
* </li>
|
|
2419
|
+
* </ul>
|
|
2420
|
+
*/
|
|
2421
|
+
applicationPermissions?: (ApplicationPermission | string)[];
|
|
2422
|
+
/**
|
|
2423
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2424
|
+
*/
|
|
2425
|
+
clientToken?: string;
|
|
2426
|
+
}
|
|
2427
|
+
export declare namespace UpdatePermissionGroupRequest {
|
|
2428
|
+
/**
|
|
2429
|
+
* @internal
|
|
2430
|
+
*/
|
|
2431
|
+
const filterSensitiveLog: (obj: UpdatePermissionGroupRequest) => any;
|
|
2432
|
+
}
|
|
2433
|
+
export interface UpdatePermissionGroupResponse {
|
|
2434
|
+
/**
|
|
2435
|
+
* <p>The unique identifier for the updated permission group.</p>
|
|
2436
|
+
*/
|
|
2437
|
+
permissionGroupId?: string;
|
|
2438
|
+
}
|
|
2439
|
+
export declare namespace UpdatePermissionGroupResponse {
|
|
2440
|
+
/**
|
|
2441
|
+
* @internal
|
|
2442
|
+
*/
|
|
2443
|
+
const filterSensitiveLog: (obj: UpdatePermissionGroupResponse) => any;
|
|
2444
|
+
}
|
|
2445
|
+
export interface UpdateUserRequest {
|
|
2446
|
+
/**
|
|
2447
|
+
* <p>The unique identifier for the user account to update.</p>
|
|
2448
|
+
*/
|
|
2449
|
+
userId: string | undefined;
|
|
2450
|
+
/**
|
|
2451
|
+
* <p>The option to indicate the type of user.</p>
|
|
2452
|
+
* <ul>
|
|
2453
|
+
* <li>
|
|
2454
|
+
* <p>
|
|
2455
|
+
* <code>SUPER_USER</code>– A user with permission to all the functionality and data in FinSpace.</p>
|
|
2456
|
+
* </li>
|
|
2457
|
+
* <li>
|
|
2458
|
+
* <p>
|
|
2459
|
+
* <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p>
|
|
2460
|
+
* </li>
|
|
2461
|
+
* </ul>
|
|
2462
|
+
*/
|
|
2463
|
+
type?: UserType | string;
|
|
2464
|
+
/**
|
|
2465
|
+
* <p>The first name of the user.</p>
|
|
2466
|
+
*/
|
|
2467
|
+
firstName?: string;
|
|
2468
|
+
/**
|
|
2469
|
+
* <p>The last name of the user.</p>
|
|
2470
|
+
*/
|
|
2471
|
+
lastName?: string;
|
|
2472
|
+
/**
|
|
2473
|
+
* <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>
|
|
2474
|
+
* <ul>
|
|
2475
|
+
* <li>
|
|
2476
|
+
* <p>
|
|
2477
|
+
* <code>ENABLED</code> – The user has permissions to use the APIs.</p>
|
|
2478
|
+
* </li>
|
|
2479
|
+
* <li>
|
|
2480
|
+
* <p>
|
|
2481
|
+
* <code>DISABLED</code> – The user does not have permissions to use any APIs.</p>
|
|
2482
|
+
* </li>
|
|
2483
|
+
* </ul>
|
|
2484
|
+
*/
|
|
2485
|
+
apiAccess?: ApiAccess | string;
|
|
2486
|
+
/**
|
|
2487
|
+
* <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>
|
|
2488
|
+
*/
|
|
2489
|
+
apiAccessPrincipalArn?: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2492
|
+
*/
|
|
2493
|
+
clientToken?: string;
|
|
2494
|
+
}
|
|
2495
|
+
export declare namespace UpdateUserRequest {
|
|
2496
|
+
/**
|
|
2497
|
+
* @internal
|
|
2498
|
+
*/
|
|
2499
|
+
const filterSensitiveLog: (obj: UpdateUserRequest) => any;
|
|
2500
|
+
}
|
|
2501
|
+
export interface UpdateUserResponse {
|
|
2502
|
+
/**
|
|
2503
|
+
* <p>The unique identifier of the updated user account.</p>
|
|
2504
|
+
*/
|
|
2505
|
+
userId?: string;
|
|
2506
|
+
}
|
|
2507
|
+
export declare namespace UpdateUserResponse {
|
|
2508
|
+
/**
|
|
2509
|
+
* @internal
|
|
2510
|
+
*/
|
|
2511
|
+
const filterSensitiveLog: (obj: UpdateUserResponse) => any;
|
|
2512
|
+
}
|