@aws-sdk/client-cleanrooms 3.1075.0 → 3.1077.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 +84 -0
- package/dist-cjs/index.js +4668 -19
- package/dist-es/CleanRooms.js +28 -0
- package/dist-es/commands/CreateIntermediateTableAnalysisRuleCommand.js +16 -0
- package/dist-es/commands/CreateIntermediateTableCommand.js +16 -0
- package/dist-es/commands/DeleteIntermediateTableAnalysisRuleCommand.js +16 -0
- package/dist-es/commands/DeleteIntermediateTableCommand.js +16 -0
- package/dist-es/commands/DisallowIntermediateTableCommand.js +16 -0
- package/dist-es/commands/GetIntermediateTableAnalysisRuleCommand.js +16 -0
- package/dist-es/commands/GetIntermediateTableCommand.js +16 -0
- package/dist-es/commands/ListIntermediateTableVersionsCommand.js +16 -0
- package/dist-es/commands/ListIntermediateTablesCommand.js +16 -0
- package/dist-es/commands/PopulateIntermediateTableCommand.js +16 -0
- package/dist-es/commands/UpdateIntermediateTableAnalysisRuleCommand.js +16 -0
- package/dist-es/commands/UpdateIntermediateTableCommand.js +16 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/enums.js +53 -4
- package/dist-es/pagination/ListIntermediateTableVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListIntermediateTablesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/runtimeConfig.browser.js +0 -2
- package/dist-es/runtimeConfig.js +1 -2
- package/dist-es/runtimeConfig.native.js +0 -2
- package/dist-es/runtimeConfig.shared.js +2 -0
- package/dist-es/schemas/schemas_0.js +467 -36
- package/dist-types/CleanRooms.d.ts +98 -0
- package/dist-types/CleanRoomsClient.d.ts +14 -2
- package/dist-types/commands/BatchGetSchemaAnalysisRuleCommand.d.ts +10 -8
- package/dist-types/commands/BatchGetSchemaCommand.d.ts +9 -2
- package/dist-types/commands/CreateCollaborationCommand.d.ts +1 -1
- package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +12 -0
- package/dist-types/commands/CreateConfiguredTableAssociationCommand.d.ts +9 -0
- package/dist-types/commands/CreateIdMappingTableCommand.d.ts +9 -0
- package/dist-types/commands/CreateIntermediateTableAnalysisRuleCommand.d.ts +163 -0
- package/dist-types/commands/CreateIntermediateTableCommand.d.ts +231 -0
- package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIntermediateTableAnalysisRuleCommand.d.ts +94 -0
- package/dist-types/commands/DeleteIntermediateTableCommand.d.ts +93 -0
- package/dist-types/commands/DeleteMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DisallowIntermediateTableCommand.d.ts +94 -0
- package/dist-types/commands/GetConfiguredTableAnalysisRuleCommand.d.ts +6 -0
- package/dist-types/commands/GetConfiguredTableAssociationCommand.d.ts +9 -0
- package/dist-types/commands/GetIdMappingTableCommand.d.ts +9 -0
- package/dist-types/commands/GetIntermediateTableAnalysisRuleCommand.d.ts +128 -0
- package/dist-types/commands/GetIntermediateTableCommand.d.ts +213 -0
- package/dist-types/commands/GetMembershipCommand.d.ts +1 -1
- package/dist-types/commands/GetProtectedJobCommand.d.ts +1 -1
- package/dist-types/commands/GetProtectedQueryCommand.d.ts +6 -2
- package/dist-types/commands/GetSchemaAnalysisRuleCommand.d.ts +10 -8
- package/dist-types/commands/GetSchemaCommand.d.ts +9 -2
- package/dist-types/commands/ListIntermediateTableVersionsCommand.d.ts +106 -0
- package/dist-types/commands/ListIntermediateTablesCommand.d.ts +112 -0
- package/dist-types/commands/ListProtectedQueriesCommand.d.ts +5 -0
- package/dist-types/commands/ListSchemasCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PopulateIntermediateTableCommand.d.ts +115 -0
- package/dist-types/commands/StartProtectedQueryCommand.d.ts +10 -0
- package/dist-types/commands/UpdateConfiguredTableAnalysisRuleCommand.d.ts +12 -0
- package/dist-types/commands/UpdateConfiguredTableAssociationCommand.d.ts +9 -0
- package/dist-types/commands/UpdateIdMappingTableCommand.d.ts +9 -0
- package/dist-types/commands/UpdateIntermediateTableAnalysisRuleCommand.d.ts +161 -0
- package/dist-types/commands/UpdateIntermediateTableCommand.d.ts +221 -0
- package/dist-types/commands/UpdateProtectedQueryCommand.d.ts +5 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/models/enums.d.ts +125 -12
- package/dist-types/models/models_0.d.ts +729 -436
- package/dist-types/models/models_1.d.ts +1032 -3
- package/dist-types/pagination/ListIntermediateTableVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIntermediateTablesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +63 -0
- package/dist-types/ts3.4/CleanRooms.d.ts +236 -0
- package/dist-types/ts3.4/CleanRoomsClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreateIntermediateTableAnalysisRuleCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/CreateIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/CreateMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteIntermediateTableAnalysisRuleCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DisallowIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetIntermediateTableAnalysisRuleCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetProtectedQueryCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListIntermediateTableVersionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListIntermediateTablesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PopulateIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateIntermediateTableAnalysisRuleCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateIntermediateTableCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/enums.d.ts +71 -6
- package/dist-types/ts3.4/models/models_0.d.ts +299 -261
- package/dist-types/ts3.4/models/models_1.d.ts +345 -17
- package/dist-types/ts3.4/pagination/ListIntermediateTableVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListIntermediateTablesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +63 -0
- package/package.json +8 -10
- package/dist-cjs/auth/httpAuthSchemeProvider.js +0 -40
- package/dist-cjs/endpoint/bdd.js +0 -46
- package/dist-cjs/endpoint/endpointResolver.js +0 -14
- package/dist-cjs/models/CleanRoomsServiceException.js +0 -8
- package/dist-cjs/models/errors.js +0 -105
- package/dist-cjs/runtimeConfig.browser.js +0 -32
- package/dist-cjs/runtimeConfig.js +0 -45
- package/dist-cjs/runtimeConfig.native.js +0 -12
- package/dist-cjs/runtimeConfig.shared.js +0 -38
- package/dist-cjs/schemas/schemas_0.js +0 -3580
|
@@ -1,5 +1,992 @@
|
|
|
1
|
-
import type { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, MembershipStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobAnalysisType, ProtectedJobStatus, ProtectedJobType, ProtectedQueryStatus, ProtectedQueryType, TargetProtectedJobStatus, TargetProtectedQueryStatus } from "./enums";
|
|
2
|
-
import type { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters,
|
|
1
|
+
import type { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, MembershipStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobAnalysisType, ProtectedJobStatus, ProtectedJobType, ProtectedJobWorkerComputeType, ProtectedQueryStatus, ProtectedQueryType, ResultFormat, TargetProtectedJobStatus, TargetProtectedQueryStatus } from "./enums";
|
|
2
|
+
import type { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, IntermediateTableAnalysisRule, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateParametersOutput, WorkerComputeConfiguration, WorkerComputeConfigurationProperties } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface UpdateIntermediateTableAnalysisRuleOutput {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The updated analysis rule for the intermediate table.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
analysisRule: IntermediateTableAnalysisRule | undefined;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export interface ListTagsForResourceInput {
|
|
17
|
+
/**
|
|
18
|
+
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags on.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
resourceArn: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export interface ListTagsForResourceOutput {
|
|
27
|
+
/**
|
|
28
|
+
* <p>A map of objects specifying each key name and value.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
tags: Record<string, string> | undefined;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* <p>Contains input information for protected jobs with an S3 output type.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export interface ProtectedJobS3OutputConfigurationInput {
|
|
38
|
+
/**
|
|
39
|
+
* <p> The S3 bucket for job output.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
bucket: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The S3 prefix to unload the protected job results.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
keyPrefix?: string | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* <p>Contains configurations for protected job results.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export type MembershipProtectedJobOutputConfiguration = MembershipProtectedJobOutputConfiguration.S3Member | MembershipProtectedJobOutputConfiguration.$UnknownMember;
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
export declare namespace MembershipProtectedJobOutputConfiguration {
|
|
58
|
+
/**
|
|
59
|
+
* <p>Contains the configuration to write the job results to S3.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
interface S3Member {
|
|
63
|
+
s3: ProtectedJobS3OutputConfigurationInput;
|
|
64
|
+
$unknown?: never;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
interface $UnknownMember {
|
|
70
|
+
s3?: never;
|
|
71
|
+
$unknown: [string, any];
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @deprecated unused in schema-serde mode.
|
|
75
|
+
*
|
|
76
|
+
*/
|
|
77
|
+
interface Visitor<T> {
|
|
78
|
+
s3: (value: ProtectedJobS3OutputConfigurationInput) => T;
|
|
79
|
+
_: (name: string, value: any) => T;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* <p>Contains configurations for protected job results.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export interface MembershipProtectedJobResultConfiguration {
|
|
87
|
+
/**
|
|
88
|
+
* <p> The output configuration for a protected job result.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
outputConfiguration: MembershipProtectedJobOutputConfiguration | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <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>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
roleArn: string | undefined;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* <p>Contains the configuration to write the query results to S3.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export interface ProtectedQueryS3OutputConfiguration {
|
|
103
|
+
/**
|
|
104
|
+
* <p>Intended file format of the result.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
resultFormat: ResultFormat | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The S3 bucket to unload the protected query results.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
bucket: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The S3 prefix to unload the protected query results.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
keyPrefix?: string | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <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>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
singleFileOutput?: boolean | undefined;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* <p>Contains configurations for protected query results.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export type MembershipProtectedQueryOutputConfiguration = MembershipProtectedQueryOutputConfiguration.S3Member | MembershipProtectedQueryOutputConfiguration.$UnknownMember;
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare namespace MembershipProtectedQueryOutputConfiguration {
|
|
133
|
+
/**
|
|
134
|
+
* <p>Contains the configuration to write the query results to S3.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
interface S3Member {
|
|
138
|
+
s3: ProtectedQueryS3OutputConfiguration;
|
|
139
|
+
$unknown?: never;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
interface $UnknownMember {
|
|
145
|
+
s3?: never;
|
|
146
|
+
$unknown: [string, any];
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* @deprecated unused in schema-serde mode.
|
|
150
|
+
*
|
|
151
|
+
*/
|
|
152
|
+
interface Visitor<T> {
|
|
153
|
+
s3: (value: ProtectedQueryS3OutputConfiguration) => T;
|
|
154
|
+
_: (name: string, value: any) => T;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* <p>Contains configurations for protected query results.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export interface MembershipProtectedQueryResultConfiguration {
|
|
162
|
+
/**
|
|
163
|
+
* <p>Configuration for protected query results.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <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>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
roleArn?: string | undefined;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.</p>
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export interface MembershipJobComputePaymentConfig {
|
|
178
|
+
/**
|
|
179
|
+
* <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 can be one or more members who are designated as payer candidates 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>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
isResponsible: boolean | undefined;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export interface MembershipModelInferencePaymentConfig {
|
|
189
|
+
/**
|
|
190
|
+
* <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>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
isResponsible: boolean | undefined;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
export interface MembershipModelTrainingPaymentConfig {
|
|
200
|
+
/**
|
|
201
|
+
* <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>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
isResponsible: boolean | undefined;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* <p>Configuration for payment for synthetic data generation in a membership.</p>
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
export interface MembershipSyntheticDataGenerationPaymentConfig {
|
|
211
|
+
/**
|
|
212
|
+
* <p>Indicates if this membership is responsible for paying for synthetic data generation.</p>
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
isResponsible: boolean | undefined;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
export interface MembershipMLPaymentConfig {
|
|
222
|
+
/**
|
|
223
|
+
* <p>The payment responsibilities accepted by the member for model training.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
modelTraining?: MembershipModelTrainingPaymentConfig | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>The payment responsibilities accepted by the member for model inference.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
modelInference?: MembershipModelInferencePaymentConfig | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The payment configuration for synthetic data generation for this machine learning membership.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
syntheticDataGeneration?: MembershipSyntheticDataGenerationPaymentConfig | undefined;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
export interface MembershipQueryComputePaymentConfig {
|
|
243
|
+
/**
|
|
244
|
+
* <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>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
isResponsible: boolean | undefined;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export interface MembershipPaymentConfiguration {
|
|
254
|
+
/**
|
|
255
|
+
* <p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
queryCompute: MembershipQueryComputePaymentConfig | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The payment responsibilities accepted by the collaboration member for machine learning costs.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
machineLearning?: MembershipMLPaymentConfig | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The payment responsibilities accepted by the collaboration member for job compute costs.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
jobCompute?: MembershipJobComputePaymentConfig | undefined;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
export interface CreateMembershipInput {
|
|
274
|
+
/**
|
|
275
|
+
* <p>The unique ID for the associated collaboration.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
collaborationIdentifier: string | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <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>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <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>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <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>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
tags?: Record<string, string> | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <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>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
|
|
304
|
+
/**
|
|
305
|
+
* <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>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
paymentConfiguration?: MembershipPaymentConfiguration | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.</p> <p>Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.</p> <p>When <code>true</code>, metrics about query execution are collected in Amazon CloudWatch. The default value is <code>false</code>.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
isMetricsEnabled?: boolean | undefined;
|
|
314
|
+
}
|
|
315
|
+
/**
|
|
316
|
+
* <p>The membership object.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
export interface Membership {
|
|
320
|
+
/**
|
|
321
|
+
* <p>The unique ID of the membership.</p>
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
id: string | undefined;
|
|
325
|
+
/**
|
|
326
|
+
* <p>The unique ARN for the membership.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
arn: string | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The unique ARN for the membership's associated collaboration.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
collaborationArn: string | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>The unique ID for the membership's collaboration.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
collaborationId: string | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
collaborationCreatorAccountId: string | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* <p>The display name of the collaboration creator.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
collaborationCreatorDisplayName: string | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* <p>The name of the membership's collaboration.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
collaborationName: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The time when the membership was created.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
createTime: Date | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* <p>The time the membership metadata was last updated.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
updateTime: Date | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>The status of the membership.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
status: MembershipStatus | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The abilities granted to the collaboration member.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
memberAbilities: MemberAbility[] | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* <p>Specifies the ML member abilities that are granted to a collaboration member.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
mlMemberAbilities?: MLMemberAbilities | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <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>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
queryLogStatus: MembershipQueryLogStatus | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <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>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
jobLogStatus?: MembershipJobLogStatus | undefined;
|
|
390
|
+
/**
|
|
391
|
+
* <p>The default protected query result configuration as specified by the member who can receive results.</p>
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* <p> The default job result configuration for the membership.</p>
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
|
|
400
|
+
/**
|
|
401
|
+
* <p>The payment responsibilities accepted by the collaboration member.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
paymentConfiguration: MembershipPaymentConfiguration | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.</p> <p>When <code>true</code>, metrics about query execution are collected in Amazon CloudWatch.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
isMetricsEnabled?: boolean | undefined;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface CreateMembershipOutput {
|
|
415
|
+
/**
|
|
416
|
+
* <p>The membership that was created.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
membership: Membership | undefined;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
export interface DeleteMembershipInput {
|
|
425
|
+
/**
|
|
426
|
+
* <p>The identifier for a membership resource.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
membershipIdentifier: string | undefined;
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
export interface DeleteMembershipOutput {
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
export interface DisallowIntermediateTableInput {
|
|
440
|
+
/**
|
|
441
|
+
* <p>The unique identifier of the membership that contains the intermediate table to disallow.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
membershipIdentifier: string | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>The name of the intermediate table to disallow.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
intermediateTableName: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>Specifies whether to cascade the disallow action to descendant intermediate tables. Default is <code>true</code>.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
includeDescendants?: boolean | undefined;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
export interface DisallowIntermediateTableOutput {
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
export interface GetMembershipInput {
|
|
465
|
+
/**
|
|
466
|
+
* <p>The identifier for a membership resource.</p>
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
membershipIdentifier: string | undefined;
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
export interface GetMembershipOutput {
|
|
475
|
+
/**
|
|
476
|
+
* <p>The membership retrieved for the provided identifier.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
membership: Membership | undefined;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
export interface GetProtectedJobInput {
|
|
485
|
+
/**
|
|
486
|
+
* <p> The identifier for a membership in a protected job instance.</p>
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
membershipIdentifier: string | undefined;
|
|
490
|
+
/**
|
|
491
|
+
* <p> The identifier for the protected job instance.</p>
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
protectedJobIdentifier: string | undefined;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* <p>The configuration of the compute resources for a PySpark job.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
export interface ProtectedJobWorkerComputeConfiguration {
|
|
501
|
+
/**
|
|
502
|
+
* <p>The worker compute configuration type.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
type: ProtectedJobWorkerComputeType | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* <p>The number of workers for a PySpark job.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
number: number | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* <p>The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
properties?: WorkerComputeConfigurationProperties | undefined;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* <p>The configuration of the compute resources for a PySpark job.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
export type ProtectedJobComputeConfiguration = ProtectedJobComputeConfiguration.WorkerMember | ProtectedJobComputeConfiguration.$UnknownMember;
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
export declare namespace ProtectedJobComputeConfiguration {
|
|
526
|
+
/**
|
|
527
|
+
* <p>The worker configuration for the compute environment.</p>
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
interface WorkerMember {
|
|
531
|
+
worker: ProtectedJobWorkerComputeConfiguration;
|
|
532
|
+
$unknown?: never;
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
interface $UnknownMember {
|
|
538
|
+
worker?: never;
|
|
539
|
+
$unknown: [string, any];
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* @deprecated unused in schema-serde mode.
|
|
543
|
+
*
|
|
544
|
+
*/
|
|
545
|
+
interface Visitor<T> {
|
|
546
|
+
worker: (value: ProtectedJobWorkerComputeConfiguration) => T;
|
|
547
|
+
_: (name: string, value: any) => T;
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* <p>The protected job error.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
export interface ProtectedJobError {
|
|
555
|
+
/**
|
|
556
|
+
* <p> The message for the protected job error.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
message: string | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <p> The error code for the protected job.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
code: string | undefined;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* <p>The parameters for the protected job.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
export interface ProtectedJobParameters {
|
|
571
|
+
/**
|
|
572
|
+
* <p> The ARN of the analysis template.</p>
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
analysisTemplateArn: string | undefined;
|
|
576
|
+
/**
|
|
577
|
+
* <p>Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
parameters?: Record<string, string> | undefined;
|
|
581
|
+
}
|
|
582
|
+
/**
|
|
583
|
+
* <p>Details about the member who received the job result.</p>
|
|
584
|
+
* @public
|
|
585
|
+
*/
|
|
586
|
+
export interface ProtectedJobSingleMemberOutput {
|
|
587
|
+
/**
|
|
588
|
+
* <p>The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.</p>
|
|
589
|
+
* @public
|
|
590
|
+
*/
|
|
591
|
+
accountId: string | undefined;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* <p>Contains output information for protected jobs with an S3 output type.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
export interface ProtectedJobS3Output {
|
|
598
|
+
/**
|
|
599
|
+
* <p> The S3 location for the protected job output.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
location: string | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* <p>Contains details about the protected job output.</p>
|
|
606
|
+
* @public
|
|
607
|
+
*/
|
|
608
|
+
export type ProtectedJobOutput = ProtectedJobOutput.MemberListMember | ProtectedJobOutput.S3Member | ProtectedJobOutput.$UnknownMember;
|
|
609
|
+
/**
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
export declare namespace ProtectedJobOutput {
|
|
613
|
+
/**
|
|
614
|
+
* <p>If present, the output for a protected job with an `S3` output type.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
interface S3Member {
|
|
618
|
+
s3: ProtectedJobS3Output;
|
|
619
|
+
memberList?: never;
|
|
620
|
+
$unknown?: never;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* <p>The list of member Amazon Web Services account(s) that received the results of the job. </p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
interface MemberListMember {
|
|
627
|
+
s3?: never;
|
|
628
|
+
memberList: ProtectedJobSingleMemberOutput[];
|
|
629
|
+
$unknown?: never;
|
|
630
|
+
}
|
|
631
|
+
/**
|
|
632
|
+
* @public
|
|
633
|
+
*/
|
|
634
|
+
interface $UnknownMember {
|
|
635
|
+
s3?: never;
|
|
636
|
+
memberList?: never;
|
|
637
|
+
$unknown: [string, any];
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* @deprecated unused in schema-serde mode.
|
|
641
|
+
*
|
|
642
|
+
*/
|
|
643
|
+
interface Visitor<T> {
|
|
644
|
+
s3: (value: ProtectedJobS3Output) => T;
|
|
645
|
+
memberList: (value: ProtectedJobSingleMemberOutput[]) => T;
|
|
646
|
+
_: (name: string, value: any) => T;
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* <p>Details about the job results.</p>
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
export interface ProtectedJobResult {
|
|
654
|
+
/**
|
|
655
|
+
* <p> The output of the protected job.</p>
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
output: ProtectedJobOutput | undefined;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* <p> The protected job member output configuration output.</p>
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
export interface ProtectedJobMemberOutputConfigurationOutput {
|
|
665
|
+
/**
|
|
666
|
+
* <p> The account ID.</p>
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
accountId: string | undefined;
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* <p> The output configuration for a protected job's S3 output.</p>
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
export interface ProtectedJobS3OutputConfigurationOutput {
|
|
676
|
+
/**
|
|
677
|
+
* <p> The S3 bucket for job output.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
bucket: string | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>The S3 prefix to unload the protected job results.</p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
keyPrefix?: string | undefined;
|
|
686
|
+
}
|
|
687
|
+
/**
|
|
688
|
+
* <p> The protected job output configuration output.</p>
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
export type ProtectedJobOutputConfigurationOutput = ProtectedJobOutputConfigurationOutput.MemberMember | ProtectedJobOutputConfigurationOutput.S3Member | ProtectedJobOutputConfigurationOutput.$UnknownMember;
|
|
692
|
+
/**
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
export declare namespace ProtectedJobOutputConfigurationOutput {
|
|
696
|
+
/**
|
|
697
|
+
* <p>If present, the output for a protected job with an `S3` output type.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
interface S3Member {
|
|
701
|
+
s3: ProtectedJobS3OutputConfigurationOutput;
|
|
702
|
+
member?: never;
|
|
703
|
+
$unknown?: never;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* <p> The member output configuration for a protected job.</p>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
interface MemberMember {
|
|
710
|
+
s3?: never;
|
|
711
|
+
member: ProtectedJobMemberOutputConfigurationOutput;
|
|
712
|
+
$unknown?: never;
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
interface $UnknownMember {
|
|
718
|
+
s3?: never;
|
|
719
|
+
member?: never;
|
|
720
|
+
$unknown: [string, any];
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* @deprecated unused in schema-serde mode.
|
|
724
|
+
*
|
|
725
|
+
*/
|
|
726
|
+
interface Visitor<T> {
|
|
727
|
+
s3: (value: ProtectedJobS3OutputConfigurationOutput) => T;
|
|
728
|
+
member: (value: ProtectedJobMemberOutputConfigurationOutput) => T;
|
|
729
|
+
_: (name: string, value: any) => T;
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* <p>The output configuration for a protected job result.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
export interface ProtectedJobResultConfigurationOutput {
|
|
737
|
+
/**
|
|
738
|
+
* <p>The output configuration.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
outputConfiguration: ProtectedJobOutputConfigurationOutput | undefined;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* <p> Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected job.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
export interface BilledJobResourceUtilization {
|
|
748
|
+
/**
|
|
749
|
+
* <p> The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.</p>
|
|
750
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
units: number | undefined;
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* <p>Contains statistics about the execution of the protected job.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
export interface ProtectedJobStatistics {
|
|
759
|
+
/**
|
|
760
|
+
* <p>The duration of the protected job, from creation until job completion, in milliseconds.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
totalDurationInMillis?: number | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p> The billed resource utilization for the protected job.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
billedResourceUtilization?: BilledJobResourceUtilization | undefined;
|
|
769
|
+
}
|
|
770
|
+
/**
|
|
771
|
+
* <p>The parameters for an Clean Rooms protected job.</p>
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
export interface ProtectedJob {
|
|
775
|
+
/**
|
|
776
|
+
* <p>The identifier for a protected job instance.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
id: string | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* <p>he identifier for the membership.</p>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
membershipId: string | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* <p>The ARN of the membership.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
membershipArn: string | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p> The creation time of the protected job.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
createTime: Date | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p> The job parameters for the protected job.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
jobParameters?: ProtectedJobParameters | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p> The status of the protected job.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
status: ProtectedJobStatus | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <p>Contains any details needed to write the job results.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
resultConfiguration?: ProtectedJobResultConfigurationOutput | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p> The statistics of the protected job.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
statistics?: ProtectedJobStatistics | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <p> The result of the protected job.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
result?: ProtectedJobResult | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* <p> The error from the protected job.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
error?: ProtectedJobError | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The compute configuration for the protected job.</p>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
computeConfiguration?: ProtectedJobComputeConfiguration | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>The account ID of the member that pays for the job compute costs.</p>
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
jobComputePayerAccountId?: string | undefined;
|
|
835
|
+
}
|
|
836
|
+
/**
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
export interface GetProtectedJobOutput {
|
|
840
|
+
/**
|
|
841
|
+
* <p> The protected job metadata.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
protectedJob: ProtectedJob | undefined;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
export interface GetProtectedQueryInput {
|
|
850
|
+
/**
|
|
851
|
+
* <p>The identifier for a membership in a protected query instance.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
membershipIdentifier: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <p>The identifier for a protected query instance.</p>
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
protectedQueryIdentifier: string | undefined;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
* <p> The configuration of the compute resources for an analysis with the Spark analytics engine.</p>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export type ComputeConfiguration = ComputeConfiguration.WorkerMember | ComputeConfiguration.$UnknownMember;
|
|
866
|
+
/**
|
|
867
|
+
* @public
|
|
868
|
+
*/
|
|
869
|
+
export declare namespace ComputeConfiguration {
|
|
870
|
+
/**
|
|
871
|
+
* <p> The worker configuration for the compute environment.</p>
|
|
872
|
+
* @public
|
|
873
|
+
*/
|
|
874
|
+
interface WorkerMember {
|
|
875
|
+
worker: WorkerComputeConfiguration;
|
|
876
|
+
$unknown?: never;
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
interface $UnknownMember {
|
|
882
|
+
worker?: never;
|
|
883
|
+
$unknown: [string, any];
|
|
884
|
+
}
|
|
885
|
+
/**
|
|
886
|
+
* @deprecated unused in schema-serde mode.
|
|
887
|
+
*
|
|
888
|
+
*/
|
|
889
|
+
interface Visitor<T> {
|
|
890
|
+
worker: (value: WorkerComputeConfiguration) => T;
|
|
891
|
+
_: (name: string, value: any) => T;
|
|
892
|
+
}
|
|
893
|
+
}
|
|
894
|
+
/**
|
|
895
|
+
* <p>Provides the sensitivity parameters.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
export interface DifferentialPrivacySensitivityParameters {
|
|
899
|
+
/**
|
|
900
|
+
* <p>The type of aggregation function that was run.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
aggregationType: DifferentialPrivacyAggregationType | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>The aggregation expression that was run.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
aggregationExpression: string | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>The maximum number of rows contributed by a user in a SQL query.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
userContributionLimit: number | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The lower bound of the aggregation expression.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
minColumnValue?: number | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>The upper bound of the aggregation expression.</p>
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
maxColumnValue?: number | undefined;
|
|
924
|
+
}
|
|
925
|
+
/**
|
|
926
|
+
* <p>An array that contains the sensitivity parameters.</p>
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface DifferentialPrivacyParameters {
|
|
930
|
+
/**
|
|
931
|
+
* <p>Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
sensitivityParameters: DifferentialPrivacySensitivityParameters[] | undefined;
|
|
935
|
+
}
|
|
936
|
+
/**
|
|
937
|
+
* <p>Details of errors thrown by the protected query.</p>
|
|
938
|
+
* @public
|
|
939
|
+
*/
|
|
940
|
+
export interface ProtectedQueryError {
|
|
941
|
+
/**
|
|
942
|
+
* <p>A description of why the query failed.</p>
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
message: string | undefined;
|
|
946
|
+
/**
|
|
947
|
+
* <p>An error code for the error.</p>
|
|
948
|
+
* @public
|
|
949
|
+
*/
|
|
950
|
+
code: string | undefined;
|
|
951
|
+
}
|
|
952
|
+
/**
|
|
953
|
+
* <p>Details about the member who received the query result.</p>
|
|
954
|
+
* @public
|
|
955
|
+
*/
|
|
956
|
+
export interface ProtectedQuerySingleMemberOutput {
|
|
957
|
+
/**
|
|
958
|
+
* <p>The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.</p>
|
|
959
|
+
* @public
|
|
960
|
+
*/
|
|
961
|
+
accountId: string | undefined;
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* <p>Contains output information for protected queries with an S3 output type.</p>
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
export interface ProtectedQueryS3Output {
|
|
968
|
+
/**
|
|
969
|
+
* <p>The S3 location of the result.</p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
location: string | undefined;
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
* <p> Contains the output information for a protected query with a distribute output configuration.</p> <p> This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.</p>
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
export interface ProtectedQueryDistributeOutput {
|
|
979
|
+
/**
|
|
980
|
+
* <p>Contains output information for protected queries with an S3 output type.</p>
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
s3?: ProtectedQueryS3Output | undefined;
|
|
984
|
+
/**
|
|
985
|
+
* <p> Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member. </p>
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
memberList?: ProtectedQuerySingleMemberOutput[] | undefined;
|
|
989
|
+
}
|
|
3
990
|
/**
|
|
4
991
|
* <p>Contains details about the protected query output.</p>
|
|
5
992
|
* @public
|
|
@@ -137,11 +1124,32 @@ export interface ProtectedQueryDistributeOutputConfiguration {
|
|
|
137
1124
|
*/
|
|
138
1125
|
locations: ProtectedQueryDistributeOutputConfigurationLocation[] | undefined;
|
|
139
1126
|
}
|
|
1127
|
+
/**
|
|
1128
|
+
* <p>Contains the output configuration of an intermediate table when a protected query populates it.</p>
|
|
1129
|
+
* @public
|
|
1130
|
+
*/
|
|
1131
|
+
export interface IntermediateTableOutputConfiguration {
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The unique identifier of the intermediate table.</p>
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1136
|
+
id: string | undefined;
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The Amazon Resource Name (ARN) of the intermediate table.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
arn: string | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The name of the intermediate table.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
name: string | undefined;
|
|
1147
|
+
}
|
|
140
1148
|
/**
|
|
141
1149
|
* <p>Contains configuration details for protected query output.</p>
|
|
142
1150
|
* @public
|
|
143
1151
|
*/
|
|
144
|
-
export type ProtectedQueryOutputConfiguration = ProtectedQueryOutputConfiguration.DistributeMember | ProtectedQueryOutputConfiguration.MemberMember | ProtectedQueryOutputConfiguration.S3Member | ProtectedQueryOutputConfiguration.$UnknownMember;
|
|
1152
|
+
export type ProtectedQueryOutputConfiguration = ProtectedQueryOutputConfiguration.DistributeMember | ProtectedQueryOutputConfiguration.IntermediateTableMember | ProtectedQueryOutputConfiguration.MemberMember | ProtectedQueryOutputConfiguration.S3Member | ProtectedQueryOutputConfiguration.$UnknownMember;
|
|
145
1153
|
/**
|
|
146
1154
|
* @public
|
|
147
1155
|
*/
|
|
@@ -154,6 +1162,7 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
154
1162
|
s3: ProtectedQueryS3OutputConfiguration;
|
|
155
1163
|
member?: never;
|
|
156
1164
|
distribute?: never;
|
|
1165
|
+
intermediateTable?: never;
|
|
157
1166
|
$unknown?: never;
|
|
158
1167
|
}
|
|
159
1168
|
/**
|
|
@@ -164,6 +1173,7 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
164
1173
|
s3?: never;
|
|
165
1174
|
member: ProtectedQueryMemberOutputConfiguration;
|
|
166
1175
|
distribute?: never;
|
|
1176
|
+
intermediateTable?: never;
|
|
167
1177
|
$unknown?: never;
|
|
168
1178
|
}
|
|
169
1179
|
/**
|
|
@@ -174,6 +1184,18 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
174
1184
|
s3?: never;
|
|
175
1185
|
member?: never;
|
|
176
1186
|
distribute: ProtectedQueryDistributeOutputConfiguration;
|
|
1187
|
+
intermediateTable?: never;
|
|
1188
|
+
$unknown?: never;
|
|
1189
|
+
}
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>The intermediate table output configuration, present when the protected query was triggered by a populate operation.</p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
interface IntermediateTableMember {
|
|
1195
|
+
s3?: never;
|
|
1196
|
+
member?: never;
|
|
1197
|
+
distribute?: never;
|
|
1198
|
+
intermediateTable: IntermediateTableOutputConfiguration;
|
|
177
1199
|
$unknown?: never;
|
|
178
1200
|
}
|
|
179
1201
|
/**
|
|
@@ -183,6 +1205,7 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
183
1205
|
s3?: never;
|
|
184
1206
|
member?: never;
|
|
185
1207
|
distribute?: never;
|
|
1208
|
+
intermediateTable?: never;
|
|
186
1209
|
$unknown: [string, any];
|
|
187
1210
|
}
|
|
188
1211
|
/**
|
|
@@ -193,6 +1216,7 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
193
1216
|
s3: (value: ProtectedQueryS3OutputConfiguration) => T;
|
|
194
1217
|
member: (value: ProtectedQueryMemberOutputConfiguration) => T;
|
|
195
1218
|
distribute: (value: ProtectedQueryDistributeOutputConfiguration) => T;
|
|
1219
|
+
intermediateTable: (value: IntermediateTableOutputConfiguration) => T;
|
|
196
1220
|
_: (name: string, value: any) => T;
|
|
197
1221
|
}
|
|
198
1222
|
}
|
|
@@ -814,6 +1838,11 @@ export interface ProtectedQuerySummary {
|
|
|
814
1838
|
* @public
|
|
815
1839
|
*/
|
|
816
1840
|
queryComputePayerAccountId?: string | undefined;
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>The intermediate table configuration, present when the protected query was triggered by a populate operation.</p>
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
intermediateTableConfiguration?: IntermediateTableOutputConfiguration | undefined;
|
|
817
1846
|
}
|
|
818
1847
|
/**
|
|
819
1848
|
* @public
|