@aws-sdk/client-cleanrooms 3.798.0 → 3.800.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 +1 -9
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/models/models_1.js +14 -0
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/CleanRooms.d.ts +1 -9
- package/dist-types/CleanRoomsClient.d.ts +1 -9
- package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +1 -2
- package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +1 -2
- package/dist-types/commands/CreateConfiguredTableAssociationCommand.d.ts +1 -2
- package/dist-types/commands/CreateMembershipCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMemberCommand.d.ts +1 -3
- package/dist-types/commands/GetProtectedQueryCommand.d.ts +25 -0
- package/dist-types/commands/StartProtectedQueryCommand.d.ts +40 -0
- package/dist-types/commands/UpdateProtectedQueryCommand.d.ts +25 -0
- package/dist-types/index.d.ts +1 -9
- package/dist-types/models/models_0.d.ts +183 -548
- package/dist-types/models/models_1.d.ts +121 -58
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/models/models_1.d.ts +59 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
- package/package.json +5 -5
|
@@ -85,27 +85,22 @@ export declare const AggregationType: {
|
|
|
85
85
|
*/
|
|
86
86
|
export type AggregationType = (typeof AggregationType)[keyof typeof AggregationType];
|
|
87
87
|
/**
|
|
88
|
-
* <p>Constraint on query output removing output rows that do not meet a minimum number of
|
|
89
|
-
* distinct values of a specified column.</p>
|
|
88
|
+
* <p>Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.</p>
|
|
90
89
|
* @public
|
|
91
90
|
*/
|
|
92
91
|
export interface AggregationConstraint {
|
|
93
92
|
/**
|
|
94
|
-
* <p>Column in aggregation constraint for which there must be a minimum number of distinct
|
|
95
|
-
* values in an output row for it to be in the query output.</p>
|
|
93
|
+
* <p>Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.</p>
|
|
96
94
|
* @public
|
|
97
95
|
*/
|
|
98
96
|
columnName: string | undefined;
|
|
99
97
|
/**
|
|
100
|
-
* <p>The minimum number of distinct values that an output row must be an aggregation of.
|
|
101
|
-
* Minimum threshold of distinct values for a specified column that must exist in an output
|
|
102
|
-
* row for it to be in the query output.</p>
|
|
98
|
+
* <p>The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.</p>
|
|
103
99
|
* @public
|
|
104
100
|
*/
|
|
105
101
|
minimum: number | undefined;
|
|
106
102
|
/**
|
|
107
|
-
* <p>The type of aggregation the constraint allows. The only valid value is currently
|
|
108
|
-
* `COUNT_DISTINCT`.</p>
|
|
103
|
+
* <p>The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.</p>
|
|
109
104
|
* @public
|
|
110
105
|
*/
|
|
111
106
|
type: AggregationType | undefined;
|
|
@@ -174,14 +169,12 @@ export declare const ParameterType: {
|
|
|
174
169
|
*/
|
|
175
170
|
export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
|
|
176
171
|
/**
|
|
177
|
-
* <p>Optional. The member who can query can provide this placeholder for a literal data value
|
|
178
|
-
* in an analysis template.</p>
|
|
172
|
+
* <p>Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.</p>
|
|
179
173
|
* @public
|
|
180
174
|
*/
|
|
181
175
|
export interface AnalysisParameter {
|
|
182
176
|
/**
|
|
183
|
-
* <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or
|
|
184
|
-
* hyphen (-) characters but cannot start or end with a hyphen.</p>
|
|
177
|
+
* <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.</p>
|
|
185
178
|
* @public
|
|
186
179
|
*/
|
|
187
180
|
name: string | undefined;
|
|
@@ -191,8 +184,7 @@ export interface AnalysisParameter {
|
|
|
191
184
|
*/
|
|
192
185
|
type: ParameterType | undefined;
|
|
193
186
|
/**
|
|
194
|
-
* <p>Optional. The default value that is applied in the analysis template. The member who can
|
|
195
|
-
* query can override this value in the query editor.</p>
|
|
187
|
+
* <p>Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.</p>
|
|
196
188
|
* @public
|
|
197
189
|
*/
|
|
198
190
|
defaultValue?: string | undefined;
|
|
@@ -203,16 +195,12 @@ export interface AnalysisParameter {
|
|
|
203
195
|
*/
|
|
204
196
|
export interface ConfiguredTableAssociationAnalysisRuleAggregation {
|
|
205
197
|
/**
|
|
206
|
-
* <p> The list of collaboration members who are allowed to receive results of queries run
|
|
207
|
-
* with this configured table.</p>
|
|
198
|
+
* <p> The list of collaboration members who are allowed to receive results of queries run with this configured table.</p>
|
|
208
199
|
* @public
|
|
209
200
|
*/
|
|
210
201
|
allowedResultReceivers?: string[] | undefined;
|
|
211
202
|
/**
|
|
212
|
-
* <p> The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.</p>
|
|
213
|
-
* <p>The <code>allowedAdditionalAnalyses</code> parameter is currently supported for the list
|
|
214
|
-
* analysis rule (<code>AnalysisRuleList</code>) and the custom analysis rule
|
|
215
|
-
* (<code>AnalysisRuleCustom</code>).</p>
|
|
203
|
+
* <p> The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.</p> <p>The <code>allowedAdditionalAnalyses</code> parameter is currently supported for the list analysis rule (<code>AnalysisRuleList</code>) and the custom analysis rule (<code>AnalysisRuleCustom</code>).</p>
|
|
216
204
|
* @public
|
|
217
205
|
*/
|
|
218
206
|
allowedAdditionalAnalyses?: string[] | undefined;
|
|
@@ -223,8 +211,7 @@ export interface ConfiguredTableAssociationAnalysisRuleAggregation {
|
|
|
223
211
|
*/
|
|
224
212
|
export interface ConfiguredTableAssociationAnalysisRuleCustom {
|
|
225
213
|
/**
|
|
226
|
-
* <p> The list of collaboration members who are allowed to receive results of queries run
|
|
227
|
-
* with this configured table.</p>
|
|
214
|
+
* <p> The list of collaboration members who are allowed to receive results of queries run with this configured table.</p>
|
|
228
215
|
* @public
|
|
229
216
|
*/
|
|
230
217
|
allowedResultReceivers?: string[] | undefined;
|
|
@@ -240,8 +227,7 @@ export interface ConfiguredTableAssociationAnalysisRuleCustom {
|
|
|
240
227
|
*/
|
|
241
228
|
export interface ConfiguredTableAssociationAnalysisRuleList {
|
|
242
229
|
/**
|
|
243
|
-
* <p> The list of collaboration members who are allowed to receive results of queries run
|
|
244
|
-
* with this configured table.</p>
|
|
230
|
+
* <p> The list of collaboration members who are allowed to receive results of queries run with this configured table.</p>
|
|
245
231
|
* @public
|
|
246
232
|
*/
|
|
247
233
|
allowedResultReceivers?: string[] | undefined;
|
|
@@ -636,8 +622,7 @@ export declare namespace ConsolidatedPolicy {
|
|
|
636
622
|
const visit: <T>(value: ConsolidatedPolicy, visitor: Visitor<T>) => T;
|
|
637
623
|
}
|
|
638
624
|
/**
|
|
639
|
-
* <p>A type of analysis rule that enables query structure and specified queries that produce
|
|
640
|
-
* aggregate statistics.</p>
|
|
625
|
+
* <p>A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.</p>
|
|
641
626
|
* @public
|
|
642
627
|
*/
|
|
643
628
|
export interface AnalysisRuleAggregation {
|
|
@@ -647,20 +632,17 @@ export interface AnalysisRuleAggregation {
|
|
|
647
632
|
*/
|
|
648
633
|
aggregateColumns: AggregateColumn[] | undefined;
|
|
649
634
|
/**
|
|
650
|
-
* <p>Columns in configured table that can be used in join statements and/or as aggregate
|
|
651
|
-
* columns. They can never be outputted directly.</p>
|
|
635
|
+
* <p>Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.</p>
|
|
652
636
|
* @public
|
|
653
637
|
*/
|
|
654
638
|
joinColumns: string[] | undefined;
|
|
655
639
|
/**
|
|
656
|
-
* <p>Control that requires member who runs query to do a join with their configured table
|
|
657
|
-
* and/or other configured table in query.</p>
|
|
640
|
+
* <p>Control that requires member who runs query to do a join with their configured table and/or other configured table in query.</p>
|
|
658
641
|
* @public
|
|
659
642
|
*/
|
|
660
643
|
joinRequired?: JoinRequiredOption | undefined;
|
|
661
644
|
/**
|
|
662
|
-
* <p>Which logical operators (if any) are to be used in an INNER JOIN match condition.
|
|
663
|
-
* Default is <code>AND</code>.</p>
|
|
645
|
+
* <p>Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>
|
|
664
646
|
* @public
|
|
665
647
|
*/
|
|
666
648
|
allowedJoinOperators?: JoinOperator[] | undefined;
|
|
@@ -670,29 +652,23 @@ export interface AnalysisRuleAggregation {
|
|
|
670
652
|
*/
|
|
671
653
|
dimensionColumns: string[] | undefined;
|
|
672
654
|
/**
|
|
673
|
-
* <p>Set of scalar functions that are allowed to be used on dimension columns and the output
|
|
674
|
-
* of aggregation of metrics.</p>
|
|
655
|
+
* <p>Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.</p>
|
|
675
656
|
* @public
|
|
676
657
|
*/
|
|
677
658
|
scalarFunctions: ScalarFunctions[] | undefined;
|
|
678
659
|
/**
|
|
679
|
-
* <p>Columns that must meet a specific threshold value (after an aggregation function is
|
|
680
|
-
* applied to it) for each output row to be returned.</p>
|
|
660
|
+
* <p>Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.</p>
|
|
681
661
|
* @public
|
|
682
662
|
*/
|
|
683
663
|
outputConstraints: AggregationConstraint[] | undefined;
|
|
684
664
|
/**
|
|
685
|
-
* <p> An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query. </p>
|
|
686
|
-
* <p>The <code>additionalAnalyses</code> parameter is currently supported for the list
|
|
687
|
-
* analysis rule (<code>AnalysisRuleList</code>) and the custom analysis rule
|
|
688
|
-
* (<code>AnalysisRuleCustom</code>).</p>
|
|
665
|
+
* <p> An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query. </p> <p>The <code>additionalAnalyses</code> parameter is currently supported for the list analysis rule (<code>AnalysisRuleList</code>) and the custom analysis rule (<code>AnalysisRuleCustom</code>).</p>
|
|
689
666
|
* @public
|
|
690
667
|
*/
|
|
691
668
|
additionalAnalyses?: AdditionalAnalyses | undefined;
|
|
692
669
|
}
|
|
693
670
|
/**
|
|
694
|
-
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
695
|
-
* their configured tables. It supports differential privacy.</p>
|
|
671
|
+
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.</p>
|
|
696
672
|
* @public
|
|
697
673
|
*/
|
|
698
674
|
export interface AnalysisRuleCustom {
|
|
@@ -702,8 +678,7 @@ export interface AnalysisRuleCustom {
|
|
|
702
678
|
*/
|
|
703
679
|
allowedAnalyses: string[] | undefined;
|
|
704
680
|
/**
|
|
705
|
-
* <p>The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when
|
|
706
|
-
* <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>
|
|
681
|
+
* <p>The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>
|
|
707
682
|
* @public
|
|
708
683
|
*/
|
|
709
684
|
allowedAnalysisProviders?: string[] | undefined;
|
|
@@ -791,14 +766,12 @@ export interface AnalysisRuleIdMappingTable {
|
|
|
791
766
|
*/
|
|
792
767
|
export interface AnalysisRuleList {
|
|
793
768
|
/**
|
|
794
|
-
* <p>Columns that can be used to join a configured table with the table of the member who can
|
|
795
|
-
* query and other members' configured tables.</p>
|
|
769
|
+
* <p>Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.</p>
|
|
796
770
|
* @public
|
|
797
771
|
*/
|
|
798
772
|
joinColumns: string[] | undefined;
|
|
799
773
|
/**
|
|
800
|
-
* <p>The logical operators (if any) that are to be used in an INNER JOIN match condition.
|
|
801
|
-
* Default is <code>AND</code>.</p>
|
|
774
|
+
* <p>The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>
|
|
802
775
|
* @public
|
|
803
776
|
*/
|
|
804
777
|
allowedJoinOperators?: JoinOperator[] | undefined;
|
|
@@ -1169,8 +1142,7 @@ export declare const AnalysisTemplateValidationType: {
|
|
|
1169
1142
|
*/
|
|
1170
1143
|
export type AnalysisTemplateValidationType = (typeof AnalysisTemplateValidationType)[keyof typeof AnalysisTemplateValidationType];
|
|
1171
1144
|
/**
|
|
1172
|
-
* <p>The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.</p>
|
|
1173
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy">https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy</a>.</p>
|
|
1145
|
+
* <p>The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy">https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy</a>.</p>
|
|
1174
1146
|
* @public
|
|
1175
1147
|
*/
|
|
1176
1148
|
export interface AnalysisTemplateValidationStatusDetail {
|
|
@@ -1355,16 +1327,12 @@ export interface CreateAnalysisTemplateInput {
|
|
|
1355
1327
|
*/
|
|
1356
1328
|
format: AnalysisFormat | undefined;
|
|
1357
1329
|
/**
|
|
1358
|
-
* <p>The information in the analysis template. Currently supports <code>text</code>, the
|
|
1359
|
-
* query text for the analysis template.</p>
|
|
1330
|
+
* <p>The information in the analysis template. Currently supports <code>text</code>, the query text for the analysis template.</p>
|
|
1360
1331
|
* @public
|
|
1361
1332
|
*/
|
|
1362
1333
|
source: AnalysisSource | undefined;
|
|
1363
1334
|
/**
|
|
1364
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
1365
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
1366
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
1367
|
-
* to this resource.</p>
|
|
1335
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
1368
1336
|
* @public
|
|
1369
1337
|
*/
|
|
1370
1338
|
tags?: Record<string, string> | undefined;
|
|
@@ -1569,8 +1537,7 @@ export interface ListAnalysisTemplatesInput {
|
|
|
1569
1537
|
*/
|
|
1570
1538
|
nextToken?: string | undefined;
|
|
1571
1539
|
/**
|
|
1572
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
1573
|
-
* `maxResults` value has not been met.</p>
|
|
1540
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
1574
1541
|
* @public
|
|
1575
1542
|
*/
|
|
1576
1543
|
maxResults?: number | undefined;
|
|
@@ -1621,8 +1588,7 @@ export interface AnalysisTemplateSummary {
|
|
|
1621
1588
|
*/
|
|
1622
1589
|
collaborationArn: string | undefined;
|
|
1623
1590
|
/**
|
|
1624
|
-
* <p>A unique identifier for the collaboration that the analysis template summary belongs to.
|
|
1625
|
-
* Currently accepts collaboration ID.</p>
|
|
1591
|
+
* <p>A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.</p>
|
|
1626
1592
|
* @public
|
|
1627
1593
|
*/
|
|
1628
1594
|
collaborationId: string | undefined;
|
|
@@ -1732,14 +1698,12 @@ export interface AthenaTableReference {
|
|
|
1732
1698
|
*/
|
|
1733
1699
|
export interface BatchGetCollaborationAnalysisTemplateInput {
|
|
1734
1700
|
/**
|
|
1735
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1736
|
-
* Currently accepts collaboration ID.</p>
|
|
1701
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
1737
1702
|
* @public
|
|
1738
1703
|
*/
|
|
1739
1704
|
collaborationIdentifier: string | undefined;
|
|
1740
1705
|
/**
|
|
1741
|
-
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
1742
|
-
* collaboration.</p>
|
|
1706
|
+
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
|
|
1743
1707
|
* @public
|
|
1744
1708
|
*/
|
|
1745
1709
|
analysisTemplateArns: string[] | undefined;
|
|
@@ -1760,8 +1724,7 @@ export interface CollaborationAnalysisTemplate {
|
|
|
1760
1724
|
*/
|
|
1761
1725
|
arn: string | undefined;
|
|
1762
1726
|
/**
|
|
1763
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
1764
|
-
* Currently accepts collaboration ID.</p>
|
|
1727
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
1765
1728
|
* @public
|
|
1766
1729
|
*/
|
|
1767
1730
|
collaborationId: string | undefined;
|
|
@@ -1776,8 +1739,7 @@ export interface CollaborationAnalysisTemplate {
|
|
|
1776
1739
|
*/
|
|
1777
1740
|
description?: string | undefined;
|
|
1778
1741
|
/**
|
|
1779
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
1780
|
-
* Amazon Web Services account ID.</p>
|
|
1742
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1781
1743
|
* @public
|
|
1782
1744
|
*/
|
|
1783
1745
|
creatorAccountId: string | undefined;
|
|
@@ -1828,8 +1790,7 @@ export interface CollaborationAnalysisTemplate {
|
|
|
1828
1790
|
validations?: AnalysisTemplateValidationStatusDetail[] | undefined;
|
|
1829
1791
|
}
|
|
1830
1792
|
/**
|
|
1831
|
-
* <p>Details of errors thrown by the call to retrieve multiple analysis templates within a
|
|
1832
|
-
* collaboration by their identifiers.</p>
|
|
1793
|
+
* <p>Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.</p>
|
|
1833
1794
|
* @public
|
|
1834
1795
|
*/
|
|
1835
1796
|
export interface BatchGetCollaborationAnalysisTemplateError {
|
|
@@ -1859,9 +1820,7 @@ export interface BatchGetCollaborationAnalysisTemplateOutput {
|
|
|
1859
1820
|
*/
|
|
1860
1821
|
collaborationAnalysisTemplates: CollaborationAnalysisTemplate[] | undefined;
|
|
1861
1822
|
/**
|
|
1862
|
-
* <p>Error reasons for collaboration analysis templates that could not be retrieved. One
|
|
1863
|
-
* error is returned for every collaboration analysis template that could not be
|
|
1864
|
-
* retrieved.</p>
|
|
1823
|
+
* <p>Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.</p>
|
|
1865
1824
|
* @public
|
|
1866
1825
|
*/
|
|
1867
1826
|
errors: BatchGetCollaborationAnalysisTemplateError[] | undefined;
|
|
@@ -1871,8 +1830,7 @@ export interface BatchGetCollaborationAnalysisTemplateOutput {
|
|
|
1871
1830
|
*/
|
|
1872
1831
|
export interface BatchGetSchemaInput {
|
|
1873
1832
|
/**
|
|
1874
|
-
* <p>A unique identifier for the collaboration that the schemas belong to. Currently accepts
|
|
1875
|
-
* collaboration ID.</p>
|
|
1833
|
+
* <p>A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.</p>
|
|
1876
1834
|
* @public
|
|
1877
1835
|
*/
|
|
1878
1836
|
collaborationIdentifier: string | undefined;
|
|
@@ -1904,8 +1862,7 @@ export interface BatchGetSchemaError {
|
|
|
1904
1862
|
message: string | undefined;
|
|
1905
1863
|
}
|
|
1906
1864
|
/**
|
|
1907
|
-
* <p>A column within a schema relation, derived from the underlying
|
|
1908
|
-
* table.</p>
|
|
1865
|
+
* <p>A column within a schema relation, derived from the underlying table.</p>
|
|
1909
1866
|
* @public
|
|
1910
1867
|
*/
|
|
1911
1868
|
export interface Column {
|
|
@@ -1981,8 +1938,7 @@ export declare const SchemaStatus: {
|
|
|
1981
1938
|
*/
|
|
1982
1939
|
export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus];
|
|
1983
1940
|
/**
|
|
1984
|
-
* <p>Information about the schema status.</p>
|
|
1985
|
-
* <p>A status of <code>READY</code> means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.</p>
|
|
1941
|
+
* <p>Information about the schema status.</p> <p>A status of <code>READY</code> means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.</p>
|
|
1986
1942
|
* @public
|
|
1987
1943
|
*/
|
|
1988
1944
|
export interface SchemaStatusDetail {
|
|
@@ -2007,8 +1963,7 @@ export interface SchemaStatusDetail {
|
|
|
2007
1963
|
*/
|
|
2008
1964
|
configurations?: SchemaConfiguration[] | undefined;
|
|
2009
1965
|
/**
|
|
2010
|
-
* <p>The type of analysis that can be performed on the schema.</p>
|
|
2011
|
-
* <p>A schema can have an <code>analysisType</code> of <code>DIRECT_ANALYSIS</code>, <code>ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION</code>, or both.</p>
|
|
1966
|
+
* <p>The type of analysis that can be performed on the schema.</p> <p>A schema can have an <code>analysisType</code> of <code>DIRECT_ANALYSIS</code>, <code>ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION</code>, or both.</p>
|
|
2012
1967
|
* @public
|
|
2013
1968
|
*/
|
|
2014
1969
|
analysisType: AnalysisType | undefined;
|
|
@@ -2122,19 +2077,12 @@ export interface Schema {
|
|
|
2122
2077
|
*/
|
|
2123
2078
|
partitionKeys: Column[] | undefined;
|
|
2124
2079
|
/**
|
|
2125
|
-
* <p>The analysis rule types that are associated with the schema. Currently, only one entry is
|
|
2126
|
-
* present.</p>
|
|
2080
|
+
* <p>The analysis rule types that are associated with the schema. Currently, only one entry is present.</p>
|
|
2127
2081
|
* @public
|
|
2128
2082
|
*/
|
|
2129
2083
|
analysisRuleTypes: AnalysisRuleType[] | undefined;
|
|
2130
2084
|
/**
|
|
2131
|
-
* <p>The analysis method for the schema. </p>
|
|
2132
|
-
* <p>
|
|
2133
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
2134
|
-
* <p>
|
|
2135
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
2136
|
-
* <p>
|
|
2137
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
2085
|
+
* <p>The analysis method for the schema. </p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
2138
2086
|
* @public
|
|
2139
2087
|
*/
|
|
2140
2088
|
analysisMethod?: AnalysisMethod | undefined;
|
|
@@ -2149,8 +2097,7 @@ export interface Schema {
|
|
|
2149
2097
|
*/
|
|
2150
2098
|
creatorAccountId: string | undefined;
|
|
2151
2099
|
/**
|
|
2152
|
-
* <p>A name for the schema. The schema relation is referred to by this name when queried by a
|
|
2153
|
-
* protected query.</p>
|
|
2100
|
+
* <p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>
|
|
2154
2101
|
* @public
|
|
2155
2102
|
*/
|
|
2156
2103
|
name: string | undefined;
|
|
@@ -2205,8 +2152,7 @@ export interface BatchGetSchemaOutput {
|
|
|
2205
2152
|
*/
|
|
2206
2153
|
schemas: Schema[] | undefined;
|
|
2207
2154
|
/**
|
|
2208
|
-
* <p>Error reasons for schemas that could not be retrieved. One error is returned for every
|
|
2209
|
-
* schema that could not be retrieved.</p>
|
|
2155
|
+
* <p>Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.</p>
|
|
2210
2156
|
* @public
|
|
2211
2157
|
*/
|
|
2212
2158
|
errors: BatchGetSchemaError[] | undefined;
|
|
@@ -2320,67 +2266,40 @@ export interface MLMemberAbilities {
|
|
|
2320
2266
|
customMLMemberAbilities: CustomMLMemberAbility[] | undefined;
|
|
2321
2267
|
}
|
|
2322
2268
|
/**
|
|
2323
|
-
* <p>An object representing the collaboration member's payment responsibilities
|
|
2324
|
-
* set by the collaboration creator for query and job compute costs.</p>
|
|
2269
|
+
* <p>An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.</p>
|
|
2325
2270
|
* @public
|
|
2326
2271
|
*/
|
|
2327
2272
|
export interface JobComputePaymentConfig {
|
|
2328
2273
|
/**
|
|
2329
|
-
* <p>Indicates whether the collaboration creator has configured the collaboration
|
|
2330
|
-
* member to pay for query and job compute costs (<code>TRUE</code>) or has not configured the
|
|
2331
|
-
* collaboration member to pay for query and job compute costs (<code>FALSE</code>).</p>
|
|
2332
|
-
* <p>Exactly one member can be configured to pay for query and job compute costs. An error
|
|
2333
|
-
* is returned if the collaboration creator sets a <code>TRUE</code> value for more
|
|
2334
|
-
* than one member in the collaboration. </p>
|
|
2335
|
-
* <p>An error is returned if the collaboration creator sets a
|
|
2336
|
-
* <code>FALSE</code> value for the member who can run queries and jobs.</p>
|
|
2274
|
+
* <p>Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (<code>TRUE</code>) or has not configured the collaboration member to pay for query and job compute costs (<code>FALSE</code>).</p> <p>Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a <code>TRUE</code> value for more than one member in the collaboration. </p> <p>An error is returned if the collaboration creator sets a <code>FALSE</code> value for the member who can run queries and jobs.</p>
|
|
2337
2275
|
* @public
|
|
2338
2276
|
*/
|
|
2339
2277
|
isResponsible: boolean | undefined;
|
|
2340
2278
|
}
|
|
2341
2279
|
/**
|
|
2342
|
-
* <p>An object representing the collaboration member's model inference payment responsibilities set by the
|
|
2343
|
-
* collaboration creator.</p>
|
|
2280
|
+
* <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
|
|
2344
2281
|
* @public
|
|
2345
2282
|
*/
|
|
2346
2283
|
export interface ModelInferencePaymentConfig {
|
|
2347
2284
|
/**
|
|
2348
|
-
* <p>Indicates whether the collaboration creator has configured the collaboration member to
|
|
2349
|
-
* pay for model inference costs (<code>TRUE</code>) or has not configured the collaboration
|
|
2350
|
-
* member to pay for model inference costs (<code>FALSE</code>).</p>
|
|
2351
|
-
* <p>Exactly one member can be configured to pay for model inference costs. An error is
|
|
2352
|
-
* returned if the collaboration creator sets a <code>TRUE</code> value for more than one
|
|
2353
|
-
* member in the collaboration. </p>
|
|
2354
|
-
* <p>If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if
|
|
2355
|
-
* the collaboration creator sets a <code>FALSE</code> value for the member who can
|
|
2356
|
-
* query.</p>
|
|
2285
|
+
* <p>Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (<code>TRUE</code>) or has not configured the collaboration member to pay for model inference costs (<code>FALSE</code>).</p> <p>Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a <code>TRUE</code> value for more than one member in the collaboration. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a <code>FALSE</code> value for the member who can query.</p>
|
|
2357
2286
|
* @public
|
|
2358
2287
|
*/
|
|
2359
2288
|
isResponsible: boolean | undefined;
|
|
2360
2289
|
}
|
|
2361
2290
|
/**
|
|
2362
|
-
* <p>An object representing the collaboration member's model training payment responsibilities set by the
|
|
2363
|
-
* collaboration creator.</p>
|
|
2291
|
+
* <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
|
|
2364
2292
|
* @public
|
|
2365
2293
|
*/
|
|
2366
2294
|
export interface ModelTrainingPaymentConfig {
|
|
2367
2295
|
/**
|
|
2368
|
-
* <p>Indicates whether the collaboration creator has configured the collaboration member to
|
|
2369
|
-
* pay for model training costs (<code>TRUE</code>) or has not configured the collaboration
|
|
2370
|
-
* member to pay for model training costs (<code>FALSE</code>).</p>
|
|
2371
|
-
* <p>Exactly one member can be configured to pay for model training costs. An error is
|
|
2372
|
-
* returned if the collaboration creator sets a <code>TRUE</code> value for more than one
|
|
2373
|
-
* member in the collaboration. </p>
|
|
2374
|
-
* <p>If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if
|
|
2375
|
-
* the collaboration creator sets a <code>FALSE</code> value for the member who can
|
|
2376
|
-
* query.</p>
|
|
2296
|
+
* <p>Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (<code>TRUE</code>) or has not configured the collaboration member to pay for model training costs (<code>FALSE</code>).</p> <p>Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a <code>TRUE</code> value for more than one member in the collaboration. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a <code>FALSE</code> value for the member who can query.</p>
|
|
2377
2297
|
* @public
|
|
2378
2298
|
*/
|
|
2379
2299
|
isResponsible: boolean | undefined;
|
|
2380
2300
|
}
|
|
2381
2301
|
/**
|
|
2382
|
-
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the
|
|
2383
|
-
* collaboration creator.</p>
|
|
2302
|
+
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
2384
2303
|
* @public
|
|
2385
2304
|
*/
|
|
2386
2305
|
export interface MLPaymentConfig {
|
|
@@ -2396,41 +2315,28 @@ export interface MLPaymentConfig {
|
|
|
2396
2315
|
modelInference?: ModelInferencePaymentConfig | undefined;
|
|
2397
2316
|
}
|
|
2398
2317
|
/**
|
|
2399
|
-
* <p>An object representing the collaboration member's payment responsibilities set by the
|
|
2400
|
-
* collaboration creator for query compute costs.</p>
|
|
2318
|
+
* <p>An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.</p>
|
|
2401
2319
|
* @public
|
|
2402
2320
|
*/
|
|
2403
2321
|
export interface QueryComputePaymentConfig {
|
|
2404
2322
|
/**
|
|
2405
|
-
* <p>Indicates whether the collaboration creator has configured the collaboration member to
|
|
2406
|
-
* pay for query compute costs (<code>TRUE</code>) or has not configured the collaboration
|
|
2407
|
-
* member to pay for query compute costs (<code>FALSE</code>).</p>
|
|
2408
|
-
* <p>Exactly one member can be configured to pay for query compute costs. An error is
|
|
2409
|
-
* returned if the collaboration creator sets a <code>TRUE</code> value for more than one
|
|
2410
|
-
* member in the collaboration. </p>
|
|
2411
|
-
* <p>If the collaboration creator hasn't specified anyone as the member paying for query
|
|
2412
|
-
* compute costs, then the member who can query is the default payer. An error is returned if
|
|
2413
|
-
* the collaboration creator sets a <code>FALSE</code> value for the member who can
|
|
2414
|
-
* query.</p>
|
|
2323
|
+
* <p>Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (<code>TRUE</code>) or has not configured the collaboration member to pay for query compute costs (<code>FALSE</code>).</p> <p>Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a <code>TRUE</code> value for more than one member in the collaboration. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a <code>FALSE</code> value for the member who can query.</p>
|
|
2415
2324
|
* @public
|
|
2416
2325
|
*/
|
|
2417
2326
|
isResponsible: boolean | undefined;
|
|
2418
2327
|
}
|
|
2419
2328
|
/**
|
|
2420
|
-
* <p>An object representing the collaboration member's payment responsibilities set by the
|
|
2421
|
-
* collaboration creator.</p>
|
|
2329
|
+
* <p>An object representing the collaboration member's payment responsibilities set by the collaboration creator.</p>
|
|
2422
2330
|
* @public
|
|
2423
2331
|
*/
|
|
2424
2332
|
export interface PaymentConfiguration {
|
|
2425
2333
|
/**
|
|
2426
|
-
* <p>The collaboration member's payment responsibilities set by the collaboration creator for
|
|
2427
|
-
* query compute costs.</p>
|
|
2334
|
+
* <p>The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.</p>
|
|
2428
2335
|
* @public
|
|
2429
2336
|
*/
|
|
2430
2337
|
queryCompute: QueryComputePaymentConfig | undefined;
|
|
2431
2338
|
/**
|
|
2432
|
-
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the
|
|
2433
|
-
* collaboration creator.</p>
|
|
2339
|
+
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
2434
2340
|
* @public
|
|
2435
2341
|
*/
|
|
2436
2342
|
machineLearning?: MLPaymentConfig | undefined;
|
|
@@ -2446,27 +2352,22 @@ export interface PaymentConfiguration {
|
|
|
2446
2352
|
*/
|
|
2447
2353
|
export interface DataEncryptionMetadata {
|
|
2448
2354
|
/**
|
|
2449
|
-
* <p>Indicates whether encrypted tables can contain cleartext data (<code>TRUE</code>) or are
|
|
2450
|
-
* to cryptographically process every column (<code>FALSE</code>).</p>
|
|
2355
|
+
* <p>Indicates whether encrypted tables can contain cleartext data (<code>TRUE</code>) or are to cryptographically process every column (<code>FALSE</code>).</p>
|
|
2451
2356
|
* @public
|
|
2452
2357
|
*/
|
|
2453
2358
|
allowCleartext: boolean | undefined;
|
|
2454
2359
|
/**
|
|
2455
|
-
* <p>Indicates whether Fingerprint columns can contain duplicate entries (<code>TRUE</code>)
|
|
2456
|
-
* or are to contain only non-repeated values (<code>FALSE</code>).</p>
|
|
2360
|
+
* <p>Indicates whether Fingerprint columns can contain duplicate entries (<code>TRUE</code>) or are to contain only non-repeated values (<code>FALSE</code>).</p>
|
|
2457
2361
|
* @public
|
|
2458
2362
|
*/
|
|
2459
2363
|
allowDuplicates: boolean | undefined;
|
|
2460
2364
|
/**
|
|
2461
|
-
* <p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with
|
|
2462
|
-
* a different name (<code>TRUE</code>) or can only be joined on Fingerprint columns of the
|
|
2463
|
-
* same name (<code>FALSE</code>).</p>
|
|
2365
|
+
* <p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (<code>TRUE</code>) or can only be joined on Fingerprint columns of the same name (<code>FALSE</code>).</p>
|
|
2464
2366
|
* @public
|
|
2465
2367
|
*/
|
|
2466
2368
|
allowJoinsOnColumnsWithDifferentNames: boolean | undefined;
|
|
2467
2369
|
/**
|
|
2468
|
-
* <p>Indicates whether NULL values are to be copied as NULL to encrypted tables
|
|
2469
|
-
* (<code>TRUE</code>) or cryptographically processed (<code>FALSE</code>).</p>
|
|
2370
|
+
* <p>Indicates whether NULL values are to be copied as NULL to encrypted tables (<code>TRUE</code>) or cryptographically processed (<code>FALSE</code>).</p>
|
|
2470
2371
|
* @public
|
|
2471
2372
|
*/
|
|
2472
2373
|
preserveNulls: boolean | undefined;
|
|
@@ -2489,8 +2390,7 @@ export type CollaborationJobLogStatus = (typeof CollaborationJobLogStatus)[keyof
|
|
|
2489
2390
|
*/
|
|
2490
2391
|
export interface MemberSpecification {
|
|
2491
2392
|
/**
|
|
2492
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
2493
|
-
* Amazon Web Services account ID.</p>
|
|
2393
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
2494
2394
|
* @public
|
|
2495
2395
|
*/
|
|
2496
2396
|
accountId: string | undefined;
|
|
@@ -2510,9 +2410,7 @@ export interface MemberSpecification {
|
|
|
2510
2410
|
*/
|
|
2511
2411
|
displayName: string | undefined;
|
|
2512
2412
|
/**
|
|
2513
|
-
* <p>The collaboration member's payment responsibilities set by the collaboration creator. </p>
|
|
2514
|
-
* <p>If the collaboration creator hasn't specified anyone as the member paying for query
|
|
2515
|
-
* compute costs, then the member who can query is the default payer.</p>
|
|
2413
|
+
* <p>The collaboration member's payment responsibilities set by the collaboration creator. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.</p>
|
|
2516
2414
|
* @public
|
|
2517
2415
|
*/
|
|
2518
2416
|
paymentConfiguration?: PaymentConfiguration | undefined;
|
|
@@ -2564,40 +2462,27 @@ export interface CreateCollaborationInput {
|
|
|
2564
2462
|
*/
|
|
2565
2463
|
creatorDisplayName: string | undefined;
|
|
2566
2464
|
/**
|
|
2567
|
-
* <p>The settings for client-side encryption with Cryptographic Computing for Clean
|
|
2568
|
-
* Rooms.</p>
|
|
2465
|
+
* <p>The settings for client-side encryption with Cryptographic Computing for Clean Rooms.</p>
|
|
2569
2466
|
* @public
|
|
2570
2467
|
*/
|
|
2571
2468
|
dataEncryptionMetadata?: DataEncryptionMetadata | undefined;
|
|
2572
2469
|
/**
|
|
2573
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
2574
|
-
* collaboration.</p>
|
|
2575
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this
|
|
2576
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
2577
|
-
* <code>DISABLED</code>.</p>
|
|
2470
|
+
* <p>An indicator as to whether query logging has been enabled or disabled for the collaboration.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
2578
2471
|
* @public
|
|
2579
2472
|
*/
|
|
2580
2473
|
queryLogStatus: CollaborationQueryLogStatus | undefined;
|
|
2581
2474
|
/**
|
|
2582
|
-
* <p>Specifies whether job logs are enabled for this collaboration. </p>
|
|
2583
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this
|
|
2584
|
-
* collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
2585
|
-
* <code>DISABLED</code>.</p>
|
|
2475
|
+
* <p>Specifies whether job logs are enabled for this collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
2586
2476
|
* @public
|
|
2587
2477
|
*/
|
|
2588
2478
|
jobLogStatus?: CollaborationJobLogStatus | undefined;
|
|
2589
2479
|
/**
|
|
2590
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
2591
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
2592
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
2593
|
-
* to this resource.</p>
|
|
2480
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
2594
2481
|
* @public
|
|
2595
2482
|
*/
|
|
2596
2483
|
tags?: Record<string, string> | undefined;
|
|
2597
2484
|
/**
|
|
2598
|
-
* <p>The collaboration creator's payment responsibilities set by the collaboration creator. </p>
|
|
2599
|
-
* <p>If the collaboration creator hasn't specified anyone as the member paying for query
|
|
2600
|
-
* compute costs, then the member who can query is the default payer.</p>
|
|
2485
|
+
* <p>The collaboration creator's payment responsibilities set by the collaboration creator. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.</p>
|
|
2601
2486
|
* @public
|
|
2602
2487
|
*/
|
|
2603
2488
|
creatorPaymentConfiguration?: PaymentConfiguration | undefined;
|
|
@@ -2622,8 +2507,7 @@ export declare const MemberStatus: {
|
|
|
2622
2507
|
*/
|
|
2623
2508
|
export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
|
|
2624
2509
|
/**
|
|
2625
|
-
* <p>The multi-party data share environment. The collaboration contains metadata about its
|
|
2626
|
-
* purpose and participants.</p>
|
|
2510
|
+
* <p>The multi-party data share environment. The collaboration contains metadata about its purpose and participants.</p>
|
|
2627
2511
|
* @public
|
|
2628
2512
|
*/
|
|
2629
2513
|
export interface Collaboration {
|
|
@@ -2638,8 +2522,7 @@ export interface Collaboration {
|
|
|
2638
2522
|
*/
|
|
2639
2523
|
arn: string | undefined;
|
|
2640
2524
|
/**
|
|
2641
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
2642
|
-
* unique.</p>
|
|
2525
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
2643
2526
|
* @public
|
|
2644
2527
|
*/
|
|
2645
2528
|
name: string | undefined;
|
|
@@ -2649,8 +2532,7 @@ export interface Collaboration {
|
|
|
2649
2532
|
*/
|
|
2650
2533
|
description?: string | undefined;
|
|
2651
2534
|
/**
|
|
2652
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
2653
|
-
* Amazon Web Services account ID.</p>
|
|
2535
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
2654
2536
|
* @public
|
|
2655
2537
|
*/
|
|
2656
2538
|
creatorAccountId: string | undefined;
|
|
@@ -2690,20 +2572,12 @@ export interface Collaboration {
|
|
|
2690
2572
|
*/
|
|
2691
2573
|
dataEncryptionMetadata?: DataEncryptionMetadata | undefined;
|
|
2692
2574
|
/**
|
|
2693
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
2694
|
-
* collaboration.</p>
|
|
2695
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this
|
|
2696
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
2697
|
-
* <code>DISABLED</code>.</p>
|
|
2575
|
+
* <p>An indicator as to whether query logging has been enabled or disabled for the collaboration.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
2698
2576
|
* @public
|
|
2699
2577
|
*/
|
|
2700
2578
|
queryLogStatus: CollaborationQueryLogStatus | undefined;
|
|
2701
2579
|
/**
|
|
2702
|
-
* <p>An indicator as to whether job logging has been enabled or disabled
|
|
2703
|
-
* for the collaboration. </p>
|
|
2704
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this
|
|
2705
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
2706
|
-
* <code>DISABLED</code>.</p>
|
|
2580
|
+
* <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
2707
2581
|
* @public
|
|
2708
2582
|
*/
|
|
2709
2583
|
jobLogStatus?: CollaborationJobLogStatus | undefined;
|
|
@@ -2783,14 +2657,12 @@ export interface GetCollaborationOutput {
|
|
|
2783
2657
|
*/
|
|
2784
2658
|
export interface GetCollaborationAnalysisTemplateInput {
|
|
2785
2659
|
/**
|
|
2786
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
2787
|
-
* Currently accepts collaboration ID.</p>
|
|
2660
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
2788
2661
|
* @public
|
|
2789
2662
|
*/
|
|
2790
2663
|
collaborationIdentifier: string | undefined;
|
|
2791
2664
|
/**
|
|
2792
|
-
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a
|
|
2793
|
-
* collaboration.</p>
|
|
2665
|
+
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
|
|
2794
2666
|
* @public
|
|
2795
2667
|
*/
|
|
2796
2668
|
analysisTemplateArn: string | undefined;
|
|
@@ -2907,8 +2779,7 @@ export interface GetCollaborationIdNamespaceAssociationInput {
|
|
|
2907
2779
|
*/
|
|
2908
2780
|
export interface IdMappingConfig {
|
|
2909
2781
|
/**
|
|
2910
|
-
* <p>An indicator as to whether you can use your column as a dimension column in the ID mapping table (<code>TRUE</code>) or not (<code>FALSE</code>).</p>
|
|
2911
|
-
* <p>Default is <code>FALSE</code>.</p>
|
|
2782
|
+
* <p>An indicator as to whether you can use your column as a dimension column in the ID mapping table (<code>TRUE</code>) or not (<code>FALSE</code>).</p> <p>Default is <code>FALSE</code>.</p>
|
|
2912
2783
|
* @public
|
|
2913
2784
|
*/
|
|
2914
2785
|
allowUseAsDimensionColumn: boolean | undefined;
|
|
@@ -2924,8 +2795,7 @@ export interface IdNamespaceAssociationInputReferenceConfig {
|
|
|
2924
2795
|
*/
|
|
2925
2796
|
inputReferenceArn: string | undefined;
|
|
2926
2797
|
/**
|
|
2927
|
-
* <p>When <code>TRUE</code>, Clean Rooms manages permissions for the ID namespace association resource.</p>
|
|
2928
|
-
* <p>When <code>FALSE</code>, the resource owner manages permissions for the ID namespace association resource.</p>
|
|
2798
|
+
* <p>When <code>TRUE</code>, Clean Rooms manages permissions for the ID namespace association resource.</p> <p>When <code>FALSE</code>, the resource owner manages permissions for the ID namespace association resource.</p>
|
|
2929
2799
|
* @public
|
|
2930
2800
|
*/
|
|
2931
2801
|
manageResourcePolicies: boolean | undefined;
|
|
@@ -3152,10 +3022,7 @@ export interface CollaborationPrivacyBudgetTemplate {
|
|
|
3152
3022
|
*/
|
|
3153
3023
|
privacyBudgetType: PrivacyBudgetType | undefined;
|
|
3154
3024
|
/**
|
|
3155
|
-
* <p>How often the privacy budget refreshes.</p>
|
|
3156
|
-
* <important>
|
|
3157
|
-
* <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p>
|
|
3158
|
-
* </important>
|
|
3025
|
+
* <p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p> </important>
|
|
3159
3026
|
* @public
|
|
3160
3027
|
*/
|
|
3161
3028
|
autoRefresh: PrivacyBudgetTemplateAutoRefresh | undefined;
|
|
@@ -3180,8 +3047,7 @@ export interface GetCollaborationPrivacyBudgetTemplateOutput {
|
|
|
3180
3047
|
*/
|
|
3181
3048
|
export interface GetSchemaInput {
|
|
3182
3049
|
/**
|
|
3183
|
-
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
3184
|
-
* a collaboration ID.</p>
|
|
3050
|
+
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>
|
|
3185
3051
|
* @public
|
|
3186
3052
|
*/
|
|
3187
3053
|
collaborationIdentifier: string | undefined;
|
|
@@ -3206,8 +3072,7 @@ export interface GetSchemaOutput {
|
|
|
3206
3072
|
*/
|
|
3207
3073
|
export interface GetSchemaAnalysisRuleInput {
|
|
3208
3074
|
/**
|
|
3209
|
-
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
3210
|
-
* a collaboration ID.</p>
|
|
3075
|
+
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>
|
|
3211
3076
|
* @public
|
|
3212
3077
|
*/
|
|
3213
3078
|
collaborationIdentifier: string | undefined;
|
|
@@ -3217,8 +3082,7 @@ export interface GetSchemaAnalysisRuleInput {
|
|
|
3217
3082
|
*/
|
|
3218
3083
|
name: string | undefined;
|
|
3219
3084
|
/**
|
|
3220
|
-
* <p>The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely
|
|
3221
|
-
* identified by a combination of the collaboration, the schema name, and their type.</p>
|
|
3085
|
+
* <p>The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.</p>
|
|
3222
3086
|
* @public
|
|
3223
3087
|
*/
|
|
3224
3088
|
type: AnalysisRuleType | undefined;
|
|
@@ -3238,8 +3102,7 @@ export interface GetSchemaAnalysisRuleOutput {
|
|
|
3238
3102
|
*/
|
|
3239
3103
|
export interface ListCollaborationAnalysisTemplatesInput {
|
|
3240
3104
|
/**
|
|
3241
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
3242
|
-
* Currently accepts collaboration ID.</p>
|
|
3105
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
3243
3106
|
* @public
|
|
3244
3107
|
*/
|
|
3245
3108
|
collaborationIdentifier: string | undefined;
|
|
@@ -3249,8 +3112,7 @@ export interface ListCollaborationAnalysisTemplatesInput {
|
|
|
3249
3112
|
*/
|
|
3250
3113
|
nextToken?: string | undefined;
|
|
3251
3114
|
/**
|
|
3252
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3253
|
-
* `maxResults` value has not been met.</p>
|
|
3115
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3254
3116
|
* @public
|
|
3255
3117
|
*/
|
|
3256
3118
|
maxResults?: number | undefined;
|
|
@@ -3266,8 +3128,7 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
3266
3128
|
*/
|
|
3267
3129
|
arn: string | undefined;
|
|
3268
3130
|
/**
|
|
3269
|
-
* <p>The time that the summary of the analysis template in a collaboration was
|
|
3270
|
-
* created.</p>
|
|
3131
|
+
* <p>The time that the summary of the analysis template in a collaboration was created.</p>
|
|
3271
3132
|
* @public
|
|
3272
3133
|
*/
|
|
3273
3134
|
createTime: Date | undefined;
|
|
@@ -3282,8 +3143,7 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
3282
3143
|
*/
|
|
3283
3144
|
name: string | undefined;
|
|
3284
3145
|
/**
|
|
3285
|
-
* <p>The time that the summary of the analysis template in the collaboration was last
|
|
3286
|
-
* updated.</p>
|
|
3146
|
+
* <p>The time that the summary of the analysis template in the collaboration was last updated.</p>
|
|
3287
3147
|
* @public
|
|
3288
3148
|
*/
|
|
3289
3149
|
updateTime: Date | undefined;
|
|
@@ -3293,14 +3153,12 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
3293
3153
|
*/
|
|
3294
3154
|
collaborationArn: string | undefined;
|
|
3295
3155
|
/**
|
|
3296
|
-
* <p>A unique identifier for the collaboration that the analysis templates belong to.
|
|
3297
|
-
* Currently accepts collaboration ID.</p>
|
|
3156
|
+
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
3298
3157
|
* @public
|
|
3299
3158
|
*/
|
|
3300
3159
|
collaborationId: string | undefined;
|
|
3301
3160
|
/**
|
|
3302
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
3303
|
-
* Amazon Web Services account ID.</p>
|
|
3161
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
3304
3162
|
* @public
|
|
3305
3163
|
*/
|
|
3306
3164
|
creatorAccountId: string | undefined;
|
|
@@ -3340,8 +3198,7 @@ export interface ListCollaborationConfiguredAudienceModelAssociationsInput {
|
|
|
3340
3198
|
*/
|
|
3341
3199
|
nextToken?: string | undefined;
|
|
3342
3200
|
/**
|
|
3343
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3344
|
-
* `maxResults` value has not been met.</p>
|
|
3201
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3345
3202
|
* @public
|
|
3346
3203
|
*/
|
|
3347
3204
|
maxResults?: number | undefined;
|
|
@@ -3534,8 +3391,7 @@ export interface ListCollaborationPrivacyBudgetsInput {
|
|
|
3534
3391
|
*/
|
|
3535
3392
|
privacyBudgetType: PrivacyBudgetType | undefined;
|
|
3536
3393
|
/**
|
|
3537
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3538
|
-
* `maxResults` value has not been met.</p>
|
|
3394
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3539
3395
|
* @public
|
|
3540
3396
|
*/
|
|
3541
3397
|
maxResults?: number | undefined;
|
|
@@ -3713,8 +3569,7 @@ export interface ListCollaborationPrivacyBudgetTemplatesInput {
|
|
|
3713
3569
|
*/
|
|
3714
3570
|
nextToken?: string | undefined;
|
|
3715
3571
|
/**
|
|
3716
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3717
|
-
* `maxResults` value has not been met.</p>
|
|
3572
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3718
3573
|
* @public
|
|
3719
3574
|
*/
|
|
3720
3575
|
maxResults?: number | undefined;
|
|
@@ -3802,8 +3657,7 @@ export interface ListCollaborationsInput {
|
|
|
3802
3657
|
*/
|
|
3803
3658
|
nextToken?: string | undefined;
|
|
3804
3659
|
/**
|
|
3805
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3806
|
-
* `maxResults` value has not been met.</p>
|
|
3660
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3807
3661
|
* @public
|
|
3808
3662
|
*/
|
|
3809
3663
|
maxResults?: number | undefined;
|
|
@@ -3829,14 +3683,12 @@ export interface CollaborationSummary {
|
|
|
3829
3683
|
*/
|
|
3830
3684
|
arn: string | undefined;
|
|
3831
3685
|
/**
|
|
3832
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
3833
|
-
* unique.</p>
|
|
3686
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
3834
3687
|
* @public
|
|
3835
3688
|
*/
|
|
3836
3689
|
name: string | undefined;
|
|
3837
3690
|
/**
|
|
3838
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
3839
|
-
* Amazon Web Services account ID.</p>
|
|
3691
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
3840
3692
|
* @public
|
|
3841
3693
|
*/
|
|
3842
3694
|
creatorAccountId: string | undefined;
|
|
@@ -3906,8 +3758,7 @@ export interface ListMembersInput {
|
|
|
3906
3758
|
*/
|
|
3907
3759
|
nextToken?: string | undefined;
|
|
3908
3760
|
/**
|
|
3909
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
3910
|
-
* `maxResults` value has not been met.</p>
|
|
3761
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
3911
3762
|
* @public
|
|
3912
3763
|
*/
|
|
3913
3764
|
maxResults?: number | undefined;
|
|
@@ -3918,8 +3769,7 @@ export interface ListMembersInput {
|
|
|
3918
3769
|
*/
|
|
3919
3770
|
export interface MemberSummary {
|
|
3920
3771
|
/**
|
|
3921
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
3922
|
-
* Amazon Web Services account ID.</p>
|
|
3772
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
3923
3773
|
* @public
|
|
3924
3774
|
*/
|
|
3925
3775
|
accountId: string | undefined;
|
|
@@ -3989,8 +3839,7 @@ export interface ListMembersOutput {
|
|
|
3989
3839
|
*/
|
|
3990
3840
|
export interface ListSchemasInput {
|
|
3991
3841
|
/**
|
|
3992
|
-
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
3993
|
-
* a collaboration ID.</p>
|
|
3842
|
+
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>
|
|
3994
3843
|
* @public
|
|
3995
3844
|
*/
|
|
3996
3845
|
collaborationIdentifier: string | undefined;
|
|
@@ -4005,8 +3854,7 @@ export interface ListSchemasInput {
|
|
|
4005
3854
|
*/
|
|
4006
3855
|
nextToken?: string | undefined;
|
|
4007
3856
|
/**
|
|
4008
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
4009
|
-
* `maxResults` value has not been met.</p>
|
|
3857
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
4010
3858
|
* @public
|
|
4011
3859
|
*/
|
|
4012
3860
|
maxResults?: number | undefined;
|
|
@@ -4057,13 +3905,7 @@ export interface SchemaSummary {
|
|
|
4057
3905
|
*/
|
|
4058
3906
|
analysisRuleTypes: AnalysisRuleType[] | undefined;
|
|
4059
3907
|
/**
|
|
4060
|
-
* <p>The analysis method for the associated schema.</p>
|
|
4061
|
-
* <p>
|
|
4062
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
4063
|
-
* <p>
|
|
4064
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
4065
|
-
* <p>
|
|
4066
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
3908
|
+
* <p>The analysis method for the associated schema.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
4067
3909
|
* @public
|
|
4068
3910
|
*/
|
|
4069
3911
|
analysisMethod?: AnalysisMethod | undefined;
|
|
@@ -4098,8 +3940,7 @@ export interface UpdateCollaborationInput {
|
|
|
4098
3940
|
*/
|
|
4099
3941
|
collaborationIdentifier: string | undefined;
|
|
4100
3942
|
/**
|
|
4101
|
-
* <p>A human-readable identifier provided by the collaboration owner. Display names are not
|
|
4102
|
-
* unique.</p>
|
|
3943
|
+
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
4103
3944
|
* @public
|
|
4104
3945
|
*/
|
|
4105
3946
|
name?: string | undefined;
|
|
@@ -4129,9 +3970,7 @@ export interface UpdateCollaborationOutput {
|
|
|
4129
3970
|
*/
|
|
4130
3971
|
export interface CreateConfiguredAudienceModelAssociationInput {
|
|
4131
3972
|
/**
|
|
4132
|
-
* <p>A unique identifier for one of your memberships for a collaboration. The configured
|
|
4133
|
-
* audience model is associated to the collaboration that this membership belongs to. Accepts
|
|
4134
|
-
* a membership ID.</p>
|
|
3973
|
+
* <p>A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.</p>
|
|
4135
3974
|
* @public
|
|
4136
3975
|
*/
|
|
4137
3976
|
membershipIdentifier: string | undefined;
|
|
@@ -4146,16 +3985,12 @@ export interface CreateConfiguredAudienceModelAssociationInput {
|
|
|
4146
3985
|
*/
|
|
4147
3986
|
configuredAudienceModelAssociationName: string | undefined;
|
|
4148
3987
|
/**
|
|
4149
|
-
* <p>When <code>TRUE</code>, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When <code>FALSE</code>, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.</p>
|
|
4150
|
-
* <p>Setting this to <code>TRUE</code> requires you to have permissions to create, update, and delete the resource policy for the <code>cleanrooms-ml</code> resource when you call the <a>DeleteConfiguredAudienceModelAssociation</a> resource. In addition, if you are the collaboration creator and specify <code>TRUE</code>, you must have the same permissions when you call the <a>DeleteMember</a> and <a>DeleteCollaboration</a> APIs.</p>
|
|
3988
|
+
* <p>When <code>TRUE</code>, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When <code>FALSE</code>, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.</p> <p>Setting this to <code>TRUE</code> requires you to have permissions to create, update, and delete the resource policy for the <code>cleanrooms-ml</code> resource when you call the <a>DeleteConfiguredAudienceModelAssociation</a> resource. In addition, if you are the collaboration creator and specify <code>TRUE</code>, you must have the same permissions when you call the <a>DeleteMember</a> and <a>DeleteCollaboration</a> APIs.</p>
|
|
4151
3989
|
* @public
|
|
4152
3990
|
*/
|
|
4153
3991
|
manageResourcePolicies: boolean | undefined;
|
|
4154
3992
|
/**
|
|
4155
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
4156
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
4157
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
4158
|
-
* to this resource.</p>
|
|
3993
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
4159
3994
|
* @public
|
|
4160
3995
|
*/
|
|
4161
3996
|
tags?: Record<string, string> | undefined;
|
|
@@ -4301,8 +4136,7 @@ export interface ListConfiguredAudienceModelAssociationsInput {
|
|
|
4301
4136
|
*/
|
|
4302
4137
|
nextToken?: string | undefined;
|
|
4303
4138
|
/**
|
|
4304
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
4305
|
-
* `maxResults` value has not been met.</p>
|
|
4139
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
4306
4140
|
* @public
|
|
4307
4141
|
*/
|
|
4308
4142
|
maxResults?: number | undefined;
|
|
@@ -4423,8 +4257,7 @@ export interface UpdateConfiguredAudienceModelAssociationOutput {
|
|
|
4423
4257
|
*/
|
|
4424
4258
|
export interface CreateConfiguredTableAssociationInput {
|
|
4425
4259
|
/**
|
|
4426
|
-
* <p>The name of the configured table association. This name is used to query the underlying
|
|
4427
|
-
* configured table.</p>
|
|
4260
|
+
* <p>The name of the configured table association. This name is used to query the underlying configured table.</p>
|
|
4428
4261
|
* @public
|
|
4429
4262
|
*/
|
|
4430
4263
|
name: string | undefined;
|
|
@@ -4434,15 +4267,12 @@ export interface CreateConfiguredTableAssociationInput {
|
|
|
4434
4267
|
*/
|
|
4435
4268
|
description?: string | undefined;
|
|
4436
4269
|
/**
|
|
4437
|
-
* <p>A unique identifier for one of your memberships for a collaboration. The configured
|
|
4438
|
-
* table is associated to the collaboration that this membership belongs to. Currently accepts
|
|
4439
|
-
* a membership ID.</p>
|
|
4270
|
+
* <p>A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.</p>
|
|
4440
4271
|
* @public
|
|
4441
4272
|
*/
|
|
4442
4273
|
membershipIdentifier: string | undefined;
|
|
4443
4274
|
/**
|
|
4444
|
-
* <p>A unique identifier for the configured table to be associated to. Currently accepts a
|
|
4445
|
-
* configured table ID.</p>
|
|
4275
|
+
* <p>A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.</p>
|
|
4446
4276
|
* @public
|
|
4447
4277
|
*/
|
|
4448
4278
|
configuredTableIdentifier: string | undefined;
|
|
@@ -4452,10 +4282,7 @@ export interface CreateConfiguredTableAssociationInput {
|
|
|
4452
4282
|
*/
|
|
4453
4283
|
roleArn: string | undefined;
|
|
4454
4284
|
/**
|
|
4455
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
4456
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
4457
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
4458
|
-
* to this resource.</p>
|
|
4285
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
4459
4286
|
* @public
|
|
4460
4287
|
*/
|
|
4461
4288
|
tags?: Record<string, string> | undefined;
|
|
@@ -4514,8 +4341,7 @@ export interface ConfiguredTableAssociation {
|
|
|
4514
4341
|
*/
|
|
4515
4342
|
roleArn: string | undefined;
|
|
4516
4343
|
/**
|
|
4517
|
-
* <p>The name of the configured table association, in lowercase. The table is identified by
|
|
4518
|
-
* this name when running protected queries against the underlying data.</p>
|
|
4344
|
+
* <p>The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.</p>
|
|
4519
4345
|
* @public
|
|
4520
4346
|
*/
|
|
4521
4347
|
name: string | undefined;
|
|
@@ -4555,14 +4381,12 @@ export interface CreateConfiguredTableAssociationOutput {
|
|
|
4555
4381
|
*/
|
|
4556
4382
|
export interface CreateConfiguredTableAssociationAnalysisRuleInput {
|
|
4557
4383
|
/**
|
|
4558
|
-
* <p> A unique identifier for the membership that the configured table association belongs to.
|
|
4559
|
-
* Currently accepts the membership ID.</p>
|
|
4384
|
+
* <p> A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4560
4385
|
* @public
|
|
4561
4386
|
*/
|
|
4562
4387
|
membershipIdentifier: string | undefined;
|
|
4563
4388
|
/**
|
|
4564
|
-
* <p> The unique ID for the configured table association. Currently accepts the
|
|
4565
|
-
* configured table association ID.</p>
|
|
4389
|
+
* <p> The unique ID for the configured table association. Currently accepts the configured table association ID.</p>
|
|
4566
4390
|
* @public
|
|
4567
4391
|
*/
|
|
4568
4392
|
configuredTableAssociationIdentifier: string | undefined;
|
|
@@ -4572,17 +4396,13 @@ export interface CreateConfiguredTableAssociationAnalysisRuleInput {
|
|
|
4572
4396
|
*/
|
|
4573
4397
|
analysisRuleType: ConfiguredTableAssociationAnalysisRuleType | undefined;
|
|
4574
4398
|
/**
|
|
4575
|
-
* <p>The analysis rule policy that was created for the configured table
|
|
4576
|
-
* association.</p>
|
|
4399
|
+
* <p>The analysis rule policy that was created for the configured table association.</p>
|
|
4577
4400
|
* @public
|
|
4578
4401
|
*/
|
|
4579
4402
|
analysisRulePolicy: ConfiguredTableAssociationAnalysisRulePolicy | undefined;
|
|
4580
4403
|
}
|
|
4581
4404
|
/**
|
|
4582
|
-
* <p>An analysis rule for a configured table association. This analysis rule specifies how
|
|
4583
|
-
* data from the table can be used within its associated collaboration. In the console, the
|
|
4584
|
-
* <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the
|
|
4585
|
-
* <i>collaboration analysis rule</i>.</p>
|
|
4405
|
+
* <p>An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the <i>collaboration analysis rule</i>.</p>
|
|
4586
4406
|
* @public
|
|
4587
4407
|
*/
|
|
4588
4408
|
export interface ConfiguredTableAssociationAnalysisRule {
|
|
@@ -4627,9 +4447,7 @@ export interface ConfiguredTableAssociationAnalysisRule {
|
|
|
4627
4447
|
*/
|
|
4628
4448
|
export interface CreateConfiguredTableAssociationAnalysisRuleOutput {
|
|
4629
4449
|
/**
|
|
4630
|
-
* <p>The analysis rule for the configured table association. In the console, the
|
|
4631
|
-
* <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the
|
|
4632
|
-
* <i>collaboration analysis rule</i>.</p>
|
|
4450
|
+
* <p>The analysis rule for the configured table association. In the console, the <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the <i>collaboration analysis rule</i>.</p>
|
|
4633
4451
|
* @public
|
|
4634
4452
|
*/
|
|
4635
4453
|
analysisRule: ConfiguredTableAssociationAnalysisRule | undefined;
|
|
@@ -4639,14 +4457,12 @@ export interface CreateConfiguredTableAssociationAnalysisRuleOutput {
|
|
|
4639
4457
|
*/
|
|
4640
4458
|
export interface DeleteConfiguredTableAssociationInput {
|
|
4641
4459
|
/**
|
|
4642
|
-
* <p>The unique ID for the configured table association to be deleted. Currently accepts the
|
|
4643
|
-
* configured table ID.</p>
|
|
4460
|
+
* <p>The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.</p>
|
|
4644
4461
|
* @public
|
|
4645
4462
|
*/
|
|
4646
4463
|
configuredTableAssociationIdentifier: string | undefined;
|
|
4647
4464
|
/**
|
|
4648
|
-
* <p>A unique identifier for the membership that the configured table association belongs to.
|
|
4649
|
-
* Currently accepts the membership ID.</p>
|
|
4465
|
+
* <p>A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4650
4466
|
* @public
|
|
4651
4467
|
*/
|
|
4652
4468
|
membershipIdentifier: string | undefined;
|
|
@@ -4661,14 +4477,12 @@ export interface DeleteConfiguredTableAssociationOutput {
|
|
|
4661
4477
|
*/
|
|
4662
4478
|
export interface DeleteConfiguredTableAssociationAnalysisRuleInput {
|
|
4663
4479
|
/**
|
|
4664
|
-
* <p> A unique identifier for the membership that the configured table association belongs to.
|
|
4665
|
-
* Currently accepts the membership ID.</p>
|
|
4480
|
+
* <p> A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4666
4481
|
* @public
|
|
4667
4482
|
*/
|
|
4668
4483
|
membershipIdentifier: string | undefined;
|
|
4669
4484
|
/**
|
|
4670
|
-
* <p>The identifier for the configured table association that's related to the analysis rule
|
|
4671
|
-
* that you want to delete.</p>
|
|
4485
|
+
* <p>The identifier for the configured table association that's related to the analysis rule that you want to delete.</p>
|
|
4672
4486
|
* @public
|
|
4673
4487
|
*/
|
|
4674
4488
|
configuredTableAssociationIdentifier: string | undefined;
|
|
@@ -4688,14 +4502,12 @@ export interface DeleteConfiguredTableAssociationAnalysisRuleOutput {
|
|
|
4688
4502
|
*/
|
|
4689
4503
|
export interface GetConfiguredTableAssociationInput {
|
|
4690
4504
|
/**
|
|
4691
|
-
* <p>The unique ID for the configured table association to retrieve. Currently accepts the
|
|
4692
|
-
* configured table ID.</p>
|
|
4505
|
+
* <p>The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.</p>
|
|
4693
4506
|
* @public
|
|
4694
4507
|
*/
|
|
4695
4508
|
configuredTableAssociationIdentifier: string | undefined;
|
|
4696
4509
|
/**
|
|
4697
|
-
* <p>A unique identifier for the membership that the configured table association belongs to.
|
|
4698
|
-
* Currently accepts the membership ID.</p>
|
|
4510
|
+
* <p>A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4699
4511
|
* @public
|
|
4700
4512
|
*/
|
|
4701
4513
|
membershipIdentifier: string | undefined;
|
|
@@ -4715,14 +4527,12 @@ export interface GetConfiguredTableAssociationOutput {
|
|
|
4715
4527
|
*/
|
|
4716
4528
|
export interface GetConfiguredTableAssociationAnalysisRuleInput {
|
|
4717
4529
|
/**
|
|
4718
|
-
* <p> A unique identifier for the membership that the configured table association belongs to.
|
|
4719
|
-
* Currently accepts the membership ID.</p>
|
|
4530
|
+
* <p> A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4720
4531
|
* @public
|
|
4721
4532
|
*/
|
|
4722
4533
|
membershipIdentifier: string | undefined;
|
|
4723
4534
|
/**
|
|
4724
|
-
* <p> The identifier for the configured table association that's related to the analysis
|
|
4725
|
-
* rule.</p>
|
|
4535
|
+
* <p> The identifier for the configured table association that's related to the analysis rule.</p>
|
|
4726
4536
|
* @public
|
|
4727
4537
|
*/
|
|
4728
4538
|
configuredTableAssociationIdentifier: string | undefined;
|
|
@@ -4737,9 +4547,7 @@ export interface GetConfiguredTableAssociationAnalysisRuleInput {
|
|
|
4737
4547
|
*/
|
|
4738
4548
|
export interface GetConfiguredTableAssociationAnalysisRuleOutput {
|
|
4739
4549
|
/**
|
|
4740
|
-
* <p>The analysis rule for the configured table association. In the console, the
|
|
4741
|
-
* <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the
|
|
4742
|
-
* <i>collaboration analysis rule</i>.</p>
|
|
4550
|
+
* <p>The analysis rule for the configured table association. In the console, the <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the <i>collaboration analysis rule</i>.</p>
|
|
4743
4551
|
* @public
|
|
4744
4552
|
*/
|
|
4745
4553
|
analysisRule: ConfiguredTableAssociationAnalysisRule | undefined;
|
|
@@ -4749,8 +4557,7 @@ export interface GetConfiguredTableAssociationAnalysisRuleOutput {
|
|
|
4749
4557
|
*/
|
|
4750
4558
|
export interface ListConfiguredTableAssociationsInput {
|
|
4751
4559
|
/**
|
|
4752
|
-
* <p>A unique identifier for the membership to list configured table associations for.
|
|
4753
|
-
* Currently accepts the membership ID.</p>
|
|
4560
|
+
* <p>A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.</p>
|
|
4754
4561
|
* @public
|
|
4755
4562
|
*/
|
|
4756
4563
|
membershipIdentifier: string | undefined;
|
|
@@ -4760,8 +4567,7 @@ export interface ListConfiguredTableAssociationsInput {
|
|
|
4760
4567
|
*/
|
|
4761
4568
|
nextToken?: string | undefined;
|
|
4762
4569
|
/**
|
|
4763
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
4764
|
-
* `maxResults` value has not been met.</p>
|
|
4570
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
4765
4571
|
* @public
|
|
4766
4572
|
*/
|
|
4767
4573
|
maxResults?: number | undefined;
|
|
@@ -4777,20 +4583,17 @@ export interface ConfiguredTableAssociationSummary {
|
|
|
4777
4583
|
*/
|
|
4778
4584
|
configuredTableId: string | undefined;
|
|
4779
4585
|
/**
|
|
4780
|
-
* <p>The unique ID for the membership that the configured table association belongs
|
|
4781
|
-
* to.</p>
|
|
4586
|
+
* <p>The unique ID for the membership that the configured table association belongs to.</p>
|
|
4782
4587
|
* @public
|
|
4783
4588
|
*/
|
|
4784
4589
|
membershipId: string | undefined;
|
|
4785
4590
|
/**
|
|
4786
|
-
* <p>The unique ARN for the membership that the configured table association belongs
|
|
4787
|
-
* to.</p>
|
|
4591
|
+
* <p>The unique ARN for the membership that the configured table association belongs to.</p>
|
|
4788
4592
|
* @public
|
|
4789
4593
|
*/
|
|
4790
4594
|
membershipArn: string | undefined;
|
|
4791
4595
|
/**
|
|
4792
|
-
* <p>The name of the configured table association. The table is identified by this name when
|
|
4793
|
-
* running Protected Queries against the underlying data.</p>
|
|
4596
|
+
* <p>The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.</p>
|
|
4794
4597
|
* @public
|
|
4795
4598
|
*/
|
|
4796
4599
|
name: string | undefined;
|
|
@@ -4815,8 +4618,7 @@ export interface ConfiguredTableAssociationSummary {
|
|
|
4815
4618
|
*/
|
|
4816
4619
|
arn: string | undefined;
|
|
4817
4620
|
/**
|
|
4818
|
-
* <p>The analysis rule types that are associated with the configured table
|
|
4819
|
-
* associations in this summary. </p>
|
|
4621
|
+
* <p>The analysis rule types that are associated with the configured table associations in this summary. </p>
|
|
4820
4622
|
* @public
|
|
4821
4623
|
*/
|
|
4822
4624
|
analysisRuleTypes?: ConfiguredTableAssociationAnalysisRuleType[] | undefined;
|
|
@@ -4841,14 +4643,12 @@ export interface ListConfiguredTableAssociationsOutput {
|
|
|
4841
4643
|
*/
|
|
4842
4644
|
export interface UpdateConfiguredTableAssociationInput {
|
|
4843
4645
|
/**
|
|
4844
|
-
* <p>The unique identifier for the configured table association to update. Currently accepts
|
|
4845
|
-
* the configured table association ID.</p>
|
|
4646
|
+
* <p>The unique identifier for the configured table association to update. Currently accepts the configured table association ID.</p>
|
|
4846
4647
|
* @public
|
|
4847
4648
|
*/
|
|
4848
4649
|
configuredTableAssociationIdentifier: string | undefined;
|
|
4849
4650
|
/**
|
|
4850
|
-
* <p>The unique ID for the membership that the configured table association belongs
|
|
4851
|
-
* to.</p>
|
|
4651
|
+
* <p>The unique ID for the membership that the configured table association belongs to.</p>
|
|
4852
4652
|
* @public
|
|
4853
4653
|
*/
|
|
4854
4654
|
membershipIdentifier: string | undefined;
|
|
@@ -4878,8 +4678,7 @@ export interface UpdateConfiguredTableAssociationOutput {
|
|
|
4878
4678
|
*/
|
|
4879
4679
|
export interface UpdateConfiguredTableAssociationAnalysisRuleInput {
|
|
4880
4680
|
/**
|
|
4881
|
-
* <p> A unique identifier for the membership that the configured table association belongs to.
|
|
4882
|
-
* Currently accepts the membership ID.</p>
|
|
4681
|
+
* <p> A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>
|
|
4883
4682
|
* @public
|
|
4884
4683
|
*/
|
|
4885
4684
|
membershipIdentifier: string | undefined;
|
|
@@ -4904,9 +4703,7 @@ export interface UpdateConfiguredTableAssociationAnalysisRuleInput {
|
|
|
4904
4703
|
*/
|
|
4905
4704
|
export interface UpdateConfiguredTableAssociationAnalysisRuleOutput {
|
|
4906
4705
|
/**
|
|
4907
|
-
* <p> The updated analysis rule for the configured table association. In the console, the
|
|
4908
|
-
* <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the
|
|
4909
|
-
* <i>collaboration analysis rule</i>.</p>
|
|
4706
|
+
* <p> The updated analysis rule for the configured table association. In the console, the <code>ConfiguredTableAssociationAnalysisRule</code> is referred to as the <i>collaboration analysis rule</i>.</p>
|
|
4910
4707
|
* @public
|
|
4911
4708
|
*/
|
|
4912
4709
|
analysisRule: ConfiguredTableAssociationAnalysisRule | undefined;
|
|
@@ -4938,14 +4735,7 @@ export interface SnowflakeTableSchemaV1 {
|
|
|
4938
4735
|
*/
|
|
4939
4736
|
columnName: string | undefined;
|
|
4940
4737
|
/**
|
|
4941
|
-
* <p> The column's data type. Supported data types: <code>ARRAY</code>, <code>BIGINT</code>,
|
|
4942
|
-
* <code>BOOLEAN</code>, <code>CHAR</code>, <code>DATE</code>,
|
|
4943
|
-
* <code>DECIMAL</code>, <code>DOUBLE</code>, <code>DOUBLE PRECISION</code>,
|
|
4944
|
-
* <code>FLOAT</code>, <code>FLOAT4</code>, <code>INT</code>, <code>INTEGER</code>,
|
|
4945
|
-
* <code>MAP</code>, <code>NUMERIC</code>, <code>NUMBER</code>, <code>REAL</code>,
|
|
4946
|
-
* <code>SMALLINT</code>, <code>STRING</code>, <code>TIMESTAMP</code>,
|
|
4947
|
-
* <code>TIMESTAMP_LTZ</code>, <code>TIMESTAMP_NTZ</code>, <code>DATETIME</code>,
|
|
4948
|
-
* <code>TINYINT</code>, <code>VARCHAR</code>, <code>TEXT</code>, <code>CHARACTER</code>.</p>
|
|
4738
|
+
* <p> The column's data type. Supported data types: <code>ARRAY</code>, <code>BIGINT</code>, <code>BOOLEAN</code>, <code>CHAR</code>, <code>DATE</code>, <code>DECIMAL</code>, <code>DOUBLE</code>, <code>DOUBLE PRECISION</code>, <code>FLOAT</code>, <code>FLOAT4</code>, <code>INT</code>, <code>INTEGER</code>, <code>MAP</code>, <code>NUMERIC</code>, <code>NUMBER</code>, <code>REAL</code>, <code>SMALLINT</code>, <code>STRING</code>, <code>TIMESTAMP</code>, <code>TIMESTAMP_LTZ</code>, <code>TIMESTAMP_NTZ</code>, <code>DATETIME</code>, <code>TINYINT</code>, <code>VARCHAR</code>, <code>TEXT</code>, <code>CHARACTER</code>.</p>
|
|
4949
4739
|
* @public
|
|
4950
4740
|
*/
|
|
4951
4741
|
columnType: string | undefined;
|
|
@@ -5026,8 +4816,7 @@ export type TableReference = TableReference.AthenaMember | TableReference.GlueMe
|
|
|
5026
4816
|
*/
|
|
5027
4817
|
export declare namespace TableReference {
|
|
5028
4818
|
/**
|
|
5029
|
-
* <p>If present, a reference to the Glue table referred to by this table
|
|
5030
|
-
* reference.</p>
|
|
4819
|
+
* <p>If present, a reference to the Glue table referred to by this table reference.</p>
|
|
5031
4820
|
* @public
|
|
5032
4821
|
*/
|
|
5033
4822
|
interface GlueMember {
|
|
@@ -5088,40 +4877,27 @@ export interface CreateConfiguredTableInput {
|
|
|
5088
4877
|
*/
|
|
5089
4878
|
description?: string | undefined;
|
|
5090
4879
|
/**
|
|
5091
|
-
* <p>A reference to the
|
|
5092
|
-
* table
|
|
5093
|
-
* being configured.</p>
|
|
4880
|
+
* <p>A reference to the table being configured.</p>
|
|
5094
4881
|
* @public
|
|
5095
4882
|
*/
|
|
5096
4883
|
tableReference: TableReference | undefined;
|
|
5097
4884
|
/**
|
|
5098
|
-
* <p>The columns of the underlying table that can be used by collaborations or analysis
|
|
5099
|
-
* rules.</p>
|
|
4885
|
+
* <p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>
|
|
5100
4886
|
* @public
|
|
5101
4887
|
*/
|
|
5102
4888
|
allowedColumns: string[] | undefined;
|
|
5103
4889
|
/**
|
|
5104
|
-
* <p>The analysis method allowed for the configured tables.</p>
|
|
5105
|
-
* <p>
|
|
5106
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
5107
|
-
* <p>
|
|
5108
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
5109
|
-
* <p>
|
|
5110
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
4890
|
+
* <p>The analysis method allowed for the configured tables.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5111
4891
|
* @public
|
|
5112
4892
|
*/
|
|
5113
4893
|
analysisMethod: AnalysisMethod | undefined;
|
|
5114
4894
|
/**
|
|
5115
|
-
* <p> The analysis methods to enable for the configured table.
|
|
5116
|
-
* When configured, you must specify at least two analysis methods.</p>
|
|
4895
|
+
* <p> The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.</p>
|
|
5117
4896
|
* @public
|
|
5118
4897
|
*/
|
|
5119
4898
|
selectedAnalysisMethods?: SelectedAnalysisMethod[] | undefined;
|
|
5120
4899
|
/**
|
|
5121
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
5122
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
5123
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
5124
|
-
* to this resource.</p>
|
|
4900
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
5125
4901
|
* @public
|
|
5126
4902
|
*/
|
|
5127
4903
|
tags?: Record<string, string> | undefined;
|
|
@@ -5165,9 +4941,7 @@ export interface ConfiguredTable {
|
|
|
5165
4941
|
*/
|
|
5166
4942
|
description?: string | undefined;
|
|
5167
4943
|
/**
|
|
5168
|
-
* <p>The
|
|
5169
|
-
* table
|
|
5170
|
-
* that this configured table represents.</p>
|
|
4944
|
+
* <p>The table that this configured table represents.</p>
|
|
5171
4945
|
* @public
|
|
5172
4946
|
*/
|
|
5173
4947
|
tableReference: TableReference | undefined;
|
|
@@ -5182,25 +4956,17 @@ export interface ConfiguredTable {
|
|
|
5182
4956
|
*/
|
|
5183
4957
|
updateTime: Date | undefined;
|
|
5184
4958
|
/**
|
|
5185
|
-
* <p>The types of analysis rules associated with this configured table. Currently, only one
|
|
5186
|
-
* analysis rule may be associated with a configured table.</p>
|
|
4959
|
+
* <p>The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.</p>
|
|
5187
4960
|
* @public
|
|
5188
4961
|
*/
|
|
5189
4962
|
analysisRuleTypes: ConfiguredTableAnalysisRuleType[] | undefined;
|
|
5190
4963
|
/**
|
|
5191
|
-
* <p>The analysis method for the configured table.</p>
|
|
5192
|
-
* <p>
|
|
5193
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
5194
|
-
* <p>
|
|
5195
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
5196
|
-
* <p>
|
|
5197
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
4964
|
+
* <p>The analysis method for the configured table.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5198
4965
|
* @public
|
|
5199
4966
|
*/
|
|
5200
4967
|
analysisMethod: AnalysisMethod | undefined;
|
|
5201
4968
|
/**
|
|
5202
|
-
* <p>The columns within the underlying Glue table that can be utilized within
|
|
5203
|
-
* collaborations.</p>
|
|
4969
|
+
* <p>The columns within the underlying Glue table that can be utilized within collaborations.</p>
|
|
5204
4970
|
* @public
|
|
5205
4971
|
*/
|
|
5206
4972
|
allowedColumns: string[] | undefined;
|
|
@@ -5250,8 +5016,7 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
|
5250
5016
|
$unknown?: never;
|
|
5251
5017
|
}
|
|
5252
5018
|
/**
|
|
5253
|
-
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on
|
|
5254
|
-
* their configured tables. It supports differential privacy.</p>
|
|
5019
|
+
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.</p>
|
|
5255
5020
|
* @public
|
|
5256
5021
|
*/
|
|
5257
5022
|
interface CustomMember {
|
|
@@ -5312,8 +5077,7 @@ export declare namespace ConfiguredTableAnalysisRulePolicy {
|
|
|
5312
5077
|
*/
|
|
5313
5078
|
export interface CreateConfiguredTableAnalysisRuleInput {
|
|
5314
5079
|
/**
|
|
5315
|
-
* <p>The identifier for the configured table to create the analysis rule for. Currently
|
|
5316
|
-
* accepts the configured table ID. </p>
|
|
5080
|
+
* <p>The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID. </p>
|
|
5317
5081
|
* @public
|
|
5318
5082
|
*/
|
|
5319
5083
|
configuredTableIdentifier: string | undefined;
|
|
@@ -5329,8 +5093,7 @@ export interface CreateConfiguredTableAnalysisRuleInput {
|
|
|
5329
5093
|
analysisRulePolicy: ConfiguredTableAnalysisRulePolicy | undefined;
|
|
5330
5094
|
}
|
|
5331
5095
|
/**
|
|
5332
|
-
* <p>A configured table analysis rule, which limits how data for this table can be
|
|
5333
|
-
* used.</p>
|
|
5096
|
+
* <p>A configured table analysis rule, which limits how data for this table can be used.</p>
|
|
5334
5097
|
* @public
|
|
5335
5098
|
*/
|
|
5336
5099
|
export interface ConfiguredTableAnalysisRule {
|
|
@@ -5396,14 +5159,12 @@ export interface DeleteConfiguredTableOutput {
|
|
|
5396
5159
|
*/
|
|
5397
5160
|
export interface DeleteConfiguredTableAnalysisRuleInput {
|
|
5398
5161
|
/**
|
|
5399
|
-
* <p>The unique identifier for the configured table that the analysis rule applies to.
|
|
5400
|
-
* Currently accepts the configured table ID.</p>
|
|
5162
|
+
* <p>The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.</p>
|
|
5401
5163
|
* @public
|
|
5402
5164
|
*/
|
|
5403
5165
|
configuredTableIdentifier: string | undefined;
|
|
5404
5166
|
/**
|
|
5405
|
-
* <p>The analysis rule type to be deleted. Configured table analysis rules are uniquely
|
|
5406
|
-
* identified by their configured table identifier and analysis rule type.</p>
|
|
5167
|
+
* <p>The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
5407
5168
|
* @public
|
|
5408
5169
|
*/
|
|
5409
5170
|
analysisRuleType: ConfiguredTableAnalysisRuleType | undefined;
|
|
@@ -5439,14 +5200,12 @@ export interface GetConfiguredTableOutput {
|
|
|
5439
5200
|
*/
|
|
5440
5201
|
export interface GetConfiguredTableAnalysisRuleInput {
|
|
5441
5202
|
/**
|
|
5442
|
-
* <p>The unique identifier for the configured table to retrieve. Currently accepts the
|
|
5443
|
-
* configured table ID.</p>
|
|
5203
|
+
* <p>The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.</p>
|
|
5444
5204
|
* @public
|
|
5445
5205
|
*/
|
|
5446
5206
|
configuredTableIdentifier: string | undefined;
|
|
5447
5207
|
/**
|
|
5448
|
-
* <p>The analysis rule to be retrieved. Configured table analysis rules are uniquely
|
|
5449
|
-
* identified by their configured table identifier and analysis rule type.</p>
|
|
5208
|
+
* <p>The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
5450
5209
|
* @public
|
|
5451
5210
|
*/
|
|
5452
5211
|
analysisRuleType: ConfiguredTableAnalysisRuleType | undefined;
|
|
@@ -5471,8 +5230,7 @@ export interface ListConfiguredTablesInput {
|
|
|
5471
5230
|
*/
|
|
5472
5231
|
nextToken?: string | undefined;
|
|
5473
5232
|
/**
|
|
5474
|
-
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
|
|
5475
|
-
* `maxResults` value has not been met.</p>
|
|
5233
|
+
* <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>
|
|
5476
5234
|
* @public
|
|
5477
5235
|
*/
|
|
5478
5236
|
maxResults?: number | undefined;
|
|
@@ -5513,13 +5271,7 @@ export interface ConfiguredTableSummary {
|
|
|
5513
5271
|
*/
|
|
5514
5272
|
analysisRuleTypes: ConfiguredTableAnalysisRuleType[] | undefined;
|
|
5515
5273
|
/**
|
|
5516
|
-
* <p>The analysis method for the configured tables. </p>
|
|
5517
|
-
* <p>
|
|
5518
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
5519
|
-
* <p>
|
|
5520
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
5521
|
-
* <p>
|
|
5522
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5274
|
+
* <p>The analysis method for the configured tables. </p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5523
5275
|
* @public
|
|
5524
5276
|
*/
|
|
5525
5277
|
analysisMethod: AnalysisMethod | undefined;
|
|
@@ -5549,8 +5301,7 @@ export interface ListConfiguredTablesOutput {
|
|
|
5549
5301
|
*/
|
|
5550
5302
|
export interface UpdateConfiguredTableInput {
|
|
5551
5303
|
/**
|
|
5552
|
-
* <p>The identifier for the configured table to update. Currently accepts the configured
|
|
5553
|
-
* table ID.</p>
|
|
5304
|
+
* <p>The identifier for the configured table to update. Currently accepts the configured table ID.</p>
|
|
5554
5305
|
* @public
|
|
5555
5306
|
*/
|
|
5556
5307
|
configuredTableIdentifier: string | undefined;
|
|
@@ -5565,13 +5316,7 @@ export interface UpdateConfiguredTableInput {
|
|
|
5565
5316
|
*/
|
|
5566
5317
|
description?: string | undefined;
|
|
5567
5318
|
/**
|
|
5568
|
-
* <p> The analysis method for the configured table.</p>
|
|
5569
|
-
* <p>
|
|
5570
|
-
* <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p>
|
|
5571
|
-
* <p>
|
|
5572
|
-
* <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p>
|
|
5573
|
-
* <p>
|
|
5574
|
-
* <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5319
|
+
* <p> The analysis method for the configured table.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
|
|
5575
5320
|
* @public
|
|
5576
5321
|
*/
|
|
5577
5322
|
analysisMethod?: AnalysisMethod | undefined;
|
|
@@ -5596,14 +5341,12 @@ export interface UpdateConfiguredTableOutput {
|
|
|
5596
5341
|
*/
|
|
5597
5342
|
export interface UpdateConfiguredTableAnalysisRuleInput {
|
|
5598
5343
|
/**
|
|
5599
|
-
* <p>The unique identifier for the configured table that the analysis rule applies to.
|
|
5600
|
-
* Currently accepts the configured table ID.</p>
|
|
5344
|
+
* <p>The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.</p>
|
|
5601
5345
|
* @public
|
|
5602
5346
|
*/
|
|
5603
5347
|
configuredTableIdentifier: string | undefined;
|
|
5604
5348
|
/**
|
|
5605
|
-
* <p>The analysis rule type to be updated. Configured table analysis rules are uniquely
|
|
5606
|
-
* identified by their configured table identifier and analysis rule type.</p>
|
|
5349
|
+
* <p>The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
5607
5350
|
* @public
|
|
5608
5351
|
*/
|
|
5609
5352
|
analysisRuleType: ConfiguredTableAnalysisRuleType | undefined;
|
|
@@ -5634,8 +5377,7 @@ export interface IdMappingTableInputReferenceConfig {
|
|
|
5634
5377
|
*/
|
|
5635
5378
|
inputReferenceArn: string | undefined;
|
|
5636
5379
|
/**
|
|
5637
|
-
* <p>When <code>TRUE</code>, Clean Rooms manages permissions for the ID mapping table resource. </p>
|
|
5638
|
-
* <p>When <code>FALSE</code>, the resource owner manages permissions for the ID mapping table resource.</p>
|
|
5380
|
+
* <p>When <code>TRUE</code>, Clean Rooms manages permissions for the ID mapping table resource. </p> <p>When <code>FALSE</code>, the resource owner manages permissions for the ID mapping table resource.</p>
|
|
5639
5381
|
* @public
|
|
5640
5382
|
*/
|
|
5641
5383
|
manageResourcePolicies: boolean | undefined;
|
|
@@ -5665,10 +5407,7 @@ export interface CreateIdMappingTableInput {
|
|
|
5665
5407
|
*/
|
|
5666
5408
|
inputReferenceConfig: IdMappingTableInputReferenceConfig | undefined;
|
|
5667
5409
|
/**
|
|
5668
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
5669
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
5670
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
5671
|
-
* to this resource.</p>
|
|
5410
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
5672
5411
|
* @public
|
|
5673
5412
|
*/
|
|
5674
5413
|
tags?: Record<string, string> | undefined;
|
|
@@ -5986,10 +5725,7 @@ export interface CreateIdNamespaceAssociationInput {
|
|
|
5986
5725
|
*/
|
|
5987
5726
|
inputReferenceConfig: IdNamespaceAssociationInputReferenceConfig | undefined;
|
|
5988
5727
|
/**
|
|
5989
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
5990
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
5991
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
5992
|
-
* to this resource.</p>
|
|
5728
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
5993
5729
|
* @public
|
|
5994
5730
|
*/
|
|
5995
5731
|
tags?: Record<string, string> | undefined;
|
|
@@ -6281,8 +6017,7 @@ export interface UpdateIdNamespaceAssociationOutput {
|
|
|
6281
6017
|
*/
|
|
6282
6018
|
export interface ListTagsForResourceInput {
|
|
6283
6019
|
/**
|
|
6284
|
-
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags
|
|
6285
|
-
* on.</p>
|
|
6020
|
+
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags on.</p>
|
|
6286
6021
|
* @public
|
|
6287
6022
|
*/
|
|
6288
6023
|
resourceArn: string | undefined;
|
|
@@ -6354,8 +6089,7 @@ export interface MembershipProtectedJobResultConfiguration {
|
|
|
6354
6089
|
*/
|
|
6355
6090
|
outputConfiguration: MembershipProtectedJobOutputConfiguration | undefined;
|
|
6356
6091
|
/**
|
|
6357
|
-
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected
|
|
6358
|
-
* job results to the result location, given by the member who can receive results.</p>
|
|
6092
|
+
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.</p>
|
|
6359
6093
|
* @public
|
|
6360
6094
|
*/
|
|
6361
6095
|
roleArn: string | undefined;
|
|
@@ -6393,9 +6127,7 @@ export interface ProtectedQueryS3OutputConfiguration {
|
|
|
6393
6127
|
*/
|
|
6394
6128
|
keyPrefix?: string | undefined;
|
|
6395
6129
|
/**
|
|
6396
|
-
* <p>Indicates whether files should be output as a single file (<code>TRUE</code>) or output
|
|
6397
|
-
* as multiple files (<code>FALSE</code>). This parameter is only supported for analyses with
|
|
6398
|
-
* the Spark analytics engine.</p>
|
|
6130
|
+
* <p>Indicates whether files should be output as a single file (<code>TRUE</code>) or output as multiple files (<code>FALSE</code>). This parameter is only supported for analyses with the Spark analytics engine.</p>
|
|
6399
6131
|
* @public
|
|
6400
6132
|
*/
|
|
6401
6133
|
singleFileOutput?: boolean | undefined;
|
|
@@ -6441,8 +6173,7 @@ export interface MembershipProtectedQueryResultConfiguration {
|
|
|
6441
6173
|
*/
|
|
6442
6174
|
outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
|
|
6443
6175
|
/**
|
|
6444
|
-
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected
|
|
6445
|
-
* query results to the result location, given by the member who can receive results.</p>
|
|
6176
|
+
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.</p>
|
|
6446
6177
|
* @public
|
|
6447
6178
|
*/
|
|
6448
6179
|
roleArn?: string | undefined;
|
|
@@ -6460,88 +6191,40 @@ export declare const MembershipJobLogStatus: {
|
|
|
6460
6191
|
*/
|
|
6461
6192
|
export type MembershipJobLogStatus = (typeof MembershipJobLogStatus)[keyof typeof MembershipJobLogStatus];
|
|
6462
6193
|
/**
|
|
6463
|
-
* <p>An object representing the payment responsibilities accepted by the
|
|
6464
|
-
* collaboration member for query and job compute costs.</p>
|
|
6194
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.</p>
|
|
6465
6195
|
* @public
|
|
6466
6196
|
*/
|
|
6467
6197
|
export interface MembershipJobComputePaymentConfig {
|
|
6468
6198
|
/**
|
|
6469
|
-
* <p>Indicates whether the collaboration member has accepted to pay for job
|
|
6470
|
-
* compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs
|
|
6471
|
-
* (<code>FALSE</code>).</p>
|
|
6472
|
-
* <p>There is only one member who pays for queries and jobs. </p>
|
|
6473
|
-
* <p>An error message is returned for the following reasons: </p>
|
|
6474
|
-
* <ul>
|
|
6475
|
-
* <li>
|
|
6476
|
-
* <p>If you set the value to <code>FALSE</code> but you are responsible to
|
|
6477
|
-
* pay for query and job compute costs. </p>
|
|
6478
|
-
* </li>
|
|
6479
|
-
* <li>
|
|
6480
|
-
* <p>If you set the value to <code>TRUE</code> but you are not responsible to
|
|
6481
|
-
* pay for query and job compute costs. </p>
|
|
6482
|
-
* </li>
|
|
6483
|
-
* </ul>
|
|
6199
|
+
* <p>Indicates whether the collaboration member has accepted to pay for job compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs (<code>FALSE</code>).</p> <p>There is only one member who pays for queries and jobs. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query and job compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query and job compute costs. </p> </li> </ul>
|
|
6484
6200
|
* @public
|
|
6485
6201
|
*/
|
|
6486
6202
|
isResponsible: boolean | undefined;
|
|
6487
6203
|
}
|
|
6488
6204
|
/**
|
|
6489
|
-
* <p>An object representing the collaboration member's model inference payment responsibilities set by the
|
|
6490
|
-
* collaboration creator.</p>
|
|
6205
|
+
* <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
|
|
6491
6206
|
* @public
|
|
6492
6207
|
*/
|
|
6493
6208
|
export interface MembershipModelInferencePaymentConfig {
|
|
6494
6209
|
/**
|
|
6495
|
-
* <p>Indicates whether the collaboration member has accepted to pay for model inference costs
|
|
6496
|
-
* (<code>TRUE</code>) or has not accepted to pay for model inference costs
|
|
6497
|
-
* (<code>FALSE</code>).</p>
|
|
6498
|
-
* <p>If the collaboration creator has not specified anyone to pay for model inference costs,
|
|
6499
|
-
* then the member who can query is the default payer. </p>
|
|
6500
|
-
* <p>An error message is returned for the following reasons: </p>
|
|
6501
|
-
* <ul>
|
|
6502
|
-
* <li>
|
|
6503
|
-
* <p>If you set the value to <code>FALSE</code> but you are responsible to pay for
|
|
6504
|
-
* model inference costs. </p>
|
|
6505
|
-
* </li>
|
|
6506
|
-
* <li>
|
|
6507
|
-
* <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for
|
|
6508
|
-
* model inference costs. </p>
|
|
6509
|
-
* </li>
|
|
6510
|
-
* </ul>
|
|
6210
|
+
* <p>Indicates whether the collaboration member has accepted to pay for model inference costs (<code>TRUE</code>) or has not accepted to pay for model inference costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model inference costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model inference costs. </p> </li> </ul>
|
|
6511
6211
|
* @public
|
|
6512
6212
|
*/
|
|
6513
6213
|
isResponsible: boolean | undefined;
|
|
6514
6214
|
}
|
|
6515
6215
|
/**
|
|
6516
|
-
* <p>An object representing the collaboration member's model training payment responsibilities set by the
|
|
6517
|
-
* collaboration creator.</p>
|
|
6216
|
+
* <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
|
|
6518
6217
|
* @public
|
|
6519
6218
|
*/
|
|
6520
6219
|
export interface MembershipModelTrainingPaymentConfig {
|
|
6521
6220
|
/**
|
|
6522
|
-
* <p>Indicates whether the collaboration member has accepted to pay for model training costs
|
|
6523
|
-
* (<code>TRUE</code>) or has not accepted to pay for model training costs
|
|
6524
|
-
* (<code>FALSE</code>).</p>
|
|
6525
|
-
* <p>If the collaboration creator has not specified anyone to pay for model training costs,
|
|
6526
|
-
* then the member who can query is the default payer. </p>
|
|
6527
|
-
* <p>An error message is returned for the following reasons: </p>
|
|
6528
|
-
* <ul>
|
|
6529
|
-
* <li>
|
|
6530
|
-
* <p>If you set the value to <code>FALSE</code> but you are responsible to pay for
|
|
6531
|
-
* model training costs. </p>
|
|
6532
|
-
* </li>
|
|
6533
|
-
* <li>
|
|
6534
|
-
* <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for
|
|
6535
|
-
* model training costs. </p>
|
|
6536
|
-
* </li>
|
|
6537
|
-
* </ul>
|
|
6221
|
+
* <p>Indicates whether the collaboration member has accepted to pay for model training costs (<code>TRUE</code>) or has not accepted to pay for model training costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model training costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model training costs. </p> </li> </ul>
|
|
6538
6222
|
* @public
|
|
6539
6223
|
*/
|
|
6540
6224
|
isResponsible: boolean | undefined;
|
|
6541
6225
|
}
|
|
6542
6226
|
/**
|
|
6543
|
-
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the
|
|
6544
|
-
* collaboration creator.</p>
|
|
6227
|
+
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
6545
6228
|
* @public
|
|
6546
6229
|
*/
|
|
6547
6230
|
export interface MembershipMLPaymentConfig {
|
|
@@ -6557,53 +6240,33 @@ export interface MembershipMLPaymentConfig {
|
|
|
6557
6240
|
modelInference?: MembershipModelInferencePaymentConfig | undefined;
|
|
6558
6241
|
}
|
|
6559
6242
|
/**
|
|
6560
|
-
* <p>An object representing the payment responsibilities accepted by the collaboration member
|
|
6561
|
-
* for query compute costs.</p>
|
|
6243
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
6562
6244
|
* @public
|
|
6563
6245
|
*/
|
|
6564
6246
|
export interface MembershipQueryComputePaymentConfig {
|
|
6565
6247
|
/**
|
|
6566
|
-
* <p>Indicates whether the collaboration member has accepted to pay for query compute costs
|
|
6567
|
-
* (<code>TRUE</code>) or has not accepted to pay for query compute costs
|
|
6568
|
-
* (<code>FALSE</code>).</p>
|
|
6569
|
-
* <p>If the collaboration creator has not specified anyone to pay for query compute costs,
|
|
6570
|
-
* then the member who can query is the default payer. </p>
|
|
6571
|
-
* <p>An error message is returned for the following reasons: </p>
|
|
6572
|
-
* <ul>
|
|
6573
|
-
* <li>
|
|
6574
|
-
* <p>If you set the value to <code>FALSE</code> but you are responsible to pay for
|
|
6575
|
-
* query compute costs. </p>
|
|
6576
|
-
* </li>
|
|
6577
|
-
* <li>
|
|
6578
|
-
* <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for
|
|
6579
|
-
* query compute costs. </p>
|
|
6580
|
-
* </li>
|
|
6581
|
-
* </ul>
|
|
6248
|
+
* <p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>
|
|
6582
6249
|
* @public
|
|
6583
6250
|
*/
|
|
6584
6251
|
isResponsible: boolean | undefined;
|
|
6585
6252
|
}
|
|
6586
6253
|
/**
|
|
6587
|
-
* <p>An object representing the payment responsibilities accepted by the collaboration
|
|
6588
|
-
* member.</p>
|
|
6254
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member.</p>
|
|
6589
6255
|
* @public
|
|
6590
6256
|
*/
|
|
6591
6257
|
export interface MembershipPaymentConfiguration {
|
|
6592
6258
|
/**
|
|
6593
|
-
* <p>The payment responsibilities accepted by the collaboration member for query compute
|
|
6594
|
-
* costs.</p>
|
|
6259
|
+
* <p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
6595
6260
|
* @public
|
|
6596
6261
|
*/
|
|
6597
6262
|
queryCompute: MembershipQueryComputePaymentConfig | undefined;
|
|
6598
6263
|
/**
|
|
6599
|
-
* <p>The payment responsibilities accepted by the collaboration member for machine learning
|
|
6600
|
-
* costs.</p>
|
|
6264
|
+
* <p>The payment responsibilities accepted by the collaboration member for machine learning costs.</p>
|
|
6601
6265
|
* @public
|
|
6602
6266
|
*/
|
|
6603
6267
|
machineLearning?: MembershipMLPaymentConfig | undefined;
|
|
6604
6268
|
/**
|
|
6605
|
-
* <p>The payment responsibilities accepted by the collaboration member for job compute
|
|
6606
|
-
* costs.</p>
|
|
6269
|
+
* <p>The payment responsibilities accepted by the collaboration member for job compute costs.</p>
|
|
6607
6270
|
* @public
|
|
6608
6271
|
*/
|
|
6609
6272
|
jobCompute?: MembershipJobComputePaymentConfig | undefined;
|
|
@@ -6630,49 +6293,32 @@ export interface CreateMembershipInput {
|
|
|
6630
6293
|
*/
|
|
6631
6294
|
collaborationIdentifier: string | undefined;
|
|
6632
6295
|
/**
|
|
6633
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
6634
|
-
* membership.</p>
|
|
6635
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this
|
|
6636
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
6637
|
-
* <code>DISABLED</code>.</p>
|
|
6296
|
+
* <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6638
6297
|
* @public
|
|
6639
6298
|
*/
|
|
6640
6299
|
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
6641
6300
|
/**
|
|
6642
|
-
* <p>An indicator as to whether job logging has been enabled or disabled
|
|
6643
|
-
* for the collaboration. </p>
|
|
6644
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this
|
|
6645
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
6646
|
-
* <code>DISABLED</code>.</p>
|
|
6301
|
+
* <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6647
6302
|
* @public
|
|
6648
6303
|
*/
|
|
6649
6304
|
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
6650
6305
|
/**
|
|
6651
|
-
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
6652
|
-
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
6653
|
-
* you can also use tag-based access control in IAM policies to control access
|
|
6654
|
-
* to this resource.</p>
|
|
6306
|
+
* <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
|
|
6655
6307
|
* @public
|
|
6656
6308
|
*/
|
|
6657
6309
|
tags?: Record<string, string> | undefined;
|
|
6658
6310
|
/**
|
|
6659
|
-
* <p>The default protected query result configuration as specified by the member who can
|
|
6660
|
-
* receive results.</p>
|
|
6311
|
+
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
6661
6312
|
* @public
|
|
6662
6313
|
*/
|
|
6663
6314
|
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
6664
6315
|
/**
|
|
6665
|
-
* <p>The default job result configuration that determines how job results are
|
|
6666
|
-
* protected and managed within this membership. This configuration applies to all
|
|
6667
|
-
* jobs.</p>
|
|
6316
|
+
* <p>The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.</p>
|
|
6668
6317
|
* @public
|
|
6669
6318
|
*/
|
|
6670
6319
|
defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
|
|
6671
6320
|
/**
|
|
6672
|
-
* <p>The payment responsibilities accepted by the collaboration member.</p>
|
|
6673
|
-
* <p>Not required if the collaboration member has the member ability to run queries. </p>
|
|
6674
|
-
* <p>Required if the collaboration member doesn't have the member ability to run queries but
|
|
6675
|
-
* is configured as a payer by the collaboration creator. </p>
|
|
6321
|
+
* <p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries. </p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. </p>
|
|
6676
6322
|
* @public
|
|
6677
6323
|
*/
|
|
6678
6324
|
paymentConfiguration?: MembershipPaymentConfiguration | undefined;
|
|
@@ -6716,8 +6362,7 @@ export interface Membership {
|
|
|
6716
6362
|
*/
|
|
6717
6363
|
collaborationId: string | undefined;
|
|
6718
6364
|
/**
|
|
6719
|
-
* <p>The identifier used to reference members of the collaboration. Currently only supports
|
|
6720
|
-
* Amazon Web Services account ID.</p>
|
|
6365
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
6721
6366
|
* @public
|
|
6722
6367
|
*/
|
|
6723
6368
|
collaborationCreatorAccountId: string | undefined;
|
|
@@ -6757,26 +6402,17 @@ export interface Membership {
|
|
|
6757
6402
|
*/
|
|
6758
6403
|
mlMemberAbilities?: MLMemberAbilities | undefined;
|
|
6759
6404
|
/**
|
|
6760
|
-
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
6761
|
-
* membership.</p>
|
|
6762
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this
|
|
6763
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
6764
|
-
* <code>DISABLED</code>.</p>
|
|
6405
|
+
* <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6765
6406
|
* @public
|
|
6766
6407
|
*/
|
|
6767
6408
|
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
6768
6409
|
/**
|
|
6769
|
-
* <p>An indicator as to whether job logging has been enabled or disabled
|
|
6770
|
-
* for the collaboration. </p>
|
|
6771
|
-
* <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this
|
|
6772
|
-
* collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
|
|
6773
|
-
* <code>DISABLED</code>.</p>
|
|
6410
|
+
* <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
|
|
6774
6411
|
* @public
|
|
6775
6412
|
*/
|
|
6776
6413
|
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
6777
6414
|
/**
|
|
6778
|
-
* <p>The default protected query result configuration as specified by the member who can
|
|
6779
|
-
* receive results.</p>
|
|
6415
|
+
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
6780
6416
|
* @public
|
|
6781
6417
|
*/
|
|
6782
6418
|
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
@@ -6884,8 +6520,7 @@ export interface ProtectedJobParameters {
|
|
|
6884
6520
|
*/
|
|
6885
6521
|
export interface ProtectedJobSingleMemberOutput {
|
|
6886
6522
|
/**
|
|
6887
|
-
* <p>The Amazon Web Services account ID of the member in the collaboration who can receive
|
|
6888
|
-
* results from analyses.</p>
|
|
6523
|
+
* <p>The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.</p>
|
|
6889
6524
|
* @public
|
|
6890
6525
|
*/
|
|
6891
6526
|
accountId: string | undefined;
|