@aws-sdk/client-cleanrooms 3.398.0 → 3.405.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/README.md +7 -5
- package/dist-cjs/models/models_0.js +16 -6
- package/dist-cjs/protocols/Aws_restJson1.js +3 -0
- package/dist-es/models/models_0.js +14 -4
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/CleanRooms.d.ts +8 -6
- package/dist-types/CleanRoomsClient.d.ts +8 -6
- package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateMembershipCommand.d.ts +20 -0
- package/dist-types/commands/GetMembershipCommand.d.ts +10 -0
- package/dist-types/commands/GetProtectedQueryCommand.d.ts +5 -0
- package/dist-types/commands/StartProtectedQueryCommand.d.ts +6 -1
- package/dist-types/commands/UpdateMembershipCommand.d.ts +20 -0
- package/dist-types/commands/UpdateProtectedQueryCommand.d.ts +5 -0
- package/dist-types/index.d.ts +8 -6
- package/dist-types/models/models_0.d.ts +331 -138
- package/dist-types/ts3.4/models/models_0.d.ts +53 -13
- package/package.json +7 -7
|
@@ -72,12 +72,14 @@ export declare const AggregationType: {
|
|
|
72
72
|
export type AggregationType = (typeof AggregationType)[keyof typeof AggregationType];
|
|
73
73
|
/**
|
|
74
74
|
* @public
|
|
75
|
-
* <p>Constraint on query output removing output rows that do not meet a minimum number of
|
|
75
|
+
* <p>Constraint on query output removing output rows that do not meet a minimum number of
|
|
76
|
+
* distinct values of a specified column.</p>
|
|
76
77
|
*/
|
|
77
78
|
export interface AggregationConstraint {
|
|
78
79
|
/**
|
|
79
80
|
* @public
|
|
80
|
-
* <p>Column in aggregation constraint for which there must be a minimum number of distinct
|
|
81
|
+
* <p>Column in aggregation constraint for which there must be a minimum number of distinct
|
|
82
|
+
* values in an output row for it to be in the query output.</p>
|
|
81
83
|
*/
|
|
82
84
|
columnName: string | undefined;
|
|
83
85
|
/**
|
|
@@ -149,8 +151,8 @@ export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
|
|
|
149
151
|
export interface AnalysisParameter {
|
|
150
152
|
/**
|
|
151
153
|
* @public
|
|
152
|
-
* <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or
|
|
153
|
-
* characters but cannot start or end with a hyphen.</p>
|
|
154
|
+
* <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or
|
|
155
|
+
* hyphen (-) characters but cannot start or end with a hyphen.</p>
|
|
154
156
|
*/
|
|
155
157
|
name: string | undefined;
|
|
156
158
|
/**
|
|
@@ -213,7 +215,8 @@ export declare const ScalarFunctions: {
|
|
|
213
215
|
export type ScalarFunctions = (typeof ScalarFunctions)[keyof typeof ScalarFunctions];
|
|
214
216
|
/**
|
|
215
217
|
* @public
|
|
216
|
-
* <p>A type of analysis rule that enables query structure and specified queries that produce
|
|
218
|
+
* <p>A type of analysis rule that enables query structure and specified queries that produce
|
|
219
|
+
* aggregate statistics.</p>
|
|
217
220
|
*/
|
|
218
221
|
export interface AnalysisRuleAggregation {
|
|
219
222
|
/**
|
|
@@ -246,18 +249,21 @@ export interface AnalysisRuleAggregation {
|
|
|
246
249
|
dimensionColumns: string[] | undefined;
|
|
247
250
|
/**
|
|
248
251
|
* @public
|
|
249
|
-
* <p>Set of scalar functions that are allowed to be used on dimension columns and the output
|
|
252
|
+
* <p>Set of scalar functions that are allowed to be used on dimension columns and the output
|
|
253
|
+
* of aggregation of metrics.</p>
|
|
250
254
|
*/
|
|
251
255
|
scalarFunctions: (ScalarFunctions | string)[] | undefined;
|
|
252
256
|
/**
|
|
253
257
|
* @public
|
|
254
|
-
* <p>Columns that must meet a specific threshold value (after an aggregation function is
|
|
258
|
+
* <p>Columns that must meet a specific threshold value (after an aggregation function is
|
|
259
|
+
* applied to it) for each output row to be returned.</p>
|
|
255
260
|
*/
|
|
256
261
|
outputConstraints: AggregationConstraint[] | undefined;
|
|
257
262
|
}
|
|
258
263
|
/**
|
|
259
264
|
* @public
|
|
260
|
-
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
265
|
+
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
266
|
+
* their configured tables.</p>
|
|
261
267
|
*/
|
|
262
268
|
export interface AnalysisRuleCustom {
|
|
263
269
|
/**
|
|
@@ -279,7 +285,8 @@ export interface AnalysisRuleCustom {
|
|
|
279
285
|
export interface AnalysisRuleList {
|
|
280
286
|
/**
|
|
281
287
|
* @public
|
|
282
|
-
* <p>Columns that can be used to join a configured table with the table of the member who can
|
|
288
|
+
* <p>Columns that can be used to join a configured table with the table of the member who can
|
|
289
|
+
* query and other members' configured tables.</p>
|
|
283
290
|
*/
|
|
284
291
|
joinColumns: string[] | undefined;
|
|
285
292
|
/**
|
|
@@ -632,7 +639,10 @@ export interface CreateAnalysisTemplateInput {
|
|
|
632
639
|
source: AnalysisSource | undefined;
|
|
633
640
|
/**
|
|
634
641
|
* @public
|
|
635
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
642
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
643
|
+
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
644
|
+
* you can also use tag-based access control in IAM policies to control access
|
|
645
|
+
* to this resource.</p>
|
|
636
646
|
*/
|
|
637
647
|
tags?: Record<string, string>;
|
|
638
648
|
/**
|
|
@@ -827,7 +837,8 @@ export interface ListAnalysisTemplatesInput {
|
|
|
827
837
|
membershipIdentifier: string | undefined;
|
|
828
838
|
/**
|
|
829
839
|
* @public
|
|
830
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
840
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
841
|
+
* results.</p>
|
|
831
842
|
*/
|
|
832
843
|
nextToken?: string;
|
|
833
844
|
/**
|
|
@@ -883,7 +894,8 @@ export interface AnalysisTemplateSummary {
|
|
|
883
894
|
collaborationArn: string | undefined;
|
|
884
895
|
/**
|
|
885
896
|
* @public
|
|
886
|
-
* <p>A unique identifier for the collaboration that the analysis template summary belongs to.
|
|
897
|
+
* <p>A unique identifier for the collaboration that the analysis template summary belongs to.
|
|
898
|
+
* Currently accepts collaboration ID.</p>
|
|
887
899
|
*/
|
|
888
900
|
collaborationId: string | undefined;
|
|
889
901
|
/**
|
|
@@ -898,7 +910,8 @@ export interface AnalysisTemplateSummary {
|
|
|
898
910
|
export interface ListAnalysisTemplatesOutput {
|
|
899
911
|
/**
|
|
900
912
|
* @public
|
|
901
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
913
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
914
|
+
* results.</p>
|
|
902
915
|
*/
|
|
903
916
|
nextToken?: string;
|
|
904
917
|
/**
|
|
@@ -943,12 +956,14 @@ export interface UpdateAnalysisTemplateOutput {
|
|
|
943
956
|
export interface BatchGetCollaborationAnalysisTemplateInput {
|
|
944
957
|
/**
|
|
945
958
|
* @public
|
|
946
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
959
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
960
|
+
* Currently accepts collaboration ID.</p>
|
|
947
961
|
*/
|
|
948
962
|
collaborationIdentifier: string | undefined;
|
|
949
963
|
/**
|
|
950
964
|
* @public
|
|
951
|
-
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
965
|
+
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
966
|
+
* collaboration.</p>
|
|
952
967
|
*/
|
|
953
968
|
analysisTemplateArns: string[] | undefined;
|
|
954
969
|
}
|
|
@@ -969,7 +984,8 @@ export interface CollaborationAnalysisTemplate {
|
|
|
969
984
|
arn: string | undefined;
|
|
970
985
|
/**
|
|
971
986
|
* @public
|
|
972
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
987
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
988
|
+
* Currently accepts collaboration ID.</p>
|
|
973
989
|
*/
|
|
974
990
|
collaborationId: string | undefined;
|
|
975
991
|
/**
|
|
@@ -984,7 +1000,8 @@ export interface CollaborationAnalysisTemplate {
|
|
|
984
1000
|
description?: string;
|
|
985
1001
|
/**
|
|
986
1002
|
* @public
|
|
987
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1003
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1004
|
+
* Amazon Web Services account ID.</p>
|
|
988
1005
|
*/
|
|
989
1006
|
creatorAccountId: string | undefined;
|
|
990
1007
|
/**
|
|
@@ -1025,7 +1042,8 @@ export interface CollaborationAnalysisTemplate {
|
|
|
1025
1042
|
}
|
|
1026
1043
|
/**
|
|
1027
1044
|
* @public
|
|
1028
|
-
* <p>Details of errors thrown by the call to retrieve multiple analysis templates within a
|
|
1045
|
+
* <p>Details of errors thrown by the call to retrieve multiple analysis templates within a
|
|
1046
|
+
* collaboration by their identifiers.</p>
|
|
1029
1047
|
*/
|
|
1030
1048
|
export interface BatchGetCollaborationAnalysisTemplateError {
|
|
1031
1049
|
/**
|
|
@@ -1055,7 +1073,9 @@ export interface BatchGetCollaborationAnalysisTemplateOutput {
|
|
|
1055
1073
|
collaborationAnalysisTemplates: CollaborationAnalysisTemplate[] | undefined;
|
|
1056
1074
|
/**
|
|
1057
1075
|
* @public
|
|
1058
|
-
* <p>Error reasons for collaboration analysis templates that could not be retrieved. One
|
|
1076
|
+
* <p>Error reasons for collaboration analysis templates that could not be retrieved. One
|
|
1077
|
+
* error is returned for every collaboration analysis template that could not be
|
|
1078
|
+
* retrieved.</p>
|
|
1059
1079
|
*/
|
|
1060
1080
|
errors: BatchGetCollaborationAnalysisTemplateError[] | undefined;
|
|
1061
1081
|
}
|
|
@@ -1098,7 +1118,8 @@ export interface BatchGetSchemaError {
|
|
|
1098
1118
|
}
|
|
1099
1119
|
/**
|
|
1100
1120
|
* @public
|
|
1101
|
-
* <p>A column within a schema relation, derived from the underlying Glue
|
|
1121
|
+
* <p>A column within a schema relation, derived from the underlying Glue
|
|
1122
|
+
* table.</p>
|
|
1102
1123
|
*/
|
|
1103
1124
|
export interface Column {
|
|
1104
1125
|
/**
|
|
@@ -1140,7 +1161,8 @@ export interface Schema {
|
|
|
1140
1161
|
partitionKeys: Column[] | undefined;
|
|
1141
1162
|
/**
|
|
1142
1163
|
* @public
|
|
1143
|
-
* <p>The analysis rule types associated with the schema. Currently, only one entry is
|
|
1164
|
+
* <p>The analysis rule types associated with the schema. Currently, only one entry is
|
|
1165
|
+
* present.</p>
|
|
1144
1166
|
*/
|
|
1145
1167
|
analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
|
|
1146
1168
|
/**
|
|
@@ -1156,7 +1178,8 @@ export interface Schema {
|
|
|
1156
1178
|
creatorAccountId: string | undefined;
|
|
1157
1179
|
/**
|
|
1158
1180
|
* @public
|
|
1159
|
-
* <p>A name for the schema. The schema relation is referred to by this name when queried by a
|
|
1181
|
+
* <p>A name for the schema. The schema relation is referred to by this name when queried by a
|
|
1182
|
+
* protected query.</p>
|
|
1160
1183
|
*/
|
|
1161
1184
|
name: string | undefined;
|
|
1162
1185
|
/**
|
|
@@ -1225,22 +1248,27 @@ export type MemberAbility = (typeof MemberAbility)[keyof typeof MemberAbility];
|
|
|
1225
1248
|
export interface DataEncryptionMetadata {
|
|
1226
1249
|
/**
|
|
1227
1250
|
* @public
|
|
1228
|
-
* <p>Indicates whether encrypted tables can contain cleartext data (true) or are to
|
|
1251
|
+
* <p>Indicates whether encrypted tables can contain cleartext data (true) or are to
|
|
1252
|
+
* cryptographically process every column (false).</p>
|
|
1229
1253
|
*/
|
|
1230
1254
|
allowCleartext: boolean | undefined;
|
|
1231
1255
|
/**
|
|
1232
1256
|
* @public
|
|
1233
|
-
* <p>Indicates whether Fingerprint columns can contain duplicate entries (true) or are to
|
|
1257
|
+
* <p>Indicates whether Fingerprint columns can contain duplicate entries (true) or are to
|
|
1258
|
+
* contain only non-repeated values (false).</p>
|
|
1234
1259
|
*/
|
|
1235
1260
|
allowDuplicates: boolean | undefined;
|
|
1236
1261
|
/**
|
|
1237
1262
|
* @public
|
|
1238
|
-
* <p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with
|
|
1263
|
+
* <p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with
|
|
1264
|
+
* a different name (true) or can only be joined on Fingerprint columns of the same name
|
|
1265
|
+
* (false).</p>
|
|
1239
1266
|
*/
|
|
1240
1267
|
allowJoinsOnColumnsWithDifferentNames: boolean | undefined;
|
|
1241
1268
|
/**
|
|
1242
1269
|
* @public
|
|
1243
|
-
* <p>Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or
|
|
1270
|
+
* <p>Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or
|
|
1271
|
+
* cryptographically processed (false).</p>
|
|
1244
1272
|
*/
|
|
1245
1273
|
preserveNulls: boolean | undefined;
|
|
1246
1274
|
}
|
|
@@ -1251,7 +1279,8 @@ export interface DataEncryptionMetadata {
|
|
|
1251
1279
|
export interface MemberSpecification {
|
|
1252
1280
|
/**
|
|
1253
1281
|
* @public
|
|
1254
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1282
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1283
|
+
* Amazon Web Services account ID.</p>
|
|
1255
1284
|
*/
|
|
1256
1285
|
accountId: string | undefined;
|
|
1257
1286
|
/**
|
|
@@ -1308,7 +1337,8 @@ export interface CreateCollaborationInput {
|
|
|
1308
1337
|
creatorDisplayName: string | undefined;
|
|
1309
1338
|
/**
|
|
1310
1339
|
* @public
|
|
1311
|
-
* <p>The settings for client-side encryption with Cryptographic Computing for Clean
|
|
1340
|
+
* <p>The settings for client-side encryption with Cryptographic Computing for Clean
|
|
1341
|
+
* Rooms.</p>
|
|
1312
1342
|
*/
|
|
1313
1343
|
dataEncryptionMetadata?: DataEncryptionMetadata;
|
|
1314
1344
|
/**
|
|
@@ -1321,8 +1351,8 @@ export interface CreateCollaborationInput {
|
|
|
1321
1351
|
* @public
|
|
1322
1352
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
1323
1353
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
1324
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
1325
|
-
* resource.</p>
|
|
1354
|
+
* you can also use tag-based access control in IAM policies to control access
|
|
1355
|
+
* to this resource.</p>
|
|
1326
1356
|
*/
|
|
1327
1357
|
tags?: Record<string, string>;
|
|
1328
1358
|
}
|
|
@@ -1342,7 +1372,8 @@ export declare const MemberStatus: {
|
|
|
1342
1372
|
export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
|
|
1343
1373
|
/**
|
|
1344
1374
|
* @public
|
|
1345
|
-
* <p>The multi-party data share environment. The collaboration contains metadata about its
|
|
1375
|
+
* <p>The multi-party data share environment. The collaboration contains metadata about its
|
|
1376
|
+
* purpose and participants.</p>
|
|
1346
1377
|
*/
|
|
1347
1378
|
export interface Collaboration {
|
|
1348
1379
|
/**
|
|
@@ -1357,7 +1388,8 @@ export interface Collaboration {
|
|
|
1357
1388
|
arn: string | undefined;
|
|
1358
1389
|
/**
|
|
1359
1390
|
* @public
|
|
1360
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1391
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1392
|
+
* unique.</p>
|
|
1361
1393
|
*/
|
|
1362
1394
|
name: string | undefined;
|
|
1363
1395
|
/**
|
|
@@ -1367,7 +1399,8 @@ export interface Collaboration {
|
|
|
1367
1399
|
description?: string;
|
|
1368
1400
|
/**
|
|
1369
1401
|
* @public
|
|
1370
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1402
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1403
|
+
* Amazon Web Services account ID.</p>
|
|
1371
1404
|
*/
|
|
1372
1405
|
creatorAccountId: string | undefined;
|
|
1373
1406
|
/**
|
|
@@ -1483,12 +1516,14 @@ export interface GetCollaborationOutput {
|
|
|
1483
1516
|
export interface GetCollaborationAnalysisTemplateInput {
|
|
1484
1517
|
/**
|
|
1485
1518
|
* @public
|
|
1486
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1519
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1520
|
+
* Currently accepts collaboration ID.</p>
|
|
1487
1521
|
*/
|
|
1488
1522
|
collaborationIdentifier: string | undefined;
|
|
1489
1523
|
/**
|
|
1490
1524
|
* @public
|
|
1491
|
-
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
1525
|
+
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
1526
|
+
* collaboration.</p>
|
|
1492
1527
|
*/
|
|
1493
1528
|
analysisTemplateArn: string | undefined;
|
|
1494
1529
|
}
|
|
@@ -1545,7 +1580,8 @@ export interface GetSchemaAnalysisRuleInput {
|
|
|
1545
1580
|
name: string | undefined;
|
|
1546
1581
|
/**
|
|
1547
1582
|
* @public
|
|
1548
|
-
* <p>The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely
|
|
1583
|
+
* <p>The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely
|
|
1584
|
+
* identified by a combination of the collaboration, the schema name, and their type.</p>
|
|
1549
1585
|
*/
|
|
1550
1586
|
type: AnalysisRuleType | string | undefined;
|
|
1551
1587
|
}
|
|
@@ -1565,12 +1601,14 @@ export interface GetSchemaAnalysisRuleOutput {
|
|
|
1565
1601
|
export interface ListCollaborationAnalysisTemplatesInput {
|
|
1566
1602
|
/**
|
|
1567
1603
|
* @public
|
|
1568
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1604
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1605
|
+
* Currently accepts collaboration ID.</p>
|
|
1569
1606
|
*/
|
|
1570
1607
|
collaborationIdentifier: string | undefined;
|
|
1571
1608
|
/**
|
|
1572
1609
|
* @public
|
|
1573
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1610
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1611
|
+
* results.</p>
|
|
1574
1612
|
*/
|
|
1575
1613
|
nextToken?: string;
|
|
1576
1614
|
/**
|
|
@@ -1591,7 +1629,8 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
1591
1629
|
arn: string | undefined;
|
|
1592
1630
|
/**
|
|
1593
1631
|
* @public
|
|
1594
|
-
* <p>The time that the summary of the analysis template in a collaboration was
|
|
1632
|
+
* <p>The time that the summary of the analysis template in a collaboration was
|
|
1633
|
+
* created.</p>
|
|
1595
1634
|
*/
|
|
1596
1635
|
createTime: Date | undefined;
|
|
1597
1636
|
/**
|
|
@@ -1606,7 +1645,8 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
1606
1645
|
name: string | undefined;
|
|
1607
1646
|
/**
|
|
1608
1647
|
* @public
|
|
1609
|
-
* <p>The time that the summary of the analysis template in the collaboration was last
|
|
1648
|
+
* <p>The time that the summary of the analysis template in the collaboration was last
|
|
1649
|
+
* updated.</p>
|
|
1610
1650
|
*/
|
|
1611
1651
|
updateTime: Date | undefined;
|
|
1612
1652
|
/**
|
|
@@ -1616,12 +1656,14 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
1616
1656
|
collaborationArn: string | undefined;
|
|
1617
1657
|
/**
|
|
1618
1658
|
* @public
|
|
1619
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1659
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1660
|
+
* Currently accepts collaboration ID.</p>
|
|
1620
1661
|
*/
|
|
1621
1662
|
collaborationId: string | undefined;
|
|
1622
1663
|
/**
|
|
1623
1664
|
* @public
|
|
1624
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1665
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1666
|
+
* Amazon Web Services account ID.</p>
|
|
1625
1667
|
*/
|
|
1626
1668
|
creatorAccountId: string | undefined;
|
|
1627
1669
|
/**
|
|
@@ -1636,7 +1678,8 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
1636
1678
|
export interface ListCollaborationAnalysisTemplatesOutput {
|
|
1637
1679
|
/**
|
|
1638
1680
|
* @public
|
|
1639
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1681
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1682
|
+
* results.</p>
|
|
1640
1683
|
*/
|
|
1641
1684
|
nextToken?: string;
|
|
1642
1685
|
/**
|
|
@@ -1663,7 +1706,8 @@ export type FilterableMemberStatus = (typeof FilterableMemberStatus)[keyof typeo
|
|
|
1663
1706
|
export interface ListCollaborationsInput {
|
|
1664
1707
|
/**
|
|
1665
1708
|
* @public
|
|
1666
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1709
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1710
|
+
* results.</p>
|
|
1667
1711
|
*/
|
|
1668
1712
|
nextToken?: string;
|
|
1669
1713
|
/**
|
|
@@ -1696,12 +1740,14 @@ export interface CollaborationSummary {
|
|
|
1696
1740
|
arn: string | undefined;
|
|
1697
1741
|
/**
|
|
1698
1742
|
* @public
|
|
1699
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1743
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1744
|
+
* unique.</p>
|
|
1700
1745
|
*/
|
|
1701
1746
|
name: string | undefined;
|
|
1702
1747
|
/**
|
|
1703
1748
|
* @public
|
|
1704
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1749
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1750
|
+
* Amazon Web Services account ID.</p>
|
|
1705
1751
|
*/
|
|
1706
1752
|
creatorAccountId: string | undefined;
|
|
1707
1753
|
/**
|
|
@@ -1741,7 +1787,8 @@ export interface CollaborationSummary {
|
|
|
1741
1787
|
export interface ListCollaborationsOutput {
|
|
1742
1788
|
/**
|
|
1743
1789
|
* @public
|
|
1744
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1790
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1791
|
+
* results.</p>
|
|
1745
1792
|
*/
|
|
1746
1793
|
nextToken?: string;
|
|
1747
1794
|
/**
|
|
@@ -1761,7 +1808,8 @@ export interface ListMembersInput {
|
|
|
1761
1808
|
collaborationIdentifier: string | undefined;
|
|
1762
1809
|
/**
|
|
1763
1810
|
* @public
|
|
1764
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1811
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1812
|
+
* results.</p>
|
|
1765
1813
|
*/
|
|
1766
1814
|
nextToken?: string;
|
|
1767
1815
|
/**
|
|
@@ -1777,12 +1825,14 @@ export interface ListMembersInput {
|
|
|
1777
1825
|
export interface MemberSummary {
|
|
1778
1826
|
/**
|
|
1779
1827
|
* @public
|
|
1780
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1828
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1829
|
+
* Amazon Web Services account ID.</p>
|
|
1781
1830
|
*/
|
|
1782
1831
|
accountId: string | undefined;
|
|
1783
1832
|
/**
|
|
1784
1833
|
* @public
|
|
1785
|
-
* <p>The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and
|
|
1834
|
+
* <p>The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and
|
|
1835
|
+
* `REMOVED`.</p>
|
|
1786
1836
|
*/
|
|
1787
1837
|
status: MemberStatus | string | undefined;
|
|
1788
1838
|
/**
|
|
@@ -1822,7 +1872,8 @@ export interface MemberSummary {
|
|
|
1822
1872
|
export interface ListMembersOutput {
|
|
1823
1873
|
/**
|
|
1824
1874
|
* @public
|
|
1825
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1875
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1876
|
+
* results.</p>
|
|
1826
1877
|
*/
|
|
1827
1878
|
nextToken?: string;
|
|
1828
1879
|
/**
|
|
@@ -1843,12 +1894,14 @@ export interface ListSchemasInput {
|
|
|
1843
1894
|
collaborationIdentifier: string | undefined;
|
|
1844
1895
|
/**
|
|
1845
1896
|
* @public
|
|
1846
|
-
* <p>If present, filter schemas by schema type. The only valid schema type is currently
|
|
1897
|
+
* <p>If present, filter schemas by schema type. The only valid schema type is currently
|
|
1898
|
+
* `TABLE`.</p>
|
|
1847
1899
|
*/
|
|
1848
1900
|
schemaType?: SchemaType | string;
|
|
1849
1901
|
/**
|
|
1850
1902
|
* @public
|
|
1851
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1903
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1904
|
+
* results.</p>
|
|
1852
1905
|
*/
|
|
1853
1906
|
nextToken?: string;
|
|
1854
1907
|
/**
|
|
@@ -1904,7 +1957,8 @@ export interface SchemaSummary {
|
|
|
1904
1957
|
analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
|
|
1905
1958
|
/**
|
|
1906
1959
|
* @public
|
|
1907
|
-
* <p>The analysis method for the associated schema. The only valid value is currently
|
|
1960
|
+
* <p>The analysis method for the associated schema. The only valid value is currently
|
|
1961
|
+
* `DIRECT_QUERY`.</p>
|
|
1908
1962
|
*/
|
|
1909
1963
|
analysisMethod?: AnalysisMethod | string;
|
|
1910
1964
|
}
|
|
@@ -1919,7 +1973,8 @@ export interface ListSchemasOutput {
|
|
|
1919
1973
|
schemaSummaries: SchemaSummary[] | undefined;
|
|
1920
1974
|
/**
|
|
1921
1975
|
* @public
|
|
1922
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
1976
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
1977
|
+
* results.</p>
|
|
1923
1978
|
*/
|
|
1924
1979
|
nextToken?: string;
|
|
1925
1980
|
}
|
|
@@ -1934,7 +1989,8 @@ export interface UpdateCollaborationInput {
|
|
|
1934
1989
|
collaborationIdentifier: string | undefined;
|
|
1935
1990
|
/**
|
|
1936
1991
|
* @public
|
|
1937
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1992
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
1993
|
+
* unique.</p>
|
|
1938
1994
|
*/
|
|
1939
1995
|
name?: string;
|
|
1940
1996
|
/**
|
|
@@ -1990,8 +2046,8 @@ export interface CreateConfiguredTableAssociationInput {
|
|
|
1990
2046
|
* @public
|
|
1991
2047
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
1992
2048
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
1993
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
1994
|
-
* resource.</p>
|
|
2049
|
+
* you can also use tag-based access control in IAM policies to control access
|
|
2050
|
+
* to this resource.</p>
|
|
1995
2051
|
*/
|
|
1996
2052
|
tags?: Record<string, string>;
|
|
1997
2053
|
}
|
|
@@ -2037,7 +2093,8 @@ export interface ConfiguredTableAssociation {
|
|
|
2037
2093
|
roleArn: string | undefined;
|
|
2038
2094
|
/**
|
|
2039
2095
|
* @public
|
|
2040
|
-
* <p>The name of the configured table association, in lowercase. The table is identified by
|
|
2096
|
+
* <p>The name of the configured table association, in lowercase. The table is identified by
|
|
2097
|
+
* this name when running protected queries against the underlying data.</p>
|
|
2041
2098
|
*/
|
|
2042
2099
|
name: string | undefined;
|
|
2043
2100
|
/**
|
|
@@ -2072,7 +2129,8 @@ export interface CreateConfiguredTableAssociationOutput {
|
|
|
2072
2129
|
export interface DeleteConfiguredTableAssociationInput {
|
|
2073
2130
|
/**
|
|
2074
2131
|
* @public
|
|
2075
|
-
* <p>The unique ID for the configured table association to be deleted. Currently accepts the
|
|
2132
|
+
* <p>The unique ID for the configured table association to be deleted. Currently accepts the
|
|
2133
|
+
* configured table ID.</p>
|
|
2076
2134
|
*/
|
|
2077
2135
|
configuredTableAssociationIdentifier: string | undefined;
|
|
2078
2136
|
/**
|
|
@@ -2093,7 +2151,8 @@ export interface DeleteConfiguredTableAssociationOutput {
|
|
|
2093
2151
|
export interface GetConfiguredTableAssociationInput {
|
|
2094
2152
|
/**
|
|
2095
2153
|
* @public
|
|
2096
|
-
* <p>The unique ID for the configured table association to retrieve. Currently accepts the
|
|
2154
|
+
* <p>The unique ID for the configured table association to retrieve. Currently accepts the
|
|
2155
|
+
* configured table ID.</p>
|
|
2097
2156
|
*/
|
|
2098
2157
|
configuredTableAssociationIdentifier: string | undefined;
|
|
2099
2158
|
/**
|
|
@@ -2119,12 +2178,14 @@ export interface GetConfiguredTableAssociationOutput {
|
|
|
2119
2178
|
export interface ListConfiguredTableAssociationsInput {
|
|
2120
2179
|
/**
|
|
2121
2180
|
* @public
|
|
2122
|
-
* <p>A unique identifier for the membership to list configured table associations for.
|
|
2181
|
+
* <p>A unique identifier for the membership to list configured table associations for.
|
|
2182
|
+
* Currently accepts the membership ID.</p>
|
|
2123
2183
|
*/
|
|
2124
2184
|
membershipIdentifier: string | undefined;
|
|
2125
2185
|
/**
|
|
2126
2186
|
* @public
|
|
2127
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
2187
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
2188
|
+
* results.</p>
|
|
2128
2189
|
*/
|
|
2129
2190
|
nextToken?: string;
|
|
2130
2191
|
/**
|
|
@@ -2157,7 +2218,8 @@ export interface ConfiguredTableAssociationSummary {
|
|
|
2157
2218
|
membershipArn: string | undefined;
|
|
2158
2219
|
/**
|
|
2159
2220
|
* @public
|
|
2160
|
-
* <p>The name of the configured table association. The table is identified by this name when
|
|
2221
|
+
* <p>The name of the configured table association. The table is identified by this name when
|
|
2222
|
+
* running Protected Queries against the underlying data.</p>
|
|
2161
2223
|
*/
|
|
2162
2224
|
name: string | undefined;
|
|
2163
2225
|
/**
|
|
@@ -2192,7 +2254,8 @@ export interface ListConfiguredTableAssociationsOutput {
|
|
|
2192
2254
|
configuredTableAssociationSummaries: ConfiguredTableAssociationSummary[] | undefined;
|
|
2193
2255
|
/**
|
|
2194
2256
|
* @public
|
|
2195
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
2257
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
2258
|
+
* results.</p>
|
|
2196
2259
|
*/
|
|
2197
2260
|
nextToken?: string;
|
|
2198
2261
|
}
|
|
@@ -2202,7 +2265,8 @@ export interface ListConfiguredTableAssociationsOutput {
|
|
|
2202
2265
|
export interface UpdateConfiguredTableAssociationInput {
|
|
2203
2266
|
/**
|
|
2204
2267
|
* @public
|
|
2205
|
-
* <p>The unique identifier for the configured table association to update. Currently accepts
|
|
2268
|
+
* <p>The unique identifier for the configured table association to update. Currently accepts
|
|
2269
|
+
* the configured table association ID.</p>
|
|
2206
2270
|
*/
|
|
2207
2271
|
configuredTableAssociationIdentifier: string | undefined;
|
|
2208
2272
|
/**
|
|
@@ -2250,7 +2314,8 @@ export interface GlueTableReference {
|
|
|
2250
2314
|
}
|
|
2251
2315
|
/**
|
|
2252
2316
|
* @public
|
|
2253
|
-
* <p>A pointer to the dataset that underlies this table. Currently, this can only be an Glue
|
|
2317
|
+
* <p>A pointer to the dataset that underlies this table. Currently, this can only be an Glue
|
|
2318
|
+
* table.</p>
|
|
2254
2319
|
*/
|
|
2255
2320
|
export type TableReference = TableReference.GlueMember | TableReference.$UnknownMember;
|
|
2256
2321
|
/**
|
|
@@ -2300,20 +2365,22 @@ export interface CreateConfiguredTableInput {
|
|
|
2300
2365
|
tableReference: TableReference | undefined;
|
|
2301
2366
|
/**
|
|
2302
2367
|
* @public
|
|
2303
|
-
* <p>The columns of the underlying table that can be used by collaborations or analysis
|
|
2368
|
+
* <p>The columns of the underlying table that can be used by collaborations or analysis
|
|
2369
|
+
* rules.</p>
|
|
2304
2370
|
*/
|
|
2305
2371
|
allowedColumns: string[] | undefined;
|
|
2306
2372
|
/**
|
|
2307
2373
|
* @public
|
|
2308
|
-
* <p>The analysis method for the configured tables. The only valid value is currently
|
|
2374
|
+
* <p>The analysis method for the configured tables. The only valid value is currently
|
|
2375
|
+
* `DIRECT_QUERY`.</p>
|
|
2309
2376
|
*/
|
|
2310
2377
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
2311
2378
|
/**
|
|
2312
2379
|
* @public
|
|
2313
2380
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
2314
2381
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
2315
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
2316
|
-
* resource.</p>
|
|
2382
|
+
* you can also use tag-based access control in IAM policies to control access
|
|
2383
|
+
* to this resource.</p>
|
|
2317
2384
|
*/
|
|
2318
2385
|
tags?: Record<string, string>;
|
|
2319
2386
|
}
|
|
@@ -2372,12 +2439,14 @@ export interface ConfiguredTable {
|
|
|
2372
2439
|
updateTime: Date | undefined;
|
|
2373
2440
|
/**
|
|
2374
2441
|
* @public
|
|
2375
|
-
* <p>The types of analysis rules associated with this configured table. Currently, only one
|
|
2442
|
+
* <p>The types of analysis rules associated with this configured table. Currently, only one
|
|
2443
|
+
* analysis rule may be associated with a configured table.</p>
|
|
2376
2444
|
*/
|
|
2377
2445
|
analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined;
|
|
2378
2446
|
/**
|
|
2379
2447
|
* @public
|
|
2380
|
-
* <p>The analysis method for the configured table. The only valid value is currently
|
|
2448
|
+
* <p>The analysis method for the configured table. The only valid value is currently
|
|
2449
|
+
* `DIRECT_QUERY`.</p>
|
|
2381
2450
|
*/
|
|
2382
2451
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
2383
2452
|
/**
|
|
@@ -2428,7 +2497,8 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
|
2428
2497
|
}
|
|
2429
2498
|
/**
|
|
2430
2499
|
* @public
|
|
2431
|
-
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
2500
|
+
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
2501
|
+
* their configured tables.</p>
|
|
2432
2502
|
*/
|
|
2433
2503
|
interface CustomMember {
|
|
2434
2504
|
list?: never;
|
|
@@ -2489,7 +2559,8 @@ export declare namespace ConfiguredTableAnalysisRulePolicy {
|
|
|
2489
2559
|
export interface CreateConfiguredTableAnalysisRuleInput {
|
|
2490
2560
|
/**
|
|
2491
2561
|
* @public
|
|
2492
|
-
* <p>The identifier for the configured table to create the analysis rule for. Currently
|
|
2562
|
+
* <p>The identifier for the configured table to create the analysis rule for. Currently
|
|
2563
|
+
* accepts the configured table ID. </p>
|
|
2493
2564
|
*/
|
|
2494
2565
|
configuredTableIdentifier: string | undefined;
|
|
2495
2566
|
/**
|
|
@@ -2505,7 +2576,8 @@ export interface CreateConfiguredTableAnalysisRuleInput {
|
|
|
2505
2576
|
}
|
|
2506
2577
|
/**
|
|
2507
2578
|
* @public
|
|
2508
|
-
* <p>A configured table analysis rule, which limits how data for this table can be
|
|
2579
|
+
* <p>A configured table analysis rule, which limits how data for this table can be
|
|
2580
|
+
* used.</p>
|
|
2509
2581
|
*/
|
|
2510
2582
|
export interface ConfiguredTableAnalysisRule {
|
|
2511
2583
|
/**
|
|
@@ -2577,7 +2649,8 @@ export interface DeleteConfiguredTableAnalysisRuleInput {
|
|
|
2577
2649
|
configuredTableIdentifier: string | undefined;
|
|
2578
2650
|
/**
|
|
2579
2651
|
* @public
|
|
2580
|
-
* <p>The analysis rule type to be deleted. Configured table analysis rules are uniquely
|
|
2652
|
+
* <p>The analysis rule type to be deleted. Configured table analysis rules are uniquely
|
|
2653
|
+
* identified by their configured table identifier and analysis rule type.</p>
|
|
2581
2654
|
*/
|
|
2582
2655
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2583
2656
|
}
|
|
@@ -2613,12 +2686,14 @@ export interface GetConfiguredTableOutput {
|
|
|
2613
2686
|
export interface GetConfiguredTableAnalysisRuleInput {
|
|
2614
2687
|
/**
|
|
2615
2688
|
* @public
|
|
2616
|
-
* <p>The unique identifier for the configured table to retrieve. Currently accepts the
|
|
2689
|
+
* <p>The unique identifier for the configured table to retrieve. Currently accepts the
|
|
2690
|
+
* configured table ID.</p>
|
|
2617
2691
|
*/
|
|
2618
2692
|
configuredTableIdentifier: string | undefined;
|
|
2619
2693
|
/**
|
|
2620
2694
|
* @public
|
|
2621
|
-
* <p>The analysis rule to be retrieved. Configured table analysis rules are uniquely
|
|
2695
|
+
* <p>The analysis rule to be retrieved. Configured table analysis rules are uniquely
|
|
2696
|
+
* identified by their configured table identifier and analysis rule type.</p>
|
|
2622
2697
|
*/
|
|
2623
2698
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2624
2699
|
}
|
|
@@ -2638,7 +2713,8 @@ export interface GetConfiguredTableAnalysisRuleOutput {
|
|
|
2638
2713
|
export interface ListConfiguredTablesInput {
|
|
2639
2714
|
/**
|
|
2640
2715
|
* @public
|
|
2641
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
2716
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
2717
|
+
* results.</p>
|
|
2642
2718
|
*/
|
|
2643
2719
|
nextToken?: string;
|
|
2644
2720
|
/**
|
|
@@ -2684,7 +2760,8 @@ export interface ConfiguredTableSummary {
|
|
|
2684
2760
|
analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined;
|
|
2685
2761
|
/**
|
|
2686
2762
|
* @public
|
|
2687
|
-
* <p>The analysis method for the configured tables. The only valid value is currently
|
|
2763
|
+
* <p>The analysis method for the configured tables. The only valid value is currently
|
|
2764
|
+
* `DIRECT_QUERY`.</p>
|
|
2688
2765
|
*/
|
|
2689
2766
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
2690
2767
|
}
|
|
@@ -2699,7 +2776,8 @@ export interface ListConfiguredTablesOutput {
|
|
|
2699
2776
|
configuredTableSummaries: ConfiguredTableSummary[] | undefined;
|
|
2700
2777
|
/**
|
|
2701
2778
|
* @public
|
|
2702
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
2779
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
2780
|
+
* results.</p>
|
|
2703
2781
|
*/
|
|
2704
2782
|
nextToken?: string;
|
|
2705
2783
|
}
|
|
@@ -2709,7 +2787,8 @@ export interface ListConfiguredTablesOutput {
|
|
|
2709
2787
|
export interface UpdateConfiguredTableInput {
|
|
2710
2788
|
/**
|
|
2711
2789
|
* @public
|
|
2712
|
-
* <p>The identifier for the configured table to update. Currently accepts the configured
|
|
2790
|
+
* <p>The identifier for the configured table to update. Currently accepts the configured
|
|
2791
|
+
* table ID.</p>
|
|
2713
2792
|
*/
|
|
2714
2793
|
configuredTableIdentifier: string | undefined;
|
|
2715
2794
|
/**
|
|
@@ -2745,7 +2824,8 @@ export interface UpdateConfiguredTableAnalysisRuleInput {
|
|
|
2745
2824
|
configuredTableIdentifier: string | undefined;
|
|
2746
2825
|
/**
|
|
2747
2826
|
* @public
|
|
2748
|
-
* <p>The analysis rule type to be updated. Configured table analysis rules are uniquely
|
|
2827
|
+
* <p>The analysis rule type to be updated. Configured table analysis rules are uniquely
|
|
2828
|
+
* identified by their configured table identifier and analysis rule type.</p>
|
|
2749
2829
|
*/
|
|
2750
2830
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2751
2831
|
/**
|
|
@@ -2770,7 +2850,8 @@ export interface UpdateConfiguredTableAnalysisRuleOutput {
|
|
|
2770
2850
|
export interface ListTagsForResourceInput {
|
|
2771
2851
|
/**
|
|
2772
2852
|
* @public
|
|
2773
|
-
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags
|
|
2853
|
+
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags
|
|
2854
|
+
* on.</p>
|
|
2774
2855
|
*/
|
|
2775
2856
|
resourceArn: string | undefined;
|
|
2776
2857
|
}
|
|
@@ -2784,6 +2865,90 @@ export interface ListTagsForResourceOutput {
|
|
|
2784
2865
|
*/
|
|
2785
2866
|
tags: Record<string, string> | undefined;
|
|
2786
2867
|
}
|
|
2868
|
+
/**
|
|
2869
|
+
* @public
|
|
2870
|
+
* @enum
|
|
2871
|
+
*/
|
|
2872
|
+
export declare const ResultFormat: {
|
|
2873
|
+
readonly CSV: "CSV";
|
|
2874
|
+
readonly PARQUET: "PARQUET";
|
|
2875
|
+
};
|
|
2876
|
+
/**
|
|
2877
|
+
* @public
|
|
2878
|
+
*/
|
|
2879
|
+
export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat];
|
|
2880
|
+
/**
|
|
2881
|
+
* @public
|
|
2882
|
+
* <p>Contains the configuration to write the query results to S3.</p>
|
|
2883
|
+
*/
|
|
2884
|
+
export interface ProtectedQueryS3OutputConfiguration {
|
|
2885
|
+
/**
|
|
2886
|
+
* @public
|
|
2887
|
+
* <p>Intended file format of the result.</p>
|
|
2888
|
+
*/
|
|
2889
|
+
resultFormat: ResultFormat | string | undefined;
|
|
2890
|
+
/**
|
|
2891
|
+
* @public
|
|
2892
|
+
* <p>The S3 bucket to unload the protected query results.</p>
|
|
2893
|
+
*/
|
|
2894
|
+
bucket: string | undefined;
|
|
2895
|
+
/**
|
|
2896
|
+
* @public
|
|
2897
|
+
* <p>The S3 prefix to unload the protected query results.</p>
|
|
2898
|
+
*/
|
|
2899
|
+
keyPrefix?: string;
|
|
2900
|
+
}
|
|
2901
|
+
/**
|
|
2902
|
+
* @public
|
|
2903
|
+
* <p>Contains
|
|
2904
|
+
* configurations for protected query results.</p>
|
|
2905
|
+
*/
|
|
2906
|
+
export type MembershipProtectedQueryOutputConfiguration = MembershipProtectedQueryOutputConfiguration.S3Member | MembershipProtectedQueryOutputConfiguration.$UnknownMember;
|
|
2907
|
+
/**
|
|
2908
|
+
* @public
|
|
2909
|
+
*/
|
|
2910
|
+
export declare namespace MembershipProtectedQueryOutputConfiguration {
|
|
2911
|
+
/**
|
|
2912
|
+
* @public
|
|
2913
|
+
* <p>Contains the configuration to write the query results to S3.</p>
|
|
2914
|
+
*/
|
|
2915
|
+
interface S3Member {
|
|
2916
|
+
s3: ProtectedQueryS3OutputConfiguration;
|
|
2917
|
+
$unknown?: never;
|
|
2918
|
+
}
|
|
2919
|
+
/**
|
|
2920
|
+
* @public
|
|
2921
|
+
*/
|
|
2922
|
+
interface $UnknownMember {
|
|
2923
|
+
s3?: never;
|
|
2924
|
+
$unknown: [string, any];
|
|
2925
|
+
}
|
|
2926
|
+
interface Visitor<T> {
|
|
2927
|
+
s3: (value: ProtectedQueryS3OutputConfiguration) => T;
|
|
2928
|
+
_: (name: string, value: any) => T;
|
|
2929
|
+
}
|
|
2930
|
+
const visit: <T>(value: MembershipProtectedQueryOutputConfiguration, visitor: Visitor<T>) => T;
|
|
2931
|
+
}
|
|
2932
|
+
/**
|
|
2933
|
+
* @public
|
|
2934
|
+
* <p>Contains
|
|
2935
|
+
* configurations for protected query results.</p>
|
|
2936
|
+
*/
|
|
2937
|
+
export interface MembershipProtectedQueryResultConfiguration {
|
|
2938
|
+
/**
|
|
2939
|
+
* @public
|
|
2940
|
+
* <p>Configuration for
|
|
2941
|
+
* protected query results.</p>
|
|
2942
|
+
*/
|
|
2943
|
+
outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
|
|
2944
|
+
/**
|
|
2945
|
+
* @public
|
|
2946
|
+
* <p>The unique ARN for
|
|
2947
|
+
* an IAM role that is used by Clean Rooms to write protected query results to the
|
|
2948
|
+
* result location, given by the member who can receive results.</p>
|
|
2949
|
+
*/
|
|
2950
|
+
roleArn?: string;
|
|
2951
|
+
}
|
|
2787
2952
|
/**
|
|
2788
2953
|
* @public
|
|
2789
2954
|
* @enum
|
|
@@ -2815,10 +2980,17 @@ export interface CreateMembershipInput {
|
|
|
2815
2980
|
* @public
|
|
2816
2981
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
2817
2982
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
2818
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
2819
|
-
* resource.</p>
|
|
2983
|
+
* you can also use tag-based access control in IAM policies to control access
|
|
2984
|
+
* to this resource.</p>
|
|
2820
2985
|
*/
|
|
2821
2986
|
tags?: Record<string, string>;
|
|
2987
|
+
/**
|
|
2988
|
+
* @public
|
|
2989
|
+
* <p>The default
|
|
2990
|
+
* protected query result configuration as specified by the member who can receive
|
|
2991
|
+
* results.</p>
|
|
2992
|
+
*/
|
|
2993
|
+
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
|
|
2822
2994
|
}
|
|
2823
2995
|
/**
|
|
2824
2996
|
* @public
|
|
@@ -2860,7 +3032,8 @@ export interface Membership {
|
|
|
2860
3032
|
collaborationId: string | undefined;
|
|
2861
3033
|
/**
|
|
2862
3034
|
* @public
|
|
2863
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
3035
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
3036
|
+
* Amazon Web Services account ID.</p>
|
|
2864
3037
|
*/
|
|
2865
3038
|
collaborationCreatorAccountId: string | undefined;
|
|
2866
3039
|
/**
|
|
@@ -2885,7 +3058,8 @@ export interface Membership {
|
|
|
2885
3058
|
updateTime: Date | undefined;
|
|
2886
3059
|
/**
|
|
2887
3060
|
* @public
|
|
2888
|
-
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and
|
|
3061
|
+
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and
|
|
3062
|
+
* `COLLABORATION_DELETED`.</p>
|
|
2889
3063
|
*/
|
|
2890
3064
|
status: MembershipStatus | string | undefined;
|
|
2891
3065
|
/**
|
|
@@ -2899,6 +3073,13 @@ export interface Membership {
|
|
|
2899
3073
|
* collaboration.</p>
|
|
2900
3074
|
*/
|
|
2901
3075
|
queryLogStatus: MembershipQueryLogStatus | string | undefined;
|
|
3076
|
+
/**
|
|
3077
|
+
* @public
|
|
3078
|
+
* <p>The default
|
|
3079
|
+
* protected query result configuration as specified by the member who can receive
|
|
3080
|
+
* results.</p>
|
|
3081
|
+
*/
|
|
3082
|
+
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
|
|
2902
3083
|
}
|
|
2903
3084
|
/**
|
|
2904
3085
|
* @public
|
|
@@ -2976,6 +3157,20 @@ export interface ProtectedQueryError {
|
|
|
2976
3157
|
*/
|
|
2977
3158
|
code: string | undefined;
|
|
2978
3159
|
}
|
|
3160
|
+
/**
|
|
3161
|
+
* @public
|
|
3162
|
+
* <p>Details about the
|
|
3163
|
+
* member who received the query result.</p>
|
|
3164
|
+
*/
|
|
3165
|
+
export interface ProtectedQuerySingleMemberOutput {
|
|
3166
|
+
/**
|
|
3167
|
+
* @public
|
|
3168
|
+
* <p>The Amazon Web Services account
|
|
3169
|
+
* ID of the member in the collaboration who can receive results for the
|
|
3170
|
+
* query.</p>
|
|
3171
|
+
*/
|
|
3172
|
+
accountId: string | undefined;
|
|
3173
|
+
}
|
|
2979
3174
|
/**
|
|
2980
3175
|
* @public
|
|
2981
3176
|
* <p>Contains output information for protected queries with an S3 output type.</p>
|
|
@@ -2991,7 +3186,7 @@ export interface ProtectedQueryS3Output {
|
|
|
2991
3186
|
* @public
|
|
2992
3187
|
* <p>Contains details about the protected query output.</p>
|
|
2993
3188
|
*/
|
|
2994
|
-
export type ProtectedQueryOutput = ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember;
|
|
3189
|
+
export type ProtectedQueryOutput = ProtectedQueryOutput.MemberListMember | ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember;
|
|
2995
3190
|
/**
|
|
2996
3191
|
* @public
|
|
2997
3192
|
*/
|
|
@@ -3002,6 +3197,17 @@ export declare namespace ProtectedQueryOutput {
|
|
|
3002
3197
|
*/
|
|
3003
3198
|
interface S3Member {
|
|
3004
3199
|
s3: ProtectedQueryS3Output;
|
|
3200
|
+
memberList?: never;
|
|
3201
|
+
$unknown?: never;
|
|
3202
|
+
}
|
|
3203
|
+
/**
|
|
3204
|
+
* @public
|
|
3205
|
+
* <p>The list of member
|
|
3206
|
+
* Amazon Web Services account(s) that received the results of the query. </p>
|
|
3207
|
+
*/
|
|
3208
|
+
interface MemberListMember {
|
|
3209
|
+
s3?: never;
|
|
3210
|
+
memberList: ProtectedQuerySingleMemberOutput[];
|
|
3005
3211
|
$unknown?: never;
|
|
3006
3212
|
}
|
|
3007
3213
|
/**
|
|
@@ -3009,10 +3215,12 @@ export declare namespace ProtectedQueryOutput {
|
|
|
3009
3215
|
*/
|
|
3010
3216
|
interface $UnknownMember {
|
|
3011
3217
|
s3?: never;
|
|
3218
|
+
memberList?: never;
|
|
3012
3219
|
$unknown: [string, any];
|
|
3013
3220
|
}
|
|
3014
3221
|
interface Visitor<T> {
|
|
3015
3222
|
s3: (value: ProtectedQueryS3Output) => T;
|
|
3223
|
+
memberList: (value: ProtectedQuerySingleMemberOutput[]) => T;
|
|
3016
3224
|
_: (name: string, value: any) => T;
|
|
3017
3225
|
}
|
|
3018
3226
|
const visit: <T>(value: ProtectedQueryOutput, visitor: Visitor<T>) => T;
|
|
@@ -3028,39 +3236,6 @@ export interface ProtectedQueryResult {
|
|
|
3028
3236
|
*/
|
|
3029
3237
|
output: ProtectedQueryOutput | undefined;
|
|
3030
3238
|
}
|
|
3031
|
-
/**
|
|
3032
|
-
* @public
|
|
3033
|
-
* @enum
|
|
3034
|
-
*/
|
|
3035
|
-
export declare const ResultFormat: {
|
|
3036
|
-
readonly CSV: "CSV";
|
|
3037
|
-
readonly PARQUET: "PARQUET";
|
|
3038
|
-
};
|
|
3039
|
-
/**
|
|
3040
|
-
* @public
|
|
3041
|
-
*/
|
|
3042
|
-
export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat];
|
|
3043
|
-
/**
|
|
3044
|
-
* @public
|
|
3045
|
-
* <p>Contains the configuration to write the query results to S3.</p>
|
|
3046
|
-
*/
|
|
3047
|
-
export interface ProtectedQueryS3OutputConfiguration {
|
|
3048
|
-
/**
|
|
3049
|
-
* @public
|
|
3050
|
-
* <p>Intended file format of the result.</p>
|
|
3051
|
-
*/
|
|
3052
|
-
resultFormat: ResultFormat | string | undefined;
|
|
3053
|
-
/**
|
|
3054
|
-
* @public
|
|
3055
|
-
* <p>The S3 bucket to unload the protected query results.</p>
|
|
3056
|
-
*/
|
|
3057
|
-
bucket: string | undefined;
|
|
3058
|
-
/**
|
|
3059
|
-
* @public
|
|
3060
|
-
* <p>The S3 prefix to unload the protected query results.</p>
|
|
3061
|
-
*/
|
|
3062
|
-
keyPrefix?: string;
|
|
3063
|
-
}
|
|
3064
3239
|
/**
|
|
3065
3240
|
* @public
|
|
3066
3241
|
* <p>Contains configuration details for protected query output.</p>
|
|
@@ -3114,7 +3289,8 @@ export interface ProtectedQuerySQLParameters {
|
|
|
3114
3289
|
queryString?: string;
|
|
3115
3290
|
/**
|
|
3116
3291
|
* @public
|
|
3117
|
-
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
3292
|
+
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
3293
|
+
* collaboration.</p>
|
|
3118
3294
|
*/
|
|
3119
3295
|
analysisTemplateArn?: string;
|
|
3120
3296
|
/**
|
|
@@ -3153,7 +3329,7 @@ export declare const ProtectedQueryStatus: {
|
|
|
3153
3329
|
export type ProtectedQueryStatus = (typeof ProtectedQueryStatus)[keyof typeof ProtectedQueryStatus];
|
|
3154
3330
|
/**
|
|
3155
3331
|
* @public
|
|
3156
|
-
* <p>The parameters for an Clean Rooms
|
|
3332
|
+
* <p>The parameters for an Clean Rooms protected query.</p>
|
|
3157
3333
|
*/
|
|
3158
3334
|
export interface ProtectedQuery {
|
|
3159
3335
|
/**
|
|
@@ -3180,7 +3356,7 @@ export interface ProtectedQuery {
|
|
|
3180
3356
|
* @public
|
|
3181
3357
|
* <p>The protected query SQL parameters.</p>
|
|
3182
3358
|
*/
|
|
3183
|
-
sqlParameters
|
|
3359
|
+
sqlParameters?: ProtectedQuerySQLParameters;
|
|
3184
3360
|
/**
|
|
3185
3361
|
* @public
|
|
3186
3362
|
* <p>The status of the query.</p>
|
|
@@ -3190,7 +3366,7 @@ export interface ProtectedQuery {
|
|
|
3190
3366
|
* @public
|
|
3191
3367
|
* <p>Contains any details needed to write the query results.</p>
|
|
3192
3368
|
*/
|
|
3193
|
-
resultConfiguration
|
|
3369
|
+
resultConfiguration?: ProtectedQueryResultConfiguration;
|
|
3194
3370
|
/**
|
|
3195
3371
|
* @public
|
|
3196
3372
|
* <p>Statistics about protected query execution.</p>
|
|
@@ -3223,7 +3399,8 @@ export interface GetProtectedQueryOutput {
|
|
|
3223
3399
|
export interface ListMembershipsInput {
|
|
3224
3400
|
/**
|
|
3225
3401
|
* @public
|
|
3226
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
3402
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
3403
|
+
* results.</p>
|
|
3227
3404
|
*/
|
|
3228
3405
|
nextToken?: string;
|
|
3229
3406
|
/**
|
|
@@ -3264,7 +3441,8 @@ export interface MembershipSummary {
|
|
|
3264
3441
|
collaborationId: string | undefined;
|
|
3265
3442
|
/**
|
|
3266
3443
|
* @public
|
|
3267
|
-
* <p>The identifier of the Amazon Web Services principal that created the collaboration. Currently only
|
|
3444
|
+
* <p>The identifier of the Amazon Web Services principal that created the collaboration. Currently only
|
|
3445
|
+
* supports Amazon Web Services account ID.</p>
|
|
3268
3446
|
*/
|
|
3269
3447
|
collaborationCreatorAccountId: string | undefined;
|
|
3270
3448
|
/**
|
|
@@ -3289,7 +3467,8 @@ export interface MembershipSummary {
|
|
|
3289
3467
|
updateTime: Date | undefined;
|
|
3290
3468
|
/**
|
|
3291
3469
|
* @public
|
|
3292
|
-
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and
|
|
3470
|
+
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and
|
|
3471
|
+
* `COLLABORATION_DELETED`.</p>
|
|
3293
3472
|
*/
|
|
3294
3473
|
status: MembershipStatus | string | undefined;
|
|
3295
3474
|
/**
|
|
@@ -3304,7 +3483,8 @@ export interface MembershipSummary {
|
|
|
3304
3483
|
export interface ListMembershipsOutput {
|
|
3305
3484
|
/**
|
|
3306
3485
|
* @public
|
|
3307
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
3486
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
3487
|
+
* results.</p>
|
|
3308
3488
|
*/
|
|
3309
3489
|
nextToken?: string;
|
|
3310
3490
|
/**
|
|
@@ -3329,7 +3509,8 @@ export interface ListProtectedQueriesInput {
|
|
|
3329
3509
|
status?: ProtectedQueryStatus | string;
|
|
3330
3510
|
/**
|
|
3331
3511
|
* @public
|
|
3332
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
3512
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
3513
|
+
* results.</p>
|
|
3333
3514
|
*/
|
|
3334
3515
|
nextToken?: string;
|
|
3335
3516
|
/**
|
|
@@ -3367,7 +3548,8 @@ export interface ProtectedQuerySummary {
|
|
|
3367
3548
|
createTime: Date | undefined;
|
|
3368
3549
|
/**
|
|
3369
3550
|
* @public
|
|
3370
|
-
* <p>The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,
|
|
3551
|
+
* <p>The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,
|
|
3552
|
+
* `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.</p>
|
|
3371
3553
|
*/
|
|
3372
3554
|
status: ProtectedQueryStatus | string | undefined;
|
|
3373
3555
|
}
|
|
@@ -3377,7 +3559,8 @@ export interface ProtectedQuerySummary {
|
|
|
3377
3559
|
export interface ListProtectedQueriesOutput {
|
|
3378
3560
|
/**
|
|
3379
3561
|
* @public
|
|
3380
|
-
* <p>The token value retrieved from a previous call to access the next page of
|
|
3562
|
+
* <p>The token value retrieved from a previous call to access the next page of
|
|
3563
|
+
* results.</p>
|
|
3381
3564
|
*/
|
|
3382
3565
|
nextToken?: string;
|
|
3383
3566
|
/**
|
|
@@ -3408,7 +3591,8 @@ export interface StartProtectedQueryInput {
|
|
|
3408
3591
|
type: ProtectedQueryType | string | undefined;
|
|
3409
3592
|
/**
|
|
3410
3593
|
* @public
|
|
3411
|
-
* <p>A unique identifier for the membership to run this query against. Currently accepts a
|
|
3594
|
+
* <p>A unique identifier for the membership to run this query against. Currently accepts a
|
|
3595
|
+
* membership ID.</p>
|
|
3412
3596
|
*/
|
|
3413
3597
|
membershipIdentifier: string | undefined;
|
|
3414
3598
|
/**
|
|
@@ -3420,7 +3604,7 @@ export interface StartProtectedQueryInput {
|
|
|
3420
3604
|
* @public
|
|
3421
3605
|
* <p>The details needed to write the query results.</p>
|
|
3422
3606
|
*/
|
|
3423
|
-
resultConfiguration
|
|
3607
|
+
resultConfiguration?: ProtectedQueryResultConfiguration;
|
|
3424
3608
|
}
|
|
3425
3609
|
/**
|
|
3426
3610
|
* @public
|
|
@@ -3447,6 +3631,13 @@ export interface UpdateMembershipInput {
|
|
|
3447
3631
|
* collaboration.</p>
|
|
3448
3632
|
*/
|
|
3449
3633
|
queryLogStatus?: MembershipQueryLogStatus | string;
|
|
3634
|
+
/**
|
|
3635
|
+
* @public
|
|
3636
|
+
* <p>The default
|
|
3637
|
+
* protected query result configuration as specified by the member who can receive
|
|
3638
|
+
* results.</p>
|
|
3639
|
+
*/
|
|
3640
|
+
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
|
|
3450
3641
|
}
|
|
3451
3642
|
/**
|
|
3452
3643
|
* @public
|
|
@@ -3485,7 +3676,8 @@ export interface UpdateProtectedQueryInput {
|
|
|
3485
3676
|
protectedQueryIdentifier: string | undefined;
|
|
3486
3677
|
/**
|
|
3487
3678
|
* @public
|
|
3488
|
-
* <p>The target status of a query. Used to update the execution status of a currently running
|
|
3679
|
+
* <p>The target status of a query. Used to update the execution status of a currently running
|
|
3680
|
+
* query.</p>
|
|
3489
3681
|
*/
|
|
3490
3682
|
targetStatus: TargetProtectedQueryStatus | string | undefined;
|
|
3491
3683
|
}
|
|
@@ -3525,7 +3717,8 @@ export interface TagResourceOutput {
|
|
|
3525
3717
|
export interface UntagResourceInput {
|
|
3526
3718
|
/**
|
|
3527
3719
|
* @public
|
|
3528
|
-
* <p>The Amazon Resource Name (ARN) associated with the resource you want to remove the tag
|
|
3720
|
+
* <p>The Amazon Resource Name (ARN) associated with the resource you want to remove the tag
|
|
3721
|
+
* from.</p>
|
|
3529
3722
|
*/
|
|
3530
3723
|
resourceArn: string | undefined;
|
|
3531
3724
|
/**
|