@aws-sdk/client-finspace-data 3.687.0 → 3.691.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +237 -237
- package/dist-types/ts3.4/models/models_0.d.ts +237 -237
- package/package.json +7 -7
|
@@ -59,7 +59,7 @@ export interface AssociateUserToPermissionGroupRequest {
|
|
|
59
59
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
60
60
|
* @public
|
|
61
61
|
*/
|
|
62
|
-
clientToken?: string;
|
|
62
|
+
clientToken?: string | undefined;
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
65
|
* @public
|
|
@@ -69,7 +69,7 @@ export interface AssociateUserToPermissionGroupResponse {
|
|
|
69
69
|
* <p>The returned status code of the response.</p>
|
|
70
70
|
* @public
|
|
71
71
|
*/
|
|
72
|
-
statusCode?: number;
|
|
72
|
+
statusCode?: number | undefined;
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
75
|
* <p>The request conflicts with an existing resource.</p>
|
|
@@ -78,7 +78,7 @@ export interface AssociateUserToPermissionGroupResponse {
|
|
|
78
78
|
export declare class ConflictException extends __BaseException {
|
|
79
79
|
readonly name: "ConflictException";
|
|
80
80
|
readonly $fault: "client";
|
|
81
|
-
reason?: string;
|
|
81
|
+
reason?: string | undefined;
|
|
82
82
|
/**
|
|
83
83
|
* @internal
|
|
84
84
|
*/
|
|
@@ -104,7 +104,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
104
104
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
105
105
|
readonly name: "ResourceNotFoundException";
|
|
106
106
|
readonly $fault: "client";
|
|
107
|
-
reason?: string;
|
|
107
|
+
reason?: string | undefined;
|
|
108
108
|
/**
|
|
109
109
|
* @internal
|
|
110
110
|
*/
|
|
@@ -129,7 +129,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
129
129
|
export declare class ValidationException extends __BaseException {
|
|
130
130
|
readonly name: "ValidationException";
|
|
131
131
|
readonly $fault: "client";
|
|
132
|
-
reason?: string;
|
|
132
|
+
reason?: string | undefined;
|
|
133
133
|
/**
|
|
134
134
|
* @internal
|
|
135
135
|
*/
|
|
@@ -144,22 +144,22 @@ export interface AwsCredentials {
|
|
|
144
144
|
* <p> The unique identifier for the security credentials.</p>
|
|
145
145
|
* @public
|
|
146
146
|
*/
|
|
147
|
-
accessKeyId?: string;
|
|
147
|
+
accessKeyId?: string | undefined;
|
|
148
148
|
/**
|
|
149
149
|
* <p> The secret access key that can be used to sign requests.</p>
|
|
150
150
|
* @public
|
|
151
151
|
*/
|
|
152
|
-
secretAccessKey?: string;
|
|
152
|
+
secretAccessKey?: string | undefined;
|
|
153
153
|
/**
|
|
154
154
|
* <p> The token that users must pass to use the credentials.</p>
|
|
155
155
|
* @public
|
|
156
156
|
*/
|
|
157
|
-
sessionToken?: string;
|
|
157
|
+
sessionToken?: string | undefined;
|
|
158
158
|
/**
|
|
159
159
|
* <p> The Epoch time when the current credentials expire.</p>
|
|
160
160
|
* @public
|
|
161
161
|
*/
|
|
162
|
-
expiration?: number;
|
|
162
|
+
expiration?: number | undefined;
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
165
|
* @public
|
|
@@ -183,7 +183,7 @@ export interface CreateChangesetRequest {
|
|
|
183
183
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
184
184
|
* @public
|
|
185
185
|
*/
|
|
186
|
-
clientToken?: string;
|
|
186
|
+
clientToken?: string | undefined;
|
|
187
187
|
/**
|
|
188
188
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset will be created.
|
|
189
189
|
* </p>
|
|
@@ -287,12 +287,12 @@ export interface CreateChangesetResponse {
|
|
|
287
287
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
|
|
288
288
|
* @public
|
|
289
289
|
*/
|
|
290
|
-
datasetId?: string;
|
|
290
|
+
datasetId?: string | undefined;
|
|
291
291
|
/**
|
|
292
292
|
* <p>The unique identifier of the Changeset that is created.</p>
|
|
293
293
|
* @public
|
|
294
294
|
*/
|
|
295
|
-
changesetId?: string;
|
|
295
|
+
changesetId?: string | undefined;
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
298
|
* <p>A limit has exceeded.</p>
|
|
@@ -327,17 +327,17 @@ export interface DatasetOwnerInfo {
|
|
|
327
327
|
* <p>The name of the Dataset owner.</p>
|
|
328
328
|
* @public
|
|
329
329
|
*/
|
|
330
|
-
name?: string;
|
|
330
|
+
name?: string | undefined;
|
|
331
331
|
/**
|
|
332
332
|
* <p>Phone number for the Dataset owner.</p>
|
|
333
333
|
* @public
|
|
334
334
|
*/
|
|
335
|
-
phoneNumber?: string;
|
|
335
|
+
phoneNumber?: string | undefined;
|
|
336
336
|
/**
|
|
337
337
|
* <p>Email address for the Dataset owner.</p>
|
|
338
338
|
* @public
|
|
339
339
|
*/
|
|
340
|
-
email?: string;
|
|
340
|
+
email?: string | undefined;
|
|
341
341
|
}
|
|
342
342
|
/**
|
|
343
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>
|
|
@@ -384,7 +384,7 @@ export interface ResourcePermission {
|
|
|
384
384
|
* <p>Permission for a resource.</p>
|
|
385
385
|
* @public
|
|
386
386
|
*/
|
|
387
|
-
permission?: string;
|
|
387
|
+
permission?: string | undefined;
|
|
388
388
|
}
|
|
389
389
|
/**
|
|
390
390
|
* <p>Permission group parameters for Dataset permissions.</p>
|
|
@@ -409,12 +409,12 @@ export interface PermissionGroupParams {
|
|
|
409
409
|
* <p>The unique identifier for the <code>PermissionGroup</code>.</p>
|
|
410
410
|
* @public
|
|
411
411
|
*/
|
|
412
|
-
permissionGroupId?: string;
|
|
412
|
+
permissionGroupId?: string | undefined;
|
|
413
413
|
/**
|
|
414
414
|
* <p>List of resource permissions.</p>
|
|
415
415
|
* @public
|
|
416
416
|
*/
|
|
417
|
-
datasetPermissions?: ResourcePermission[];
|
|
417
|
+
datasetPermissions?: ResourcePermission[] | undefined;
|
|
418
418
|
}
|
|
419
419
|
/**
|
|
420
420
|
* @public
|
|
@@ -475,17 +475,17 @@ export interface ColumnDefinition {
|
|
|
475
475
|
* </ul>
|
|
476
476
|
* @public
|
|
477
477
|
*/
|
|
478
|
-
dataType?: ColumnDataType;
|
|
478
|
+
dataType?: ColumnDataType | undefined;
|
|
479
479
|
/**
|
|
480
480
|
* <p>The name of a column.</p>
|
|
481
481
|
* @public
|
|
482
482
|
*/
|
|
483
|
-
columnName?: string;
|
|
483
|
+
columnName?: string | undefined;
|
|
484
484
|
/**
|
|
485
485
|
* <p>Description for a column.</p>
|
|
486
486
|
* @public
|
|
487
487
|
*/
|
|
488
|
-
columnDescription?: string;
|
|
488
|
+
columnDescription?: string | undefined;
|
|
489
489
|
}
|
|
490
490
|
/**
|
|
491
491
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
@@ -496,12 +496,12 @@ export interface SchemaDefinition {
|
|
|
496
496
|
* <p>List of column definitions.</p>
|
|
497
497
|
* @public
|
|
498
498
|
*/
|
|
499
|
-
columns?: ColumnDefinition[];
|
|
499
|
+
columns?: ColumnDefinition[] | undefined;
|
|
500
500
|
/**
|
|
501
501
|
* <p>List of column names used for primary key.</p>
|
|
502
502
|
* @public
|
|
503
503
|
*/
|
|
504
|
-
primaryKeyColumns?: string[];
|
|
504
|
+
primaryKeyColumns?: string[] | undefined;
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
507
|
* <p>A union of schema types.</p>
|
|
@@ -512,7 +512,7 @@ export interface SchemaUnion {
|
|
|
512
512
|
* <p>The configuration for a schema on a tabular Dataset.</p>
|
|
513
513
|
* @public
|
|
514
514
|
*/
|
|
515
|
-
tabularSchemaConfig?: SchemaDefinition;
|
|
515
|
+
tabularSchemaConfig?: SchemaDefinition | undefined;
|
|
516
516
|
}
|
|
517
517
|
/**
|
|
518
518
|
* The request for a CreateDataset operation
|
|
@@ -523,7 +523,7 @@ export interface CreateDatasetRequest {
|
|
|
523
523
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
524
524
|
* @public
|
|
525
525
|
*/
|
|
526
|
-
clientToken?: string;
|
|
526
|
+
clientToken?: string | undefined;
|
|
527
527
|
/**
|
|
528
528
|
* <p>Display title for a FinSpace Dataset.</p>
|
|
529
529
|
* @public
|
|
@@ -548,12 +548,12 @@ export interface CreateDatasetRequest {
|
|
|
548
548
|
* <p>Description of a Dataset.</p>
|
|
549
549
|
* @public
|
|
550
550
|
*/
|
|
551
|
-
datasetDescription?: string;
|
|
551
|
+
datasetDescription?: string | undefined;
|
|
552
552
|
/**
|
|
553
553
|
* <p>Contact information for a Dataset owner.</p>
|
|
554
554
|
* @public
|
|
555
555
|
*/
|
|
556
|
-
ownerInfo?: DatasetOwnerInfo;
|
|
556
|
+
ownerInfo?: DatasetOwnerInfo | undefined;
|
|
557
557
|
/**
|
|
558
558
|
* <p>Permission group parameters for Dataset permissions.</p>
|
|
559
559
|
* @public
|
|
@@ -563,12 +563,12 @@ export interface CreateDatasetRequest {
|
|
|
563
563
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
564
564
|
* @public
|
|
565
565
|
*/
|
|
566
|
-
alias?: string;
|
|
566
|
+
alias?: string | undefined;
|
|
567
567
|
/**
|
|
568
568
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
569
569
|
* @public
|
|
570
570
|
*/
|
|
571
|
-
schemaDefinition?: SchemaUnion;
|
|
571
|
+
schemaDefinition?: SchemaUnion | undefined;
|
|
572
572
|
}
|
|
573
573
|
/**
|
|
574
574
|
* The response from a CreateDataset operation
|
|
@@ -579,7 +579,7 @@ export interface CreateDatasetResponse {
|
|
|
579
579
|
* <p>The unique identifier for the created Dataset.</p>
|
|
580
580
|
* @public
|
|
581
581
|
*/
|
|
582
|
-
datasetId?: string;
|
|
582
|
+
datasetId?: string | undefined;
|
|
583
583
|
}
|
|
584
584
|
/**
|
|
585
585
|
* @public
|
|
@@ -627,7 +627,7 @@ export interface DataViewDestinationTypeParams {
|
|
|
627
627
|
* </ul>
|
|
628
628
|
* @public
|
|
629
629
|
*/
|
|
630
|
-
s3DestinationExportFileFormat?: ExportFileFormat;
|
|
630
|
+
s3DestinationExportFileFormat?: ExportFileFormat | undefined;
|
|
631
631
|
/**
|
|
632
632
|
* <p>Format Options for S3 Destination type.</p>
|
|
633
633
|
* <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code>
|
|
@@ -642,7 +642,7 @@ export interface DataViewDestinationTypeParams {
|
|
|
642
642
|
* </p>
|
|
643
643
|
* @public
|
|
644
644
|
*/
|
|
645
|
-
s3DestinationExportFileFormatOptions?: Record<string, string
|
|
645
|
+
s3DestinationExportFileFormatOptions?: Record<string, string> | undefined;
|
|
646
646
|
}
|
|
647
647
|
/**
|
|
648
648
|
* Request for creating a data view.
|
|
@@ -653,7 +653,7 @@ export interface CreateDataViewRequest {
|
|
|
653
653
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
654
654
|
* @public
|
|
655
655
|
*/
|
|
656
|
-
clientToken?: string;
|
|
656
|
+
clientToken?: string | undefined;
|
|
657
657
|
/**
|
|
658
658
|
* <p>The unique Dataset identifier that is used to create a Dataview.</p>
|
|
659
659
|
* @public
|
|
@@ -663,22 +663,22 @@ export interface CreateDataViewRequest {
|
|
|
663
663
|
* <p>Flag to indicate Dataview should be updated automatically.</p>
|
|
664
664
|
* @public
|
|
665
665
|
*/
|
|
666
|
-
autoUpdate?: boolean;
|
|
666
|
+
autoUpdate?: boolean | undefined;
|
|
667
667
|
/**
|
|
668
668
|
* <p>Columns to be used for sorting the data.</p>
|
|
669
669
|
* @public
|
|
670
670
|
*/
|
|
671
|
-
sortColumns?: string[];
|
|
671
|
+
sortColumns?: string[] | undefined;
|
|
672
672
|
/**
|
|
673
673
|
* <p>Ordered set of column names used to partition data.</p>
|
|
674
674
|
* @public
|
|
675
675
|
*/
|
|
676
|
-
partitionColumns?: string[];
|
|
676
|
+
partitionColumns?: string[] | undefined;
|
|
677
677
|
/**
|
|
678
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
679
|
* @public
|
|
680
680
|
*/
|
|
681
|
-
asOfTimestamp?: number;
|
|
681
|
+
asOfTimestamp?: number | undefined;
|
|
682
682
|
/**
|
|
683
683
|
* <p>Options that define the destination type for the Dataview.</p>
|
|
684
684
|
* @public
|
|
@@ -694,12 +694,12 @@ export interface CreateDataViewResponse {
|
|
|
694
694
|
* <p>The unique identifier of the Dataset used for the Dataview.</p>
|
|
695
695
|
* @public
|
|
696
696
|
*/
|
|
697
|
-
datasetId?: string;
|
|
697
|
+
datasetId?: string | undefined;
|
|
698
698
|
/**
|
|
699
699
|
* <p>The unique identifier for the created Dataview.</p>
|
|
700
700
|
* @public
|
|
701
701
|
*/
|
|
702
|
-
dataViewId?: string;
|
|
702
|
+
dataViewId?: string | undefined;
|
|
703
703
|
}
|
|
704
704
|
/**
|
|
705
705
|
* @public
|
|
@@ -714,7 +714,7 @@ export interface CreatePermissionGroupRequest {
|
|
|
714
714
|
* <p>A brief description for the permission group.</p>
|
|
715
715
|
* @public
|
|
716
716
|
*/
|
|
717
|
-
description?: string;
|
|
717
|
+
description?: string | undefined;
|
|
718
718
|
/**
|
|
719
719
|
* <p>The option to indicate FinSpace application permissions that are granted to a specific group.</p>
|
|
720
720
|
* <important>
|
|
@@ -757,7 +757,7 @@ export interface CreatePermissionGroupRequest {
|
|
|
757
757
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
758
758
|
* @public
|
|
759
759
|
*/
|
|
760
|
-
clientToken?: string;
|
|
760
|
+
clientToken?: string | undefined;
|
|
761
761
|
}
|
|
762
762
|
/**
|
|
763
763
|
* @public
|
|
@@ -767,7 +767,7 @@ export interface CreatePermissionGroupResponse {
|
|
|
767
767
|
* <p>The unique identifier for the permission group.</p>
|
|
768
768
|
* @public
|
|
769
769
|
*/
|
|
770
|
-
permissionGroupId?: string;
|
|
770
|
+
permissionGroupId?: string | undefined;
|
|
771
771
|
}
|
|
772
772
|
/**
|
|
773
773
|
* @public
|
|
@@ -809,12 +809,12 @@ export interface CreateUserRequest {
|
|
|
809
809
|
* <p>The first name of the user that you want to register.</p>
|
|
810
810
|
* @public
|
|
811
811
|
*/
|
|
812
|
-
firstName?: string;
|
|
812
|
+
firstName?: string | undefined;
|
|
813
813
|
/**
|
|
814
814
|
* <p>The last name of the user that you want to register.</p>
|
|
815
815
|
* @public
|
|
816
816
|
*/
|
|
817
|
-
lastName?: string;
|
|
817
|
+
lastName?: string | undefined;
|
|
818
818
|
/**
|
|
819
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>
|
|
820
820
|
* <ul>
|
|
@@ -829,17 +829,17 @@ export interface CreateUserRequest {
|
|
|
829
829
|
* </ul>
|
|
830
830
|
* @public
|
|
831
831
|
*/
|
|
832
|
-
apiAccess?: ApiAccess;
|
|
832
|
+
apiAccess?: ApiAccess | undefined;
|
|
833
833
|
/**
|
|
834
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
835
|
* @public
|
|
836
836
|
*/
|
|
837
|
-
apiAccessPrincipalArn?: string;
|
|
837
|
+
apiAccessPrincipalArn?: string | undefined;
|
|
838
838
|
/**
|
|
839
839
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
840
840
|
* @public
|
|
841
841
|
*/
|
|
842
|
-
clientToken?: string;
|
|
842
|
+
clientToken?: string | undefined;
|
|
843
843
|
}
|
|
844
844
|
/**
|
|
845
845
|
* @public
|
|
@@ -849,7 +849,7 @@ export interface CreateUserResponse {
|
|
|
849
849
|
* <p>The unique identifier for the user.</p>
|
|
850
850
|
* @public
|
|
851
851
|
*/
|
|
852
|
-
userId?: string;
|
|
852
|
+
userId?: string | undefined;
|
|
853
853
|
}
|
|
854
854
|
/**
|
|
855
855
|
* The request for a DeleteDataset operation.
|
|
@@ -860,7 +860,7 @@ export interface DeleteDatasetRequest {
|
|
|
860
860
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
861
861
|
* @public
|
|
862
862
|
*/
|
|
863
|
-
clientToken?: string;
|
|
863
|
+
clientToken?: string | undefined;
|
|
864
864
|
/**
|
|
865
865
|
* <p>The unique identifier of the Dataset to be deleted.</p>
|
|
866
866
|
* @public
|
|
@@ -876,7 +876,7 @@ export interface DeleteDatasetResponse {
|
|
|
876
876
|
* <p>The unique identifier for the deleted Dataset.</p>
|
|
877
877
|
* @public
|
|
878
878
|
*/
|
|
879
|
-
datasetId?: string;
|
|
879
|
+
datasetId?: string | undefined;
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
882
|
* @public
|
|
@@ -891,7 +891,7 @@ export interface DeletePermissionGroupRequest {
|
|
|
891
891
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
892
892
|
* @public
|
|
893
893
|
*/
|
|
894
|
-
clientToken?: string;
|
|
894
|
+
clientToken?: string | undefined;
|
|
895
895
|
}
|
|
896
896
|
/**
|
|
897
897
|
* @public
|
|
@@ -901,7 +901,7 @@ export interface DeletePermissionGroupResponse {
|
|
|
901
901
|
* <p>The unique identifier for the deleted permission group.</p>
|
|
902
902
|
* @public
|
|
903
903
|
*/
|
|
904
|
-
permissionGroupId?: string;
|
|
904
|
+
permissionGroupId?: string | undefined;
|
|
905
905
|
}
|
|
906
906
|
/**
|
|
907
907
|
* @public
|
|
@@ -916,7 +916,7 @@ export interface DisableUserRequest {
|
|
|
916
916
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
917
917
|
* @public
|
|
918
918
|
*/
|
|
919
|
-
clientToken?: string;
|
|
919
|
+
clientToken?: string | undefined;
|
|
920
920
|
}
|
|
921
921
|
/**
|
|
922
922
|
* @public
|
|
@@ -926,7 +926,7 @@ export interface DisableUserResponse {
|
|
|
926
926
|
* <p>The unique identifier for the deactivated user.</p>
|
|
927
927
|
* @public
|
|
928
928
|
*/
|
|
929
|
-
userId?: string;
|
|
929
|
+
userId?: string | undefined;
|
|
930
930
|
}
|
|
931
931
|
/**
|
|
932
932
|
* @public
|
|
@@ -946,7 +946,7 @@ export interface DisassociateUserFromPermissionGroupRequest {
|
|
|
946
946
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
947
947
|
* @public
|
|
948
948
|
*/
|
|
949
|
-
clientToken?: string;
|
|
949
|
+
clientToken?: string | undefined;
|
|
950
950
|
}
|
|
951
951
|
/**
|
|
952
952
|
* @public
|
|
@@ -956,7 +956,7 @@ export interface DisassociateUserFromPermissionGroupResponse {
|
|
|
956
956
|
* <p>The returned status code of the response.</p>
|
|
957
957
|
* @public
|
|
958
958
|
*/
|
|
959
|
-
statusCode?: number;
|
|
959
|
+
statusCode?: number | undefined;
|
|
960
960
|
}
|
|
961
961
|
/**
|
|
962
962
|
* @public
|
|
@@ -971,7 +971,7 @@ export interface EnableUserRequest {
|
|
|
971
971
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
972
972
|
* @public
|
|
973
973
|
*/
|
|
974
|
-
clientToken?: string;
|
|
974
|
+
clientToken?: string | undefined;
|
|
975
975
|
}
|
|
976
976
|
/**
|
|
977
977
|
* @public
|
|
@@ -981,7 +981,7 @@ export interface EnableUserResponse {
|
|
|
981
981
|
* <p>The unique identifier for the active user.</p>
|
|
982
982
|
* @public
|
|
983
983
|
*/
|
|
984
|
-
userId?: string;
|
|
984
|
+
userId?: string | undefined;
|
|
985
985
|
}
|
|
986
986
|
/**
|
|
987
987
|
* Request to describe a changeset.
|
|
@@ -1026,7 +1026,7 @@ export interface ChangesetErrorInfo {
|
|
|
1026
1026
|
* <p>The text of the error message.</p>
|
|
1027
1027
|
* @public
|
|
1028
1028
|
*/
|
|
1029
|
-
errorMessage?: string;
|
|
1029
|
+
errorMessage?: string | undefined;
|
|
1030
1030
|
/**
|
|
1031
1031
|
* <p>The category of the error.</p>
|
|
1032
1032
|
* <ul>
|
|
@@ -1070,7 +1070,7 @@ export interface ChangesetErrorInfo {
|
|
|
1070
1070
|
* </ul>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
errorCategory?: ErrorCategory;
|
|
1073
|
+
errorCategory?: ErrorCategory | undefined;
|
|
1074
1074
|
}
|
|
1075
1075
|
/**
|
|
1076
1076
|
* @public
|
|
@@ -1096,17 +1096,17 @@ export interface GetChangesetResponse {
|
|
|
1096
1096
|
* <p>The unique identifier for a Changeset.</p>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
changesetId?: string;
|
|
1099
|
+
changesetId?: string | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <p>The ARN identifier of the Changeset.</p>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
changesetArn?: string;
|
|
1104
|
+
changesetArn?: string | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
datasetId?: string;
|
|
1109
|
+
datasetId?: string | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>Type that indicates how a Changeset is applied to a Dataset.</p>
|
|
1112
1112
|
* <ul>
|
|
@@ -1125,52 +1125,52 @@ export interface GetChangesetResponse {
|
|
|
1125
1125
|
* </ul>
|
|
1126
1126
|
* @public
|
|
1127
1127
|
*/
|
|
1128
|
-
changeType?: ChangeType;
|
|
1128
|
+
changeType?: ChangeType | undefined;
|
|
1129
1129
|
/**
|
|
1130
1130
|
* <p>Options that define the location of the data being ingested.</p>
|
|
1131
1131
|
* @public
|
|
1132
1132
|
*/
|
|
1133
|
-
sourceParams?: Record<string, string
|
|
1133
|
+
sourceParams?: Record<string, string> | undefined;
|
|
1134
1134
|
/**
|
|
1135
1135
|
* <p>Structure of the source file(s).</p>
|
|
1136
1136
|
* @public
|
|
1137
1137
|
*/
|
|
1138
|
-
formatParams?: Record<string, string
|
|
1138
|
+
formatParams?: Record<string, string> | undefined;
|
|
1139
1139
|
/**
|
|
1140
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
1141
|
* @public
|
|
1142
1142
|
*/
|
|
1143
|
-
createTime?: number;
|
|
1143
|
+
createTime?: number | undefined;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* <p>The status of Changeset creation operation.</p>
|
|
1146
1146
|
* @public
|
|
1147
1147
|
*/
|
|
1148
|
-
status?: IngestionStatus;
|
|
1148
|
+
status?: IngestionStatus | undefined;
|
|
1149
1149
|
/**
|
|
1150
1150
|
* <p>The structure with error messages.</p>
|
|
1151
1151
|
* @public
|
|
1152
1152
|
*/
|
|
1153
|
-
errorInfo?: ChangesetErrorInfo;
|
|
1153
|
+
errorInfo?: ChangesetErrorInfo | undefined;
|
|
1154
1154
|
/**
|
|
1155
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
1156
|
* @public
|
|
1157
1157
|
*/
|
|
1158
|
-
activeUntilTimestamp?: number;
|
|
1158
|
+
activeUntilTimestamp?: number | undefined;
|
|
1159
1159
|
/**
|
|
1160
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
1161
|
* @public
|
|
1162
1162
|
*/
|
|
1163
|
-
activeFromTimestamp?: number;
|
|
1163
|
+
activeFromTimestamp?: number | undefined;
|
|
1164
1164
|
/**
|
|
1165
1165
|
* <p>The unique identifier of the Changeset that is being updated.</p>
|
|
1166
1166
|
* @public
|
|
1167
1167
|
*/
|
|
1168
|
-
updatesChangesetId?: string;
|
|
1168
|
+
updatesChangesetId?: string | undefined;
|
|
1169
1169
|
/**
|
|
1170
1170
|
* <p>The unique identifier of the updated Changeset.</p>
|
|
1171
1171
|
* @public
|
|
1172
1172
|
*/
|
|
1173
|
-
updatedByChangesetId?: string;
|
|
1173
|
+
updatedByChangesetId?: string | undefined;
|
|
1174
1174
|
}
|
|
1175
1175
|
/**
|
|
1176
1176
|
* Request for the GetDataset operation.
|
|
@@ -1206,17 +1206,17 @@ export interface GetDatasetResponse {
|
|
|
1206
1206
|
* <p>The unique identifier for a Dataset.</p>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
datasetId?: string;
|
|
1209
|
+
datasetId?: string | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The ARN identifier of the Dataset.</p>
|
|
1212
1212
|
* @public
|
|
1213
1213
|
*/
|
|
1214
|
-
datasetArn?: string;
|
|
1214
|
+
datasetArn?: string | undefined;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* <p>Display title for a Dataset.</p>
|
|
1217
1217
|
* @public
|
|
1218
1218
|
*/
|
|
1219
|
-
datasetTitle?: string;
|
|
1219
|
+
datasetTitle?: string | undefined;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* <p>The format in which Dataset data is structured.</p>
|
|
1222
1222
|
* <ul>
|
|
@@ -1231,32 +1231,32 @@ export interface GetDatasetResponse {
|
|
|
1231
1231
|
* </ul>
|
|
1232
1232
|
* @public
|
|
1233
1233
|
*/
|
|
1234
|
-
kind?: DatasetKind;
|
|
1234
|
+
kind?: DatasetKind | undefined;
|
|
1235
1235
|
/**
|
|
1236
1236
|
* <p>A description of the Dataset.</p>
|
|
1237
1237
|
* @public
|
|
1238
1238
|
*/
|
|
1239
|
-
datasetDescription?: string;
|
|
1239
|
+
datasetDescription?: string | undefined;
|
|
1240
1240
|
/**
|
|
1241
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
1242
|
* @public
|
|
1243
1243
|
*/
|
|
1244
|
-
createTime?: number;
|
|
1244
|
+
createTime?: number | undefined;
|
|
1245
1245
|
/**
|
|
1246
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
1247
|
* @public
|
|
1248
1248
|
*/
|
|
1249
|
-
lastModifiedTime?: number;
|
|
1249
|
+
lastModifiedTime?: number | undefined;
|
|
1250
1250
|
/**
|
|
1251
1251
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
1252
1252
|
* @public
|
|
1253
1253
|
*/
|
|
1254
|
-
schemaDefinition?: SchemaUnion;
|
|
1254
|
+
schemaDefinition?: SchemaUnion | undefined;
|
|
1255
1255
|
/**
|
|
1256
1256
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
1257
1257
|
* @public
|
|
1258
1258
|
*/
|
|
1259
|
-
alias?: string;
|
|
1259
|
+
alias?: string | undefined;
|
|
1260
1260
|
/**
|
|
1261
1261
|
* <p>Status of the Dataset creation.</p>
|
|
1262
1262
|
* <ul>
|
|
@@ -1279,7 +1279,7 @@ export interface GetDatasetResponse {
|
|
|
1279
1279
|
* </ul>
|
|
1280
1280
|
* @public
|
|
1281
1281
|
*/
|
|
1282
|
-
status?: DatasetStatus;
|
|
1282
|
+
status?: DatasetStatus | undefined;
|
|
1283
1283
|
}
|
|
1284
1284
|
/**
|
|
1285
1285
|
* Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
|
|
@@ -1306,7 +1306,7 @@ export interface DataViewErrorInfo {
|
|
|
1306
1306
|
* <p>The text of the error message.</p>
|
|
1307
1307
|
* @public
|
|
1308
1308
|
*/
|
|
1309
|
-
errorMessage?: string;
|
|
1309
|
+
errorMessage?: string | undefined;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* <p>The category of the error.</p>
|
|
1312
1312
|
* <ul>
|
|
@@ -1350,7 +1350,7 @@ export interface DataViewErrorInfo {
|
|
|
1350
1350
|
* </ul>
|
|
1351
1351
|
* @public
|
|
1352
1352
|
*/
|
|
1353
|
-
errorCategory?: ErrorCategory;
|
|
1353
|
+
errorCategory?: ErrorCategory | undefined;
|
|
1354
1354
|
}
|
|
1355
1355
|
/**
|
|
1356
1356
|
* @public
|
|
@@ -1379,57 +1379,57 @@ export interface GetDataViewResponse {
|
|
|
1379
1379
|
* <p>Flag to indicate Dataview should be updated automatically.</p>
|
|
1380
1380
|
* @public
|
|
1381
1381
|
*/
|
|
1382
|
-
autoUpdate?: boolean;
|
|
1382
|
+
autoUpdate?: boolean | undefined;
|
|
1383
1383
|
/**
|
|
1384
1384
|
* <p>Ordered set of column names used to partition data.</p>
|
|
1385
1385
|
* @public
|
|
1386
1386
|
*/
|
|
1387
|
-
partitionColumns?: string[];
|
|
1387
|
+
partitionColumns?: string[] | undefined;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* <p>The unique identifier for the Dataset used in the Dataview.</p>
|
|
1390
1390
|
* @public
|
|
1391
1391
|
*/
|
|
1392
|
-
datasetId?: string;
|
|
1392
|
+
datasetId?: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
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
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
asOfTimestamp?: number;
|
|
1397
|
+
asOfTimestamp?: number | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <p>Information about an error that occurred for the Dataview.</p>
|
|
1400
1400
|
* @public
|
|
1401
1401
|
*/
|
|
1402
|
-
errorInfo?: DataViewErrorInfo;
|
|
1402
|
+
errorInfo?: DataViewErrorInfo | undefined;
|
|
1403
1403
|
/**
|
|
1404
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
1405
|
* @public
|
|
1406
1406
|
*/
|
|
1407
|
-
lastModifiedTime?: number;
|
|
1407
|
+
lastModifiedTime?: number | undefined;
|
|
1408
1408
|
/**
|
|
1409
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
1410
|
* @public
|
|
1411
1411
|
*/
|
|
1412
|
-
createTime?: number;
|
|
1412
|
+
createTime?: number | undefined;
|
|
1413
1413
|
/**
|
|
1414
1414
|
* <p>Columns to be used for sorting the data.</p>
|
|
1415
1415
|
* @public
|
|
1416
1416
|
*/
|
|
1417
|
-
sortColumns?: string[];
|
|
1417
|
+
sortColumns?: string[] | undefined;
|
|
1418
1418
|
/**
|
|
1419
1419
|
* <p>The unique identifier for the Dataview.</p>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
|
-
dataViewId?: string;
|
|
1422
|
+
dataViewId?: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
1424
|
* <p>The ARN identifier of the Dataview.</p>
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
|
-
dataViewArn?: string;
|
|
1427
|
+
dataViewArn?: string | undefined;
|
|
1428
1428
|
/**
|
|
1429
1429
|
* <p>Options that define the destination type for the Dataview.</p>
|
|
1430
1430
|
* @public
|
|
1431
1431
|
*/
|
|
1432
|
-
destinationTypeParams?: DataViewDestinationTypeParams;
|
|
1432
|
+
destinationTypeParams?: DataViewDestinationTypeParams | undefined;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* <p>The status of a Dataview creation.</p>
|
|
1435
1435
|
* <ul>
|
|
@@ -1468,7 +1468,7 @@ export interface GetDataViewResponse {
|
|
|
1468
1468
|
* </ul>
|
|
1469
1469
|
* @public
|
|
1470
1470
|
*/
|
|
1471
|
-
status?: DataViewStatus;
|
|
1471
|
+
status?: DataViewStatus | undefined;
|
|
1472
1472
|
}
|
|
1473
1473
|
/**
|
|
1474
1474
|
* @public
|
|
@@ -1509,12 +1509,12 @@ export interface GetExternalDataViewAccessDetailsResponse {
|
|
|
1509
1509
|
* <p>The credentials required to access the external Dataview from the S3 location.</p>
|
|
1510
1510
|
* @public
|
|
1511
1511
|
*/
|
|
1512
|
-
credentials?: AwsCredentials;
|
|
1512
|
+
credentials?: AwsCredentials | undefined;
|
|
1513
1513
|
/**
|
|
1514
1514
|
* <p>The location where the external Dataview is stored.</p>
|
|
1515
1515
|
* @public
|
|
1516
1516
|
*/
|
|
1517
|
-
s3Location?: S3Location;
|
|
1517
|
+
s3Location?: S3Location | undefined;
|
|
1518
1518
|
}
|
|
1519
1519
|
/**
|
|
1520
1520
|
* @public
|
|
@@ -1548,17 +1548,17 @@ export interface PermissionGroup {
|
|
|
1548
1548
|
* <p> The unique identifier for the permission group.</p>
|
|
1549
1549
|
* @public
|
|
1550
1550
|
*/
|
|
1551
|
-
permissionGroupId?: string;
|
|
1551
|
+
permissionGroupId?: string | undefined;
|
|
1552
1552
|
/**
|
|
1553
1553
|
* <p>The name of the permission group.</p>
|
|
1554
1554
|
* @public
|
|
1555
1555
|
*/
|
|
1556
|
-
name?: string;
|
|
1556
|
+
name?: string | undefined;
|
|
1557
1557
|
/**
|
|
1558
1558
|
* <p> A brief description for the permission group.</p>
|
|
1559
1559
|
* @public
|
|
1560
1560
|
*/
|
|
1561
|
-
description?: string;
|
|
1561
|
+
description?: string | undefined;
|
|
1562
1562
|
/**
|
|
1563
1563
|
* <p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
1564
1564
|
* <important>
|
|
@@ -1596,19 +1596,19 @@ export interface PermissionGroup {
|
|
|
1596
1596
|
* </ul>
|
|
1597
1597
|
* @public
|
|
1598
1598
|
*/
|
|
1599
|
-
applicationPermissions?: ApplicationPermission[];
|
|
1599
|
+
applicationPermissions?: ApplicationPermission[] | undefined;
|
|
1600
1600
|
/**
|
|
1601
1601
|
* <p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
|
|
1602
1602
|
* </p>
|
|
1603
1603
|
* @public
|
|
1604
1604
|
*/
|
|
1605
|
-
createTime?: number;
|
|
1605
|
+
createTime?: number | undefined;
|
|
1606
1606
|
/**
|
|
1607
1607
|
* <p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
|
|
1608
1608
|
* </p>
|
|
1609
1609
|
* @public
|
|
1610
1610
|
*/
|
|
1611
|
-
lastModifiedTime?: number;
|
|
1611
|
+
lastModifiedTime?: number | undefined;
|
|
1612
1612
|
/**
|
|
1613
1613
|
* <p>Indicates the status of the user within a permission group.</p>
|
|
1614
1614
|
* <ul>
|
|
@@ -1627,7 +1627,7 @@ export interface PermissionGroup {
|
|
|
1627
1627
|
* </ul>
|
|
1628
1628
|
* @public
|
|
1629
1629
|
*/
|
|
1630
|
-
membershipStatus?: PermissionGroupMembershipStatus;
|
|
1630
|
+
membershipStatus?: PermissionGroupMembershipStatus | undefined;
|
|
1631
1631
|
}
|
|
1632
1632
|
/**
|
|
1633
1633
|
* @public
|
|
@@ -1637,7 +1637,7 @@ export interface GetPermissionGroupResponse {
|
|
|
1637
1637
|
* <p>The structure for a permission group.</p>
|
|
1638
1638
|
* @public
|
|
1639
1639
|
*/
|
|
1640
|
-
permissionGroup?: PermissionGroup;
|
|
1640
|
+
permissionGroup?: PermissionGroup | undefined;
|
|
1641
1641
|
}
|
|
1642
1642
|
/**
|
|
1643
1643
|
* Request for GetProgrammaticAccessCredentials operation
|
|
@@ -1648,7 +1648,7 @@ export interface GetProgrammaticAccessCredentialsRequest {
|
|
|
1648
1648
|
* <p>The time duration in which the credentials remain valid. </p>
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
|
-
durationInMinutes?: number;
|
|
1651
|
+
durationInMinutes?: number | undefined;
|
|
1652
1652
|
/**
|
|
1653
1653
|
* <p>The FinSpace environment identifier.</p>
|
|
1654
1654
|
* @public
|
|
@@ -1664,17 +1664,17 @@ export interface Credentials {
|
|
|
1664
1664
|
* <p>The access key identifier.</p>
|
|
1665
1665
|
* @public
|
|
1666
1666
|
*/
|
|
1667
|
-
accessKeyId?: string;
|
|
1667
|
+
accessKeyId?: string | undefined;
|
|
1668
1668
|
/**
|
|
1669
1669
|
* <p>The access key.</p>
|
|
1670
1670
|
* @public
|
|
1671
1671
|
*/
|
|
1672
|
-
secretAccessKey?: string;
|
|
1672
|
+
secretAccessKey?: string | undefined;
|
|
1673
1673
|
/**
|
|
1674
1674
|
* <p>The session token.</p>
|
|
1675
1675
|
* @public
|
|
1676
1676
|
*/
|
|
1677
|
-
sessionToken?: string;
|
|
1677
|
+
sessionToken?: string | undefined;
|
|
1678
1678
|
}
|
|
1679
1679
|
/**
|
|
1680
1680
|
* Response for GetProgrammaticAccessCredentials operation
|
|
@@ -1685,12 +1685,12 @@ export interface GetProgrammaticAccessCredentialsResponse {
|
|
|
1685
1685
|
* <p>Returns the programmatic credentials.</p>
|
|
1686
1686
|
* @public
|
|
1687
1687
|
*/
|
|
1688
|
-
credentials?: Credentials;
|
|
1688
|
+
credentials?: Credentials | undefined;
|
|
1689
1689
|
/**
|
|
1690
1690
|
* <p>Returns the duration in which the credentials will remain valid.</p>
|
|
1691
1691
|
* @public
|
|
1692
1692
|
*/
|
|
1693
|
-
durationInMinutes?: number;
|
|
1693
|
+
durationInMinutes?: number | undefined;
|
|
1694
1694
|
}
|
|
1695
1695
|
/**
|
|
1696
1696
|
* @public
|
|
@@ -1723,7 +1723,7 @@ export interface GetUserResponse {
|
|
|
1723
1723
|
* <p>The unique identifier for the user that is retrieved.</p>
|
|
1724
1724
|
* @public
|
|
1725
1725
|
*/
|
|
1726
|
-
userId?: string;
|
|
1726
|
+
userId?: string | undefined;
|
|
1727
1727
|
/**
|
|
1728
1728
|
* <p>The current status of the user. </p>
|
|
1729
1729
|
* <ul>
|
|
@@ -1742,22 +1742,22 @@ export interface GetUserResponse {
|
|
|
1742
1742
|
* </ul>
|
|
1743
1743
|
* @public
|
|
1744
1744
|
*/
|
|
1745
|
-
status?: UserStatus;
|
|
1745
|
+
status?: UserStatus | undefined;
|
|
1746
1746
|
/**
|
|
1747
1747
|
* <p>The first name of the user.</p>
|
|
1748
1748
|
* @public
|
|
1749
1749
|
*/
|
|
1750
|
-
firstName?: string;
|
|
1750
|
+
firstName?: string | undefined;
|
|
1751
1751
|
/**
|
|
1752
1752
|
* <p>The last name of the user.</p>
|
|
1753
1753
|
* @public
|
|
1754
1754
|
*/
|
|
1755
|
-
lastName?: string;
|
|
1755
|
+
lastName?: string | undefined;
|
|
1756
1756
|
/**
|
|
1757
1757
|
* <p>The email address that is associated with the user.</p>
|
|
1758
1758
|
* @public
|
|
1759
1759
|
*/
|
|
1760
|
-
emailAddress?: string;
|
|
1760
|
+
emailAddress?: string | undefined;
|
|
1761
1761
|
/**
|
|
1762
1762
|
* <p>Indicates the type of user. </p>
|
|
1763
1763
|
* <ul>
|
|
@@ -1774,7 +1774,7 @@ export interface GetUserResponse {
|
|
|
1774
1774
|
* </ul>
|
|
1775
1775
|
* @public
|
|
1776
1776
|
*/
|
|
1777
|
-
type?: UserType;
|
|
1777
|
+
type?: UserType | undefined;
|
|
1778
1778
|
/**
|
|
1779
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>
|
|
1780
1780
|
* <ul>
|
|
@@ -1789,37 +1789,37 @@ export interface GetUserResponse {
|
|
|
1789
1789
|
* </ul>
|
|
1790
1790
|
* @public
|
|
1791
1791
|
*/
|
|
1792
|
-
apiAccess?: ApiAccess;
|
|
1792
|
+
apiAccess?: ApiAccess | undefined;
|
|
1793
1793
|
/**
|
|
1794
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
1795
|
* @public
|
|
1796
1796
|
*/
|
|
1797
|
-
apiAccessPrincipalArn?: string;
|
|
1797
|
+
apiAccessPrincipalArn?: string | undefined;
|
|
1798
1798
|
/**
|
|
1799
1799
|
* <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
1800
1800
|
* @public
|
|
1801
1801
|
*/
|
|
1802
|
-
createTime?: number;
|
|
1802
|
+
createTime?: number | undefined;
|
|
1803
1803
|
/**
|
|
1804
1804
|
* <p>Describes the last time the user was activated. The value is determined as epoch time in milliseconds.</p>
|
|
1805
1805
|
* @public
|
|
1806
1806
|
*/
|
|
1807
|
-
lastEnabledTime?: number;
|
|
1807
|
+
lastEnabledTime?: number | undefined;
|
|
1808
1808
|
/**
|
|
1809
1809
|
* <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
lastDisabledTime?: number;
|
|
1812
|
+
lastDisabledTime?: number | undefined;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.</p>
|
|
1815
1815
|
* @public
|
|
1816
1816
|
*/
|
|
1817
|
-
lastModifiedTime?: number;
|
|
1817
|
+
lastModifiedTime?: number | undefined;
|
|
1818
1818
|
/**
|
|
1819
1819
|
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>
|
|
1820
1820
|
* @public
|
|
1821
1821
|
*/
|
|
1822
|
-
lastLoginTime?: number;
|
|
1822
|
+
lastLoginTime?: number | undefined;
|
|
1823
1823
|
}
|
|
1824
1824
|
/**
|
|
1825
1825
|
* @public
|
|
@@ -1853,7 +1853,7 @@ export interface GetWorkingLocationRequest {
|
|
|
1853
1853
|
* </ul>
|
|
1854
1854
|
* @public
|
|
1855
1855
|
*/
|
|
1856
|
-
locationType?: LocationType;
|
|
1856
|
+
locationType?: LocationType | undefined;
|
|
1857
1857
|
}
|
|
1858
1858
|
/**
|
|
1859
1859
|
* @public
|
|
@@ -1863,17 +1863,17 @@ export interface GetWorkingLocationResponse {
|
|
|
1863
1863
|
* <p>Returns the Amazon S3 URI for the working location.</p>
|
|
1864
1864
|
* @public
|
|
1865
1865
|
*/
|
|
1866
|
-
s3Uri?: string;
|
|
1866
|
+
s3Uri?: string | undefined;
|
|
1867
1867
|
/**
|
|
1868
1868
|
* <p>Returns the Amazon S3 Path for the working location.</p>
|
|
1869
1869
|
* @public
|
|
1870
1870
|
*/
|
|
1871
|
-
s3Path?: string;
|
|
1871
|
+
s3Path?: string | undefined;
|
|
1872
1872
|
/**
|
|
1873
1873
|
* <p>Returns the Amazon S3 bucket name for the working location.</p>
|
|
1874
1874
|
* @public
|
|
1875
1875
|
*/
|
|
1876
|
-
s3Bucket?: string;
|
|
1876
|
+
s3Bucket?: string | undefined;
|
|
1877
1877
|
}
|
|
1878
1878
|
/**
|
|
1879
1879
|
* Request to ListChangesetsRequest. It exposes minimal query filters.
|
|
@@ -1889,12 +1889,12 @@ export interface ListChangesetsRequest {
|
|
|
1889
1889
|
* <p>The maximum number of results per page.</p>
|
|
1890
1890
|
* @public
|
|
1891
1891
|
*/
|
|
1892
|
-
maxResults?: number;
|
|
1892
|
+
maxResults?: number | undefined;
|
|
1893
1893
|
/**
|
|
1894
1894
|
* <p>A token that indicates where a results page should begin.</p>
|
|
1895
1895
|
* @public
|
|
1896
1896
|
*/
|
|
1897
|
-
nextToken?: string;
|
|
1897
|
+
nextToken?: string | undefined;
|
|
1898
1898
|
}
|
|
1899
1899
|
/**
|
|
1900
1900
|
* <p>A Changeset is unit of data in a Dataset.</p>
|
|
@@ -1905,17 +1905,17 @@ export interface ChangesetSummary {
|
|
|
1905
1905
|
* <p>The unique identifier for a Changeset.</p>
|
|
1906
1906
|
* @public
|
|
1907
1907
|
*/
|
|
1908
|
-
changesetId?: string;
|
|
1908
|
+
changesetId?: string | undefined;
|
|
1909
1909
|
/**
|
|
1910
1910
|
* <p>The ARN identifier of the Changeset.</p>
|
|
1911
1911
|
* @public
|
|
1912
1912
|
*/
|
|
1913
|
-
changesetArn?: string;
|
|
1913
|
+
changesetArn?: string | undefined;
|
|
1914
1914
|
/**
|
|
1915
1915
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
1916
1916
|
* @public
|
|
1917
1917
|
*/
|
|
1918
|
-
datasetId?: string;
|
|
1918
|
+
datasetId?: string | undefined;
|
|
1919
1919
|
/**
|
|
1920
1920
|
* <p>Type that indicates how a Changeset is applied to a Dataset.</p>
|
|
1921
1921
|
* <ul>
|
|
@@ -1937,22 +1937,22 @@ export interface ChangesetSummary {
|
|
|
1937
1937
|
* </ul>
|
|
1938
1938
|
* @public
|
|
1939
1939
|
*/
|
|
1940
|
-
changeType?: ChangeType;
|
|
1940
|
+
changeType?: ChangeType | undefined;
|
|
1941
1941
|
/**
|
|
1942
1942
|
* <p>Options that define the location of the data being ingested.</p>
|
|
1943
1943
|
* @public
|
|
1944
1944
|
*/
|
|
1945
|
-
sourceParams?: Record<string, string
|
|
1945
|
+
sourceParams?: Record<string, string> | undefined;
|
|
1946
1946
|
/**
|
|
1947
1947
|
* <p>Options that define the structure of the source file(s).</p>
|
|
1948
1948
|
* @public
|
|
1949
1949
|
*/
|
|
1950
|
-
formatParams?: Record<string, string
|
|
1950
|
+
formatParams?: Record<string, string> | undefined;
|
|
1951
1951
|
/**
|
|
1952
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
1953
|
* @public
|
|
1954
1954
|
*/
|
|
1955
|
-
createTime?: number;
|
|
1955
|
+
createTime?: number | undefined;
|
|
1956
1956
|
/**
|
|
1957
1957
|
* <p>Status of the Changeset ingestion.</p>
|
|
1958
1958
|
* <ul>
|
|
@@ -1979,32 +1979,32 @@ export interface ChangesetSummary {
|
|
|
1979
1979
|
* </ul>
|
|
1980
1980
|
* @public
|
|
1981
1981
|
*/
|
|
1982
|
-
status?: IngestionStatus;
|
|
1982
|
+
status?: IngestionStatus | undefined;
|
|
1983
1983
|
/**
|
|
1984
1984
|
* <p>The structure with error messages.</p>
|
|
1985
1985
|
* @public
|
|
1986
1986
|
*/
|
|
1987
|
-
errorInfo?: ChangesetErrorInfo;
|
|
1987
|
+
errorInfo?: ChangesetErrorInfo | undefined;
|
|
1988
1988
|
/**
|
|
1989
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
1990
|
* @public
|
|
1991
1991
|
*/
|
|
1992
|
-
activeUntilTimestamp?: number;
|
|
1992
|
+
activeUntilTimestamp?: number | undefined;
|
|
1993
1993
|
/**
|
|
1994
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
1995
|
* @public
|
|
1996
1996
|
*/
|
|
1997
|
-
activeFromTimestamp?: number;
|
|
1997
|
+
activeFromTimestamp?: number | undefined;
|
|
1998
1998
|
/**
|
|
1999
1999
|
* <p>The unique identifier of the Changeset that is updated.</p>
|
|
2000
2000
|
* @public
|
|
2001
2001
|
*/
|
|
2002
|
-
updatesChangesetId?: string;
|
|
2002
|
+
updatesChangesetId?: string | undefined;
|
|
2003
2003
|
/**
|
|
2004
2004
|
* <p>The unique identifier of the updated Changeset.</p>
|
|
2005
2005
|
* @public
|
|
2006
2006
|
*/
|
|
2007
|
-
updatedByChangesetId?: string;
|
|
2007
|
+
updatedByChangesetId?: string | undefined;
|
|
2008
2008
|
}
|
|
2009
2009
|
/**
|
|
2010
2010
|
* Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
|
|
@@ -2015,12 +2015,12 @@ export interface ListChangesetsResponse {
|
|
|
2015
2015
|
* <p>List of Changesets found.</p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
|
-
changesets?: ChangesetSummary[];
|
|
2018
|
+
changesets?: ChangesetSummary[] | undefined;
|
|
2019
2019
|
/**
|
|
2020
2020
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2021
2021
|
* @public
|
|
2022
2022
|
*/
|
|
2023
|
-
nextToken?: string;
|
|
2023
|
+
nextToken?: string | undefined;
|
|
2024
2024
|
}
|
|
2025
2025
|
/**
|
|
2026
2026
|
* Request for the ListDatasets operation.
|
|
@@ -2031,12 +2031,12 @@ export interface ListDatasetsRequest {
|
|
|
2031
2031
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2032
2032
|
* @public
|
|
2033
2033
|
*/
|
|
2034
|
-
nextToken?: string;
|
|
2034
|
+
nextToken?: string | undefined;
|
|
2035
2035
|
/**
|
|
2036
2036
|
* <p>The maximum number of results per page.</p>
|
|
2037
2037
|
* @public
|
|
2038
2038
|
*/
|
|
2039
|
-
maxResults?: number;
|
|
2039
|
+
maxResults?: number | undefined;
|
|
2040
2040
|
}
|
|
2041
2041
|
/**
|
|
2042
2042
|
* <p>The structure for a Dataset.</p>
|
|
@@ -2047,17 +2047,17 @@ export interface Dataset {
|
|
|
2047
2047
|
* <p>An identifier for a Dataset.</p>
|
|
2048
2048
|
* @public
|
|
2049
2049
|
*/
|
|
2050
|
-
datasetId?: string;
|
|
2050
|
+
datasetId?: string | undefined;
|
|
2051
2051
|
/**
|
|
2052
2052
|
* <p>The ARN identifier of the Dataset.</p>
|
|
2053
2053
|
* @public
|
|
2054
2054
|
*/
|
|
2055
|
-
datasetArn?: string;
|
|
2055
|
+
datasetArn?: string | undefined;
|
|
2056
2056
|
/**
|
|
2057
2057
|
* <p>Display title for a Dataset.</p>
|
|
2058
2058
|
* @public
|
|
2059
2059
|
*/
|
|
2060
|
-
datasetTitle?: string;
|
|
2060
|
+
datasetTitle?: string | undefined;
|
|
2061
2061
|
/**
|
|
2062
2062
|
* <p>The format in which Dataset data is structured.</p>
|
|
2063
2063
|
* <ul>
|
|
@@ -2072,37 +2072,37 @@ export interface Dataset {
|
|
|
2072
2072
|
* </ul>
|
|
2073
2073
|
* @public
|
|
2074
2074
|
*/
|
|
2075
|
-
kind?: DatasetKind;
|
|
2075
|
+
kind?: DatasetKind | undefined;
|
|
2076
2076
|
/**
|
|
2077
2077
|
* <p>Description for a Dataset.</p>
|
|
2078
2078
|
* @public
|
|
2079
2079
|
*/
|
|
2080
|
-
datasetDescription?: string;
|
|
2080
|
+
datasetDescription?: string | undefined;
|
|
2081
2081
|
/**
|
|
2082
2082
|
* <p>Contact information for a Dataset owner.</p>
|
|
2083
2083
|
* @public
|
|
2084
2084
|
*/
|
|
2085
|
-
ownerInfo?: DatasetOwnerInfo;
|
|
2085
|
+
ownerInfo?: DatasetOwnerInfo | undefined;
|
|
2086
2086
|
/**
|
|
2087
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
2088
|
* @public
|
|
2089
2089
|
*/
|
|
2090
|
-
createTime?: number;
|
|
2090
|
+
createTime?: number | undefined;
|
|
2091
2091
|
/**
|
|
2092
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
2093
|
* @public
|
|
2094
2094
|
*/
|
|
2095
|
-
lastModifiedTime?: number;
|
|
2095
|
+
lastModifiedTime?: number | undefined;
|
|
2096
2096
|
/**
|
|
2097
2097
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
2098
2098
|
* @public
|
|
2099
2099
|
*/
|
|
2100
|
-
schemaDefinition?: SchemaUnion;
|
|
2100
|
+
schemaDefinition?: SchemaUnion | undefined;
|
|
2101
2101
|
/**
|
|
2102
2102
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
2103
2103
|
* @public
|
|
2104
2104
|
*/
|
|
2105
|
-
alias?: string;
|
|
2105
|
+
alias?: string | undefined;
|
|
2106
2106
|
}
|
|
2107
2107
|
/**
|
|
2108
2108
|
* Response for the ListDatasets operation
|
|
@@ -2113,12 +2113,12 @@ export interface ListDatasetsResponse {
|
|
|
2113
2113
|
* <p>List of Datasets.</p>
|
|
2114
2114
|
* @public
|
|
2115
2115
|
*/
|
|
2116
|
-
datasets?: Dataset[];
|
|
2116
|
+
datasets?: Dataset[] | undefined;
|
|
2117
2117
|
/**
|
|
2118
2118
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2119
2119
|
* @public
|
|
2120
2120
|
*/
|
|
2121
|
-
nextToken?: string;
|
|
2121
|
+
nextToken?: string | undefined;
|
|
2122
2122
|
}
|
|
2123
2123
|
/**
|
|
2124
2124
|
* Request for a list data views.
|
|
@@ -2134,12 +2134,12 @@ export interface ListDataViewsRequest {
|
|
|
2134
2134
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2135
2135
|
* @public
|
|
2136
2136
|
*/
|
|
2137
|
-
nextToken?: string;
|
|
2137
|
+
nextToken?: string | undefined;
|
|
2138
2138
|
/**
|
|
2139
2139
|
* <p>The maximum number of results per page.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
maxResults?: number;
|
|
2142
|
+
maxResults?: number | undefined;
|
|
2143
2143
|
}
|
|
2144
2144
|
/**
|
|
2145
2145
|
* <p>Structure for the summary of a Dataview.</p>
|
|
@@ -2150,32 +2150,32 @@ export interface DataViewSummary {
|
|
|
2150
2150
|
* <p>The unique identifier for the Dataview.</p>
|
|
2151
2151
|
* @public
|
|
2152
2152
|
*/
|
|
2153
|
-
dataViewId?: string;
|
|
2153
|
+
dataViewId?: string | undefined;
|
|
2154
2154
|
/**
|
|
2155
2155
|
* <p>The ARN identifier of the Dataview.</p>
|
|
2156
2156
|
* @public
|
|
2157
2157
|
*/
|
|
2158
|
-
dataViewArn?: string;
|
|
2158
|
+
dataViewArn?: string | undefined;
|
|
2159
2159
|
/**
|
|
2160
2160
|
* <p>Th unique identifier for the Dataview Dataset.</p>
|
|
2161
2161
|
* @public
|
|
2162
2162
|
*/
|
|
2163
|
-
datasetId?: string;
|
|
2163
|
+
datasetId?: string | undefined;
|
|
2164
2164
|
/**
|
|
2165
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
2166
|
* @public
|
|
2167
2167
|
*/
|
|
2168
|
-
asOfTimestamp?: number;
|
|
2168
|
+
asOfTimestamp?: number | undefined;
|
|
2169
2169
|
/**
|
|
2170
2170
|
* <p>Ordered set of column names used to partition data.</p>
|
|
2171
2171
|
* @public
|
|
2172
2172
|
*/
|
|
2173
|
-
partitionColumns?: string[];
|
|
2173
|
+
partitionColumns?: string[] | undefined;
|
|
2174
2174
|
/**
|
|
2175
2175
|
* <p>Columns to be used for sorting the data.</p>
|
|
2176
2176
|
* @public
|
|
2177
2177
|
*/
|
|
2178
|
-
sortColumns?: string[];
|
|
2178
|
+
sortColumns?: string[] | undefined;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* <p>The status of a Dataview creation.</p>
|
|
2181
2181
|
* <ul>
|
|
@@ -2214,32 +2214,32 @@ export interface DataViewSummary {
|
|
|
2214
2214
|
* </ul>
|
|
2215
2215
|
* @public
|
|
2216
2216
|
*/
|
|
2217
|
-
status?: DataViewStatus;
|
|
2217
|
+
status?: DataViewStatus | undefined;
|
|
2218
2218
|
/**
|
|
2219
2219
|
* <p>The structure with error messages.</p>
|
|
2220
2220
|
* @public
|
|
2221
2221
|
*/
|
|
2222
|
-
errorInfo?: DataViewErrorInfo;
|
|
2222
|
+
errorInfo?: DataViewErrorInfo | undefined;
|
|
2223
2223
|
/**
|
|
2224
2224
|
* <p>Information about the Dataview destination.</p>
|
|
2225
2225
|
* @public
|
|
2226
2226
|
*/
|
|
2227
|
-
destinationTypeProperties?: DataViewDestinationTypeParams;
|
|
2227
|
+
destinationTypeProperties?: DataViewDestinationTypeParams | undefined;
|
|
2228
2228
|
/**
|
|
2229
2229
|
* <p>The flag to indicate Dataview should be updated automatically.</p>
|
|
2230
2230
|
* @public
|
|
2231
2231
|
*/
|
|
2232
|
-
autoUpdate?: boolean;
|
|
2232
|
+
autoUpdate?: boolean | undefined;
|
|
2233
2233
|
/**
|
|
2234
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
2235
|
* @public
|
|
2236
2236
|
*/
|
|
2237
|
-
createTime?: number;
|
|
2237
|
+
createTime?: number | undefined;
|
|
2238
2238
|
/**
|
|
2239
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
2240
|
* @public
|
|
2241
2241
|
*/
|
|
2242
|
-
lastModifiedTime?: number;
|
|
2242
|
+
lastModifiedTime?: number | undefined;
|
|
2243
2243
|
}
|
|
2244
2244
|
/**
|
|
2245
2245
|
* @public
|
|
@@ -2249,12 +2249,12 @@ export interface ListDataViewsResponse {
|
|
|
2249
2249
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2250
2250
|
* @public
|
|
2251
2251
|
*/
|
|
2252
|
-
nextToken?: string;
|
|
2252
|
+
nextToken?: string | undefined;
|
|
2253
2253
|
/**
|
|
2254
2254
|
* <p>A list of Dataviews.</p>
|
|
2255
2255
|
* @public
|
|
2256
2256
|
*/
|
|
2257
|
-
dataViews?: DataViewSummary[];
|
|
2257
|
+
dataViews?: DataViewSummary[] | undefined;
|
|
2258
2258
|
}
|
|
2259
2259
|
/**
|
|
2260
2260
|
* @public
|
|
@@ -2264,7 +2264,7 @@ export interface ListPermissionGroupsRequest {
|
|
|
2264
2264
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2265
2265
|
* @public
|
|
2266
2266
|
*/
|
|
2267
|
-
nextToken?: string;
|
|
2267
|
+
nextToken?: string | undefined;
|
|
2268
2268
|
/**
|
|
2269
2269
|
* <p>The maximum number of results per page.</p>
|
|
2270
2270
|
* @public
|
|
@@ -2279,12 +2279,12 @@ export interface ListPermissionGroupsResponse {
|
|
|
2279
2279
|
* <p>A list of all the permission groups.</p>
|
|
2280
2280
|
* @public
|
|
2281
2281
|
*/
|
|
2282
|
-
permissionGroups?: PermissionGroup[];
|
|
2282
|
+
permissionGroups?: PermissionGroup[] | undefined;
|
|
2283
2283
|
/**
|
|
2284
2284
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2285
2285
|
* @public
|
|
2286
2286
|
*/
|
|
2287
|
-
nextToken?: string;
|
|
2287
|
+
nextToken?: string | undefined;
|
|
2288
2288
|
}
|
|
2289
2289
|
/**
|
|
2290
2290
|
* @public
|
|
@@ -2299,7 +2299,7 @@ export interface ListPermissionGroupsByUserRequest {
|
|
|
2299
2299
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2300
2300
|
* @public
|
|
2301
2301
|
*/
|
|
2302
|
-
nextToken?: string;
|
|
2302
|
+
nextToken?: string | undefined;
|
|
2303
2303
|
/**
|
|
2304
2304
|
* <p>The maximum number of results per page.</p>
|
|
2305
2305
|
* @public
|
|
@@ -2315,12 +2315,12 @@ export interface PermissionGroupByUser {
|
|
|
2315
2315
|
* <p>The unique identifier for the permission group.</p>
|
|
2316
2316
|
* @public
|
|
2317
2317
|
*/
|
|
2318
|
-
permissionGroupId?: string;
|
|
2318
|
+
permissionGroupId?: string | undefined;
|
|
2319
2319
|
/**
|
|
2320
2320
|
* <p>The name of the permission group.</p>
|
|
2321
2321
|
* @public
|
|
2322
2322
|
*/
|
|
2323
|
-
name?: string;
|
|
2323
|
+
name?: string | undefined;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* <p>Indicates the status of the user within a permission group.</p>
|
|
2326
2326
|
* <ul>
|
|
@@ -2339,7 +2339,7 @@ export interface PermissionGroupByUser {
|
|
|
2339
2339
|
* </ul>
|
|
2340
2340
|
* @public
|
|
2341
2341
|
*/
|
|
2342
|
-
membershipStatus?: PermissionGroupMembershipStatus;
|
|
2342
|
+
membershipStatus?: PermissionGroupMembershipStatus | undefined;
|
|
2343
2343
|
}
|
|
2344
2344
|
/**
|
|
2345
2345
|
* @public
|
|
@@ -2349,12 +2349,12 @@ export interface ListPermissionGroupsByUserResponse {
|
|
|
2349
2349
|
* <p>A list of returned permission groups.</p>
|
|
2350
2350
|
* @public
|
|
2351
2351
|
*/
|
|
2352
|
-
permissionGroups?: PermissionGroupByUser[];
|
|
2352
|
+
permissionGroups?: PermissionGroupByUser[] | undefined;
|
|
2353
2353
|
/**
|
|
2354
2354
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2355
2355
|
* @public
|
|
2356
2356
|
*/
|
|
2357
|
-
nextToken?: string;
|
|
2357
|
+
nextToken?: string | undefined;
|
|
2358
2358
|
}
|
|
2359
2359
|
/**
|
|
2360
2360
|
* @public
|
|
@@ -2364,7 +2364,7 @@ export interface ListUsersRequest {
|
|
|
2364
2364
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2365
2365
|
* @public
|
|
2366
2366
|
*/
|
|
2367
|
-
nextToken?: string;
|
|
2367
|
+
nextToken?: string | undefined;
|
|
2368
2368
|
/**
|
|
2369
2369
|
* <p>The maximum number of results per page.</p>
|
|
2370
2370
|
* @public
|
|
@@ -2380,7 +2380,7 @@ export interface User {
|
|
|
2380
2380
|
* <p>The unique identifier for the user.</p>
|
|
2381
2381
|
* @public
|
|
2382
2382
|
*/
|
|
2383
|
-
userId?: string;
|
|
2383
|
+
userId?: string | undefined;
|
|
2384
2384
|
/**
|
|
2385
2385
|
* <p>The current status of the user. </p>
|
|
2386
2386
|
* <ul>
|
|
@@ -2399,22 +2399,22 @@ export interface User {
|
|
|
2399
2399
|
* </ul>
|
|
2400
2400
|
* @public
|
|
2401
2401
|
*/
|
|
2402
|
-
status?: UserStatus;
|
|
2402
|
+
status?: UserStatus | undefined;
|
|
2403
2403
|
/**
|
|
2404
2404
|
* <p>The first name of the user.</p>
|
|
2405
2405
|
* @public
|
|
2406
2406
|
*/
|
|
2407
|
-
firstName?: string;
|
|
2407
|
+
firstName?: string | undefined;
|
|
2408
2408
|
/**
|
|
2409
2409
|
* <p> The last name of the user.</p>
|
|
2410
2410
|
* @public
|
|
2411
2411
|
*/
|
|
2412
|
-
lastName?: string;
|
|
2412
|
+
lastName?: string | undefined;
|
|
2413
2413
|
/**
|
|
2414
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
2415
|
* @public
|
|
2416
2416
|
*/
|
|
2417
|
-
emailAddress?: string;
|
|
2417
|
+
emailAddress?: string | undefined;
|
|
2418
2418
|
/**
|
|
2419
2419
|
* <p> Indicates the type of user.</p>
|
|
2420
2420
|
* <ul>
|
|
@@ -2429,7 +2429,7 @@ export interface User {
|
|
|
2429
2429
|
* </ul>
|
|
2430
2430
|
* @public
|
|
2431
2431
|
*/
|
|
2432
|
-
type?: UserType;
|
|
2432
|
+
type?: UserType | undefined;
|
|
2433
2433
|
/**
|
|
2434
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>
|
|
2435
2435
|
* <ul>
|
|
@@ -2444,40 +2444,40 @@ export interface User {
|
|
|
2444
2444
|
* </ul>
|
|
2445
2445
|
* @public
|
|
2446
2446
|
*/
|
|
2447
|
-
apiAccess?: ApiAccess;
|
|
2447
|
+
apiAccess?: ApiAccess | undefined;
|
|
2448
2448
|
/**
|
|
2449
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
2450
|
* @public
|
|
2451
2451
|
*/
|
|
2452
|
-
apiAccessPrincipalArn?: string;
|
|
2452
|
+
apiAccessPrincipalArn?: string | undefined;
|
|
2453
2453
|
/**
|
|
2454
2454
|
* <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
2455
2455
|
* @public
|
|
2456
2456
|
*/
|
|
2457
|
-
createTime?: number;
|
|
2457
|
+
createTime?: number | undefined;
|
|
2458
2458
|
/**
|
|
2459
2459
|
* <p> Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
|
|
2460
2460
|
* </p>
|
|
2461
2461
|
* @public
|
|
2462
2462
|
*/
|
|
2463
|
-
lastEnabledTime?: number;
|
|
2463
|
+
lastEnabledTime?: number | undefined;
|
|
2464
2464
|
/**
|
|
2465
2465
|
* <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
|
|
2466
2466
|
* @public
|
|
2467
2467
|
*/
|
|
2468
|
-
lastDisabledTime?: number;
|
|
2468
|
+
lastDisabledTime?: number | undefined;
|
|
2469
2469
|
/**
|
|
2470
2470
|
* <p>Describes the last time the user was updated. The value is determined as epoch time in milliseconds.
|
|
2471
2471
|
* </p>
|
|
2472
2472
|
* @public
|
|
2473
2473
|
*/
|
|
2474
|
-
lastModifiedTime?: number;
|
|
2474
|
+
lastModifiedTime?: number | undefined;
|
|
2475
2475
|
/**
|
|
2476
2476
|
* <p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
|
|
2477
2477
|
* </p>
|
|
2478
2478
|
* @public
|
|
2479
2479
|
*/
|
|
2480
|
-
lastLoginTime?: number;
|
|
2480
|
+
lastLoginTime?: number | undefined;
|
|
2481
2481
|
}
|
|
2482
2482
|
/**
|
|
2483
2483
|
* @public
|
|
@@ -2487,12 +2487,12 @@ export interface ListUsersResponse {
|
|
|
2487
2487
|
* <p>A list of all the users.</p>
|
|
2488
2488
|
* @public
|
|
2489
2489
|
*/
|
|
2490
|
-
users?: User[];
|
|
2490
|
+
users?: User[] | undefined;
|
|
2491
2491
|
/**
|
|
2492
2492
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2493
2493
|
* @public
|
|
2494
2494
|
*/
|
|
2495
|
-
nextToken?: string;
|
|
2495
|
+
nextToken?: string | undefined;
|
|
2496
2496
|
}
|
|
2497
2497
|
/**
|
|
2498
2498
|
* @public
|
|
@@ -2507,7 +2507,7 @@ export interface ListUsersByPermissionGroupRequest {
|
|
|
2507
2507
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2508
2508
|
* @public
|
|
2509
2509
|
*/
|
|
2510
|
-
nextToken?: string;
|
|
2510
|
+
nextToken?: string | undefined;
|
|
2511
2511
|
/**
|
|
2512
2512
|
* <p>The maximum number of results per page.</p>
|
|
2513
2513
|
* @public
|
|
@@ -2523,7 +2523,7 @@ export interface UserByPermissionGroup {
|
|
|
2523
2523
|
* <p>The unique identifier for the user.</p>
|
|
2524
2524
|
* @public
|
|
2525
2525
|
*/
|
|
2526
|
-
userId?: string;
|
|
2526
|
+
userId?: string | undefined;
|
|
2527
2527
|
/**
|
|
2528
2528
|
* <p>The current status of the user. </p>
|
|
2529
2529
|
* <ul>
|
|
@@ -2542,22 +2542,22 @@ export interface UserByPermissionGroup {
|
|
|
2542
2542
|
* </ul>
|
|
2543
2543
|
* @public
|
|
2544
2544
|
*/
|
|
2545
|
-
status?: UserStatus;
|
|
2545
|
+
status?: UserStatus | undefined;
|
|
2546
2546
|
/**
|
|
2547
2547
|
* <p>The first name of the user.</p>
|
|
2548
2548
|
* @public
|
|
2549
2549
|
*/
|
|
2550
|
-
firstName?: string;
|
|
2550
|
+
firstName?: string | undefined;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* <p>The last name of the user.</p>
|
|
2553
2553
|
* @public
|
|
2554
2554
|
*/
|
|
2555
|
-
lastName?: string;
|
|
2555
|
+
lastName?: string | undefined;
|
|
2556
2556
|
/**
|
|
2557
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
2558
|
* @public
|
|
2559
2559
|
*/
|
|
2560
|
-
emailAddress?: string;
|
|
2560
|
+
emailAddress?: string | undefined;
|
|
2561
2561
|
/**
|
|
2562
2562
|
* <p> Indicates the type of user.</p>
|
|
2563
2563
|
* <ul>
|
|
@@ -2572,7 +2572,7 @@ export interface UserByPermissionGroup {
|
|
|
2572
2572
|
* </ul>
|
|
2573
2573
|
* @public
|
|
2574
2574
|
*/
|
|
2575
|
-
type?: UserType;
|
|
2575
|
+
type?: UserType | undefined;
|
|
2576
2576
|
/**
|
|
2577
2577
|
* <p>Indicates whether the user can access FinSpace API operations.</p>
|
|
2578
2578
|
* <ul>
|
|
@@ -2587,12 +2587,12 @@ export interface UserByPermissionGroup {
|
|
|
2587
2587
|
* </ul>
|
|
2588
2588
|
* @public
|
|
2589
2589
|
*/
|
|
2590
|
-
apiAccess?: ApiAccess;
|
|
2590
|
+
apiAccess?: ApiAccess | undefined;
|
|
2591
2591
|
/**
|
|
2592
2592
|
* <p>The IAM ARN identifier that is attached to FinSpace API calls.</p>
|
|
2593
2593
|
* @public
|
|
2594
2594
|
*/
|
|
2595
|
-
apiAccessPrincipalArn?: string;
|
|
2595
|
+
apiAccessPrincipalArn?: string | undefined;
|
|
2596
2596
|
/**
|
|
2597
2597
|
* <p>Indicates the status of the user within a permission group.</p>
|
|
2598
2598
|
* <ul>
|
|
@@ -2611,7 +2611,7 @@ export interface UserByPermissionGroup {
|
|
|
2611
2611
|
* </ul>
|
|
2612
2612
|
* @public
|
|
2613
2613
|
*/
|
|
2614
|
-
membershipStatus?: PermissionGroupMembershipStatus;
|
|
2614
|
+
membershipStatus?: PermissionGroupMembershipStatus | undefined;
|
|
2615
2615
|
}
|
|
2616
2616
|
/**
|
|
2617
2617
|
* @public
|
|
@@ -2621,12 +2621,12 @@ export interface ListUsersByPermissionGroupResponse {
|
|
|
2621
2621
|
* <p>Lists details of all users in a specific permission group.</p>
|
|
2622
2622
|
* @public
|
|
2623
2623
|
*/
|
|
2624
|
-
users?: UserByPermissionGroup[];
|
|
2624
|
+
users?: UserByPermissionGroup[] | undefined;
|
|
2625
2625
|
/**
|
|
2626
2626
|
* <p>A token that indicates where a results page should begin.</p>
|
|
2627
2627
|
* @public
|
|
2628
2628
|
*/
|
|
2629
|
-
nextToken?: string;
|
|
2629
|
+
nextToken?: string | undefined;
|
|
2630
2630
|
}
|
|
2631
2631
|
/**
|
|
2632
2632
|
* @public
|
|
@@ -2641,7 +2641,7 @@ export interface ResetUserPasswordRequest {
|
|
|
2641
2641
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2642
2642
|
* @public
|
|
2643
2643
|
*/
|
|
2644
|
-
clientToken?: string;
|
|
2644
|
+
clientToken?: string | undefined;
|
|
2645
2645
|
}
|
|
2646
2646
|
/**
|
|
2647
2647
|
* @public
|
|
@@ -2651,12 +2651,12 @@ export interface ResetUserPasswordResponse {
|
|
|
2651
2651
|
* <p>The unique identifier of the user that a new password is generated for.</p>
|
|
2652
2652
|
* @public
|
|
2653
2653
|
*/
|
|
2654
|
-
userId?: string;
|
|
2654
|
+
userId?: string | undefined;
|
|
2655
2655
|
/**
|
|
2656
2656
|
* <p>A randomly generated temporary password for the requested user. This password expires in 7 days.</p>
|
|
2657
2657
|
* @public
|
|
2658
2658
|
*/
|
|
2659
|
-
temporaryPassword?: string;
|
|
2659
|
+
temporaryPassword?: string | undefined;
|
|
2660
2660
|
}
|
|
2661
2661
|
/**
|
|
2662
2662
|
* Request to update an existing changeset.
|
|
@@ -2667,7 +2667,7 @@ export interface UpdateChangesetRequest {
|
|
|
2667
2667
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2668
2668
|
* @public
|
|
2669
2669
|
*/
|
|
2670
|
-
clientToken?: string;
|
|
2670
|
+
clientToken?: string | undefined;
|
|
2671
2671
|
/**
|
|
2672
2672
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
2673
2673
|
* @public
|
|
@@ -2754,12 +2754,12 @@ export interface UpdateChangesetResponse {
|
|
|
2754
2754
|
* <p>The unique identifier for the Changeset to update.</p>
|
|
2755
2755
|
* @public
|
|
2756
2756
|
*/
|
|
2757
|
-
changesetId?: string;
|
|
2757
|
+
changesetId?: string | undefined;
|
|
2758
2758
|
/**
|
|
2759
2759
|
* <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
|
|
2760
2760
|
* @public
|
|
2761
2761
|
*/
|
|
2762
|
-
datasetId?: string;
|
|
2762
|
+
datasetId?: string | undefined;
|
|
2763
2763
|
}
|
|
2764
2764
|
/**
|
|
2765
2765
|
* The request for an UpdateDataset operation
|
|
@@ -2770,7 +2770,7 @@ export interface UpdateDatasetRequest {
|
|
|
2770
2770
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2771
2771
|
* @public
|
|
2772
2772
|
*/
|
|
2773
|
-
clientToken?: string;
|
|
2773
|
+
clientToken?: string | undefined;
|
|
2774
2774
|
/**
|
|
2775
2775
|
* <p>The unique identifier for the Dataset to update.</p>
|
|
2776
2776
|
* @public
|
|
@@ -2800,17 +2800,17 @@ export interface UpdateDatasetRequest {
|
|
|
2800
2800
|
* <p>A description for the Dataset.</p>
|
|
2801
2801
|
* @public
|
|
2802
2802
|
*/
|
|
2803
|
-
datasetDescription?: string;
|
|
2803
|
+
datasetDescription?: string | undefined;
|
|
2804
2804
|
/**
|
|
2805
2805
|
* <p>The unique resource identifier for a Dataset.</p>
|
|
2806
2806
|
* @public
|
|
2807
2807
|
*/
|
|
2808
|
-
alias?: string;
|
|
2808
|
+
alias?: string | undefined;
|
|
2809
2809
|
/**
|
|
2810
2810
|
* <p>Definition for a schema on a tabular Dataset.</p>
|
|
2811
2811
|
* @public
|
|
2812
2812
|
*/
|
|
2813
|
-
schemaDefinition?: SchemaUnion;
|
|
2813
|
+
schemaDefinition?: SchemaUnion | undefined;
|
|
2814
2814
|
}
|
|
2815
2815
|
/**
|
|
2816
2816
|
* The response from an UpdateDataset operation
|
|
@@ -2821,7 +2821,7 @@ export interface UpdateDatasetResponse {
|
|
|
2821
2821
|
* <p>The unique identifier for updated Dataset.</p>
|
|
2822
2822
|
* @public
|
|
2823
2823
|
*/
|
|
2824
|
-
datasetId?: string;
|
|
2824
|
+
datasetId?: string | undefined;
|
|
2825
2825
|
}
|
|
2826
2826
|
/**
|
|
2827
2827
|
* @public
|
|
@@ -2836,12 +2836,12 @@ export interface UpdatePermissionGroupRequest {
|
|
|
2836
2836
|
* <p>The name of the permission group.</p>
|
|
2837
2837
|
* @public
|
|
2838
2838
|
*/
|
|
2839
|
-
name?: string;
|
|
2839
|
+
name?: string | undefined;
|
|
2840
2840
|
/**
|
|
2841
2841
|
* <p>A brief description for the permission group.</p>
|
|
2842
2842
|
* @public
|
|
2843
2843
|
*/
|
|
2844
|
-
description?: string;
|
|
2844
|
+
description?: string | undefined;
|
|
2845
2845
|
/**
|
|
2846
2846
|
* <p>The permissions that are granted to a specific group for accessing the FinSpace application.</p>
|
|
2847
2847
|
* <important>
|
|
@@ -2879,12 +2879,12 @@ export interface UpdatePermissionGroupRequest {
|
|
|
2879
2879
|
* </ul>
|
|
2880
2880
|
* @public
|
|
2881
2881
|
*/
|
|
2882
|
-
applicationPermissions?: ApplicationPermission[];
|
|
2882
|
+
applicationPermissions?: ApplicationPermission[] | undefined;
|
|
2883
2883
|
/**
|
|
2884
2884
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2885
2885
|
* @public
|
|
2886
2886
|
*/
|
|
2887
|
-
clientToken?: string;
|
|
2887
|
+
clientToken?: string | undefined;
|
|
2888
2888
|
}
|
|
2889
2889
|
/**
|
|
2890
2890
|
* @public
|
|
@@ -2894,7 +2894,7 @@ export interface UpdatePermissionGroupResponse {
|
|
|
2894
2894
|
* <p>The unique identifier for the updated permission group.</p>
|
|
2895
2895
|
* @public
|
|
2896
2896
|
*/
|
|
2897
|
-
permissionGroupId?: string;
|
|
2897
|
+
permissionGroupId?: string | undefined;
|
|
2898
2898
|
}
|
|
2899
2899
|
/**
|
|
2900
2900
|
* @public
|
|
@@ -2919,17 +2919,17 @@ export interface UpdateUserRequest {
|
|
|
2919
2919
|
* </ul>
|
|
2920
2920
|
* @public
|
|
2921
2921
|
*/
|
|
2922
|
-
type?: UserType;
|
|
2922
|
+
type?: UserType | undefined;
|
|
2923
2923
|
/**
|
|
2924
2924
|
* <p>The first name of the user.</p>
|
|
2925
2925
|
* @public
|
|
2926
2926
|
*/
|
|
2927
|
-
firstName?: string;
|
|
2927
|
+
firstName?: string | undefined;
|
|
2928
2928
|
/**
|
|
2929
2929
|
* <p>The last name of the user.</p>
|
|
2930
2930
|
* @public
|
|
2931
2931
|
*/
|
|
2932
|
-
lastName?: string;
|
|
2932
|
+
lastName?: string | undefined;
|
|
2933
2933
|
/**
|
|
2934
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>
|
|
2935
2935
|
* <ul>
|
|
@@ -2944,17 +2944,17 @@ export interface UpdateUserRequest {
|
|
|
2944
2944
|
* </ul>
|
|
2945
2945
|
* @public
|
|
2946
2946
|
*/
|
|
2947
|
-
apiAccess?: ApiAccess;
|
|
2947
|
+
apiAccess?: ApiAccess | undefined;
|
|
2948
2948
|
/**
|
|
2949
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
2950
|
* @public
|
|
2951
2951
|
*/
|
|
2952
|
-
apiAccessPrincipalArn?: string;
|
|
2952
|
+
apiAccessPrincipalArn?: string | undefined;
|
|
2953
2953
|
/**
|
|
2954
2954
|
* <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
|
|
2955
2955
|
* @public
|
|
2956
2956
|
*/
|
|
2957
|
-
clientToken?: string;
|
|
2957
|
+
clientToken?: string | undefined;
|
|
2958
2958
|
}
|
|
2959
2959
|
/**
|
|
2960
2960
|
* @public
|
|
@@ -2964,7 +2964,7 @@ export interface UpdateUserResponse {
|
|
|
2964
2964
|
* <p>The unique identifier of the updated user.</p>
|
|
2965
2965
|
* @public
|
|
2966
2966
|
*/
|
|
2967
|
-
userId?: string;
|
|
2967
|
+
userId?: string | undefined;
|
|
2968
2968
|
}
|
|
2969
2969
|
/**
|
|
2970
2970
|
* @internal
|