@aws-sdk/client-cleanrooms 3.750.0 → 3.770.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 +33 -1
- package/dist-cjs/index.js +742 -392
- package/dist-es/CleanRooms.js +8 -0
- package/dist-es/commands/GetProtectedJobCommand.js +22 -0
- package/dist-es/commands/GetProtectedQueryCommand.js +1 -1
- package/dist-es/commands/ListProtectedJobsCommand.js +22 -0
- package/dist-es/commands/StartProtectedJobCommand.js +22 -0
- package/dist-es/commands/UpdateProtectedJobCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +90 -75
- package/dist-es/models/models_1.js +96 -1
- package/dist-es/pagination/ListProtectedJobsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +176 -0
- package/dist-types/CleanRooms.d.ts +29 -1
- package/dist-types/CleanRoomsClient.d.ts +7 -3
- package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +30 -1
- package/dist-types/commands/BatchGetSchemaAnalysisRuleCommand.d.ts +98 -0
- package/dist-types/commands/BatchGetSchemaCommand.d.ts +4 -1
- package/dist-types/commands/CreateAnalysisTemplateCommand.d.ts +53 -2
- package/dist-types/commands/CreateCollaborationCommand.d.ts +10 -2
- package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +3 -0
- package/dist-types/commands/CreateConfiguredTableCommand.d.ts +8 -2
- package/dist-types/commands/CreateMembershipCommand.d.ts +29 -3
- package/dist-types/commands/GetAnalysisTemplateCommand.d.ts +30 -1
- package/dist-types/commands/GetCollaborationAnalysisTemplateCommand.d.ts +30 -1
- package/dist-types/commands/GetCollaborationCommand.d.ts +1 -0
- package/dist-types/commands/GetConfiguredTableCommand.d.ts +4 -1
- package/dist-types/commands/GetMembershipCommand.d.ts +15 -2
- package/dist-types/commands/GetProtectedJobCommand.d.ts +130 -0
- package/dist-types/commands/GetProtectedQueryCommand.d.ts +1 -1
- package/dist-types/commands/GetSchemaAnalysisRuleCommand.d.ts +98 -0
- package/dist-types/commands/GetSchemaCommand.d.ts +4 -1
- package/dist-types/commands/ListConfiguredTableAssociationsCommand.d.ts +3 -0
- package/dist-types/commands/ListConfiguredTablesCommand.d.ts +4 -1
- package/dist-types/commands/ListMembersCommand.d.ts +4 -1
- package/dist-types/commands/ListMembershipsCommand.d.ts +5 -2
- package/dist-types/commands/ListPrivacyBudgetsCommand.d.ts +1 -1
- package/dist-types/commands/ListProtectedJobsCommand.d.ts +110 -0
- package/dist-types/commands/ListProtectedQueriesCommand.d.ts +1 -2
- package/dist-types/commands/ListSchemasCommand.d.ts +4 -1
- package/dist-types/commands/StartProtectedJobCommand.d.ts +142 -0
- package/dist-types/commands/UpdateAnalysisTemplateCommand.d.ts +30 -1
- package/dist-types/commands/UpdateCollaborationCommand.d.ts +1 -0
- package/dist-types/commands/UpdateConfiguredTableCommand.d.ts +8 -1
- package/dist-types/commands/UpdateMembershipCommand.d.ts +26 -3
- package/dist-types/commands/UpdateProtectedJobCommand.d.ts +133 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +3468 -3339
- package/dist-types/models/models_1.d.ts +1129 -1
- package/dist-types/pagination/ListProtectedJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/CleanRooms.d.ts +68 -0
- package/dist-types/ts3.4/CleanRoomsClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/GetProtectedQueryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMembershipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPrivacyBudgetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProtectedJobsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListProtectedQueriesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartProtectedJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateProtectedJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +328 -272
- package/dist-types/ts3.4/models/models_1.d.ts +401 -6
- package/dist-types/ts3.4/pagination/ListProtectedJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +12 -12
|
@@ -125,6 +125,104 @@ declare const GetSchemaAnalysisRuleCommand_base: {
|
|
|
125
125
|
* // },
|
|
126
126
|
* // },
|
|
127
127
|
* // },
|
|
128
|
+
* // collaborationPolicy: { // ConfiguredTableAssociationAnalysisRulePolicy Union: only one key present
|
|
129
|
+
* // v1: { // ConfiguredTableAssociationAnalysisRulePolicyV1 Union: only one key present
|
|
130
|
+
* // list: { // ConfiguredTableAssociationAnalysisRuleList
|
|
131
|
+
* // allowedResultReceivers: [ // AllowedResultReceivers
|
|
132
|
+
* // "STRING_VALUE",
|
|
133
|
+
* // ],
|
|
134
|
+
* // allowedAdditionalAnalyses: [ // AllowedAdditionalAnalyses
|
|
135
|
+
* // "STRING_VALUE",
|
|
136
|
+
* // ],
|
|
137
|
+
* // },
|
|
138
|
+
* // aggregation: { // ConfiguredTableAssociationAnalysisRuleAggregation
|
|
139
|
+
* // allowedResultReceivers: [
|
|
140
|
+
* // "STRING_VALUE",
|
|
141
|
+
* // ],
|
|
142
|
+
* // allowedAdditionalAnalyses: [
|
|
143
|
+
* // "STRING_VALUE",
|
|
144
|
+
* // ],
|
|
145
|
+
* // },
|
|
146
|
+
* // custom: { // ConfiguredTableAssociationAnalysisRuleCustom
|
|
147
|
+
* // allowedResultReceivers: [
|
|
148
|
+
* // "STRING_VALUE",
|
|
149
|
+
* // ],
|
|
150
|
+
* // allowedAdditionalAnalyses: [
|
|
151
|
+
* // "STRING_VALUE",
|
|
152
|
+
* // ],
|
|
153
|
+
* // },
|
|
154
|
+
* // },
|
|
155
|
+
* // },
|
|
156
|
+
* // consolidatedPolicy: { // ConsolidatedPolicy Union: only one key present
|
|
157
|
+
* // v1: { // ConsolidatedPolicyV1 Union: only one key present
|
|
158
|
+
* // list: { // ConsolidatedPolicyList
|
|
159
|
+
* // joinColumns: "<AnalysisRuleColumnList>", // required
|
|
160
|
+
* // allowedJoinOperators: [
|
|
161
|
+
* // "STRING_VALUE",
|
|
162
|
+
* // ],
|
|
163
|
+
* // listColumns: "<AnalysisRuleColumnList>", // required
|
|
164
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
165
|
+
* // allowedResultReceivers: [
|
|
166
|
+
* // "STRING_VALUE",
|
|
167
|
+
* // ],
|
|
168
|
+
* // allowedAdditionalAnalyses: [
|
|
169
|
+
* // "STRING_VALUE",
|
|
170
|
+
* // ],
|
|
171
|
+
* // },
|
|
172
|
+
* // aggregation: { // ConsolidatedPolicyAggregation
|
|
173
|
+
* // aggregateColumns: [ // required
|
|
174
|
+
* // {
|
|
175
|
+
* // columnNames: [ // required
|
|
176
|
+
* // "STRING_VALUE",
|
|
177
|
+
* // ],
|
|
178
|
+
* // function: "STRING_VALUE", // required
|
|
179
|
+
* // },
|
|
180
|
+
* // ],
|
|
181
|
+
* // joinColumns: "<AnalysisRuleColumnList>", // required
|
|
182
|
+
* // joinRequired: "STRING_VALUE",
|
|
183
|
+
* // allowedJoinOperators: [
|
|
184
|
+
* // "STRING_VALUE",
|
|
185
|
+
* // ],
|
|
186
|
+
* // dimensionColumns: "<AnalysisRuleColumnList>", // required
|
|
187
|
+
* // scalarFunctions: [ // required
|
|
188
|
+
* // "STRING_VALUE",
|
|
189
|
+
* // ],
|
|
190
|
+
* // outputConstraints: [ // required
|
|
191
|
+
* // {
|
|
192
|
+
* // columnName: "STRING_VALUE", // required
|
|
193
|
+
* // minimum: Number("int"), // required
|
|
194
|
+
* // type: "STRING_VALUE", // required
|
|
195
|
+
* // },
|
|
196
|
+
* // ],
|
|
197
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
198
|
+
* // allowedResultReceivers: [
|
|
199
|
+
* // "STRING_VALUE",
|
|
200
|
+
* // ],
|
|
201
|
+
* // allowedAdditionalAnalyses: [
|
|
202
|
+
* // "STRING_VALUE",
|
|
203
|
+
* // ],
|
|
204
|
+
* // },
|
|
205
|
+
* // custom: { // ConsolidatedPolicyCustom
|
|
206
|
+
* // allowedAnalyses: [ // required
|
|
207
|
+
* // "STRING_VALUE",
|
|
208
|
+
* // ],
|
|
209
|
+
* // allowedAnalysisProviders: [
|
|
210
|
+
* // "STRING_VALUE",
|
|
211
|
+
* // ],
|
|
212
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
213
|
+
* // disallowedOutputColumns: "<AnalysisRuleColumnList>",
|
|
214
|
+
* // differentialPrivacy: {
|
|
215
|
+
* // columns: [ // required
|
|
216
|
+
* // {
|
|
217
|
+
* // name: "STRING_VALUE", // required
|
|
218
|
+
* // },
|
|
219
|
+
* // ],
|
|
220
|
+
* // },
|
|
221
|
+
* // allowedResultReceivers: "<AllowedResultReceivers>",
|
|
222
|
+
* // allowedAdditionalAnalyses: "<AllowedAdditionalAnalyses>",
|
|
223
|
+
* // },
|
|
224
|
+
* // },
|
|
225
|
+
* // },
|
|
128
226
|
* // },
|
|
129
227
|
* // };
|
|
130
228
|
*
|
|
@@ -57,7 +57,10 @@ declare const GetSchemaCommand_base: {
|
|
|
57
57
|
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
|
|
58
58
|
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
|
|
59
59
|
* // ],
|
|
60
|
-
* // analysisMethod: "DIRECT_QUERY",
|
|
60
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE",
|
|
61
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
62
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
63
|
+
* // ],
|
|
61
64
|
* // creatorAccountId: "STRING_VALUE", // required
|
|
62
65
|
* // name: "STRING_VALUE", // required
|
|
63
66
|
* // collaborationId: "STRING_VALUE", // required
|
|
@@ -52,6 +52,9 @@ declare const ListConfiguredTableAssociationsCommand_base: {
|
|
|
52
52
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
53
53
|
* // id: "STRING_VALUE", // required
|
|
54
54
|
* // arn: "STRING_VALUE", // required
|
|
55
|
+
* // analysisRuleTypes: [ // ConfiguredTableAssociationAnalysisRuleTypeList
|
|
56
|
+
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
57
|
+
* // ],
|
|
55
58
|
* // },
|
|
56
59
|
* // ],
|
|
57
60
|
* // nextToken: "STRING_VALUE",
|
|
@@ -51,7 +51,10 @@ declare const ListConfiguredTablesCommand_base: {
|
|
|
51
51
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
52
52
|
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
53
53
|
* // ],
|
|
54
|
-
* // analysisMethod: "DIRECT_QUERY", // required
|
|
54
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
|
|
55
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
56
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
57
|
+
* // ],
|
|
55
58
|
* // },
|
|
56
59
|
* // ],
|
|
57
60
|
* // nextToken: "STRING_VALUE",
|
|
@@ -49,7 +49,7 @@ declare const ListMembersCommand_base: {
|
|
|
49
49
|
* // status: "STRING_VALUE", // required
|
|
50
50
|
* // displayName: "STRING_VALUE", // required
|
|
51
51
|
* // abilities: [ // MemberAbilities // required
|
|
52
|
-
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
52
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
53
53
|
* // ],
|
|
54
54
|
* // mlAbilities: { // MLMemberAbilities
|
|
55
55
|
* // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
@@ -72,6 +72,9 @@ declare const ListMembersCommand_base: {
|
|
|
72
72
|
* // isResponsible: true || false, // required
|
|
73
73
|
* // },
|
|
74
74
|
* // },
|
|
75
|
+
* // jobCompute: { // JobComputePaymentConfig
|
|
76
|
+
* // isResponsible: true || false, // required
|
|
77
|
+
* // },
|
|
75
78
|
* // },
|
|
76
79
|
* // },
|
|
77
80
|
* // ],
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
-
import { ListMembershipsInput, ListMembershipsOutput } from "../models/
|
|
4
|
+
import { ListMembershipsInput, ListMembershipsOutput } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -56,7 +56,7 @@ declare const ListMembershipsCommand_base: {
|
|
|
56
56
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
57
57
|
* // status: "STRING_VALUE", // required
|
|
58
58
|
* // memberAbilities: [ // MemberAbilities // required
|
|
59
|
-
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
59
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
60
60
|
* // ],
|
|
61
61
|
* // mlMemberAbilities: { // MLMemberAbilities
|
|
62
62
|
* // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
@@ -75,6 +75,9 @@ declare const ListMembershipsCommand_base: {
|
|
|
75
75
|
* // isResponsible: true || false, // required
|
|
76
76
|
* // },
|
|
77
77
|
* // },
|
|
78
|
+
* // jobCompute: { // MembershipJobComputePaymentConfig
|
|
79
|
+
* // isResponsible: true || false, // required
|
|
80
|
+
* // },
|
|
78
81
|
* // },
|
|
79
82
|
* // },
|
|
80
83
|
* // ],
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
-
import { ListPrivacyBudgetsInput, ListPrivacyBudgetsOutput } from "../models/
|
|
4
|
+
import { ListPrivacyBudgetsInput, ListPrivacyBudgetsOutput } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
+
import { ListProtectedJobsInput, ListProtectedJobsOutput } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListProtectedJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListProtectedJobsCommandInput extends ListProtectedJobsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListProtectedJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListProtectedJobsCommandOutput extends ListProtectedJobsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListProtectedJobsCommand_base: {
|
|
25
|
+
new (input: ListProtectedJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListProtectedJobsCommandInput, ListProtectedJobsCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListProtectedJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListProtectedJobsCommandInput, ListProtectedJobsCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists protected jobs, sorted by most recent job.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CleanRoomsClient, ListProtectedJobsCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
35
|
+
* // const { CleanRoomsClient, ListProtectedJobsCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
36
|
+
* const client = new CleanRoomsClient(config);
|
|
37
|
+
* const input = { // ListProtectedJobsInput
|
|
38
|
+
* membershipIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS",
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListProtectedJobsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListProtectedJobsOutput
|
|
46
|
+
* // nextToken: "STRING_VALUE",
|
|
47
|
+
* // protectedJobs: [ // ProtectedJobSummaryList // required
|
|
48
|
+
* // { // ProtectedJobSummary
|
|
49
|
+
* // id: "STRING_VALUE", // required
|
|
50
|
+
* // membershipId: "STRING_VALUE", // required
|
|
51
|
+
* // membershipArn: "STRING_VALUE", // required
|
|
52
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS", // required
|
|
54
|
+
* // receiverConfigurations: [ // ProtectedJobReceiverConfigurations // required
|
|
55
|
+
* // { // ProtectedJobReceiverConfiguration
|
|
56
|
+
* // analysisType: "DIRECT_ANALYSIS", // required
|
|
57
|
+
* // configurationDetails: { // ProtectedJobConfigurationDetails Union: only one key present
|
|
58
|
+
* // directAnalysisConfigurationDetails: { // ProtectedJobDirectAnalysisConfigurationDetails
|
|
59
|
+
* // receiverAccountIds: [ // ProtectedJobReceiverAccountIds
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param ListProtectedJobsCommandInput - {@link ListProtectedJobsCommandInput}
|
|
73
|
+
* @returns {@link ListProtectedJobsCommandOutput}
|
|
74
|
+
* @see {@link ListProtectedJobsCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link ListProtectedJobsCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerException} (server fault)
|
|
82
|
+
* <p>Unexpected error during processing of request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>Request references a resource which does not exist.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>Request was denied due to request throttling.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link CleanRoomsServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class ListProtectedJobsCommand extends ListProtectedJobsCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: ListProtectedJobsInput;
|
|
103
|
+
output: ListProtectedJobsOutput;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: ListProtectedJobsCommandInput;
|
|
107
|
+
output: ListProtectedJobsCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
-
import { ListProtectedQueriesInput } from "../models/
|
|
5
|
-
import { ListProtectedQueriesOutput } from "../models/models_1";
|
|
4
|
+
import { ListProtectedQueriesInput, ListProtectedQueriesOutput } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -55,7 +55,10 @@ declare const ListSchemasCommand_base: {
|
|
|
55
55
|
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
|
|
56
56
|
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
|
|
57
57
|
* // ],
|
|
58
|
-
* // analysisMethod: "DIRECT_QUERY",
|
|
58
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE",
|
|
59
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
60
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
61
|
+
* // ],
|
|
59
62
|
* // },
|
|
60
63
|
* // ],
|
|
61
64
|
* // nextToken: "STRING_VALUE",
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
+
import { StartProtectedJobInput, StartProtectedJobOutput } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartProtectedJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartProtectedJobCommandInput extends StartProtectedJobInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartProtectedJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartProtectedJobCommandOutput extends StartProtectedJobOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartProtectedJobCommand_base: {
|
|
25
|
+
new (input: StartProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartProtectedJobCommandInput, StartProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StartProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartProtectedJobCommandInput, StartProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a protected job that is started by Clean Rooms.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CleanRoomsClient, StartProtectedJobCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
35
|
+
* // const { CleanRoomsClient, StartProtectedJobCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
36
|
+
* const client = new CleanRoomsClient(config);
|
|
37
|
+
* const input = { // StartProtectedJobInput
|
|
38
|
+
* type: "PYSPARK", // required
|
|
39
|
+
* membershipIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* jobParameters: { // ProtectedJobParameters
|
|
41
|
+
* analysisTemplateArn: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* resultConfiguration: { // ProtectedJobResultConfigurationInput
|
|
44
|
+
* outputConfiguration: { // ProtectedJobOutputConfigurationInput Union: only one key present
|
|
45
|
+
* member: { // ProtectedJobMemberOutputConfigurationInput
|
|
46
|
+
* accountId: "STRING_VALUE", // required
|
|
47
|
+
* },
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* };
|
|
51
|
+
* const command = new StartProtectedJobCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // StartProtectedJobOutput
|
|
54
|
+
* // protectedJob: { // ProtectedJob
|
|
55
|
+
* // id: "STRING_VALUE", // required
|
|
56
|
+
* // membershipId: "STRING_VALUE", // required
|
|
57
|
+
* // membershipArn: "STRING_VALUE", // required
|
|
58
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
59
|
+
* // jobParameters: { // ProtectedJobParameters
|
|
60
|
+
* // analysisTemplateArn: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS", // required
|
|
63
|
+
* // resultConfiguration: { // ProtectedJobResultConfigurationOutput
|
|
64
|
+
* // outputConfiguration: { // ProtectedJobOutputConfigurationOutput Union: only one key present
|
|
65
|
+
* // s3: { // ProtectedJobS3OutputConfigurationOutput
|
|
66
|
+
* // bucket: "STRING_VALUE", // required
|
|
67
|
+
* // keyPrefix: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // member: { // ProtectedJobMemberOutputConfigurationOutput
|
|
70
|
+
* // accountId: "STRING_VALUE", // required
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // statistics: { // ProtectedJobStatistics
|
|
75
|
+
* // totalDurationInMillis: Number("long"),
|
|
76
|
+
* // billedResourceUtilization: { // BilledJobResourceUtilization
|
|
77
|
+
* // units: Number("double"), // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // result: { // ProtectedJobResult
|
|
81
|
+
* // output: { // ProtectedJobOutput Union: only one key present
|
|
82
|
+
* // s3: { // ProtectedJobS3Output
|
|
83
|
+
* // location: "STRING_VALUE", // required
|
|
84
|
+
* // },
|
|
85
|
+
* // memberList: [ // ProtectedJobMemberOutputList
|
|
86
|
+
* // { // ProtectedJobSingleMemberOutput
|
|
87
|
+
* // accountId: "STRING_VALUE", // required
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // },
|
|
91
|
+
* // },
|
|
92
|
+
* // error: { // ProtectedJobError
|
|
93
|
+
* // message: "STRING_VALUE", // required
|
|
94
|
+
* // code: "STRING_VALUE", // required
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
97
|
+
* // };
|
|
98
|
+
*
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* @param StartProtectedJobCommandInput - {@link StartProtectedJobCommandInput}
|
|
102
|
+
* @returns {@link StartProtectedJobCommandOutput}
|
|
103
|
+
* @see {@link StartProtectedJobCommandInput} for command's `input` shape.
|
|
104
|
+
* @see {@link StartProtectedJobCommandOutput} for command's `response` shape.
|
|
105
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
108
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link InternalServerException} (server fault)
|
|
111
|
+
* <p>Unexpected error during processing of request.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
114
|
+
* <p>Request references a resource which does not exist.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
117
|
+
* <p>Request denied because service quota has been exceeded.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
120
|
+
* <p>Request was denied due to request throttling.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link ValidationException} (client fault)
|
|
123
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link CleanRoomsServiceException}
|
|
126
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
127
|
+
*
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export declare class StartProtectedJobCommand extends StartProtectedJobCommand_base {
|
|
131
|
+
/** @internal type navigation helper, not in runtime. */
|
|
132
|
+
protected static __types: {
|
|
133
|
+
api: {
|
|
134
|
+
input: StartProtectedJobInput;
|
|
135
|
+
output: StartProtectedJobOutput;
|
|
136
|
+
};
|
|
137
|
+
sdk: {
|
|
138
|
+
input: StartProtectedJobCommandInput;
|
|
139
|
+
output: StartProtectedJobCommandOutput;
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
}
|
|
@@ -58,9 +58,38 @@ declare const UpdateAnalysisTemplateCommand_base: {
|
|
|
58
58
|
* // "STRING_VALUE",
|
|
59
59
|
* // ],
|
|
60
60
|
* // },
|
|
61
|
-
* // format: "SQL", // required
|
|
61
|
+
* // format: "SQL" || "PYSPARK_1_0", // required
|
|
62
62
|
* // source: { // AnalysisSource Union: only one key present
|
|
63
63
|
* // text: "STRING_VALUE",
|
|
64
|
+
* // artifacts: { // AnalysisTemplateArtifacts
|
|
65
|
+
* // entryPoint: { // AnalysisTemplateArtifact
|
|
66
|
+
* // location: { // S3Location
|
|
67
|
+
* // bucket: "STRING_VALUE", // required
|
|
68
|
+
* // key: "STRING_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // additionalArtifacts: [ // AnalysisTemplateArtifactList
|
|
72
|
+
* // {
|
|
73
|
+
* // location: {
|
|
74
|
+
* // bucket: "STRING_VALUE", // required
|
|
75
|
+
* // key: "STRING_VALUE", // required
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // roleArn: "STRING_VALUE", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present
|
|
83
|
+
* // artifacts: { // AnalysisTemplateArtifactMetadata
|
|
84
|
+
* // entryPointHash: { // Hash
|
|
85
|
+
* // sha256: "STRING_VALUE",
|
|
86
|
+
* // },
|
|
87
|
+
* // additionalArtifactHashes: [ // HashList
|
|
88
|
+
* // {
|
|
89
|
+
* // sha256: "STRING_VALUE",
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // },
|
|
64
93
|
* // },
|
|
65
94
|
* // analysisParameters: [ // AnalysisParameterList
|
|
66
95
|
* // { // AnalysisParameter
|
|
@@ -61,6 +61,7 @@ declare const UpdateCollaborationCommand_base: {
|
|
|
61
61
|
* // preserveNulls: true || false, // required
|
|
62
62
|
* // },
|
|
63
63
|
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
64
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
64
65
|
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
65
66
|
* // },
|
|
66
67
|
* // };
|
|
@@ -38,6 +38,10 @@ declare const UpdateConfiguredTableCommand_base: {
|
|
|
38
38
|
* configuredTableIdentifier: "STRING_VALUE", // required
|
|
39
39
|
* name: "STRING_VALUE",
|
|
40
40
|
* description: "STRING_VALUE",
|
|
41
|
+
* analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE",
|
|
42
|
+
* selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
43
|
+
* "DIRECT_QUERY" || "DIRECT_JOB",
|
|
44
|
+
* ],
|
|
41
45
|
* };
|
|
42
46
|
* const command = new UpdateConfiguredTableCommand(input);
|
|
43
47
|
* const response = await client.send(command);
|
|
@@ -79,10 +83,13 @@ declare const UpdateConfiguredTableCommand_base: {
|
|
|
79
83
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
80
84
|
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
81
85
|
* // ],
|
|
82
|
-
* // analysisMethod: "DIRECT_QUERY", // required
|
|
86
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
|
|
83
87
|
* // allowedColumns: [ // AllowedColumnList // required
|
|
84
88
|
* // "STRING_VALUE",
|
|
85
89
|
* // ],
|
|
90
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
91
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
92
|
+
* // ],
|
|
86
93
|
* // },
|
|
87
94
|
* // };
|
|
88
95
|
*
|
|
@@ -36,7 +36,8 @@ declare const UpdateMembershipCommand_base: {
|
|
|
36
36
|
* const client = new CleanRoomsClient(config);
|
|
37
37
|
* const input = { // UpdateMembershipInput
|
|
38
38
|
* membershipIdentifier: "STRING_VALUE", // required
|
|
39
|
-
* queryLogStatus: "
|
|
39
|
+
* queryLogStatus: "ENABLED" || "DISABLED",
|
|
40
|
+
* jobLogStatus: "ENABLED" || "DISABLED",
|
|
40
41
|
* defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
|
|
41
42
|
* outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
|
|
42
43
|
* s3: { // ProtectedQueryS3OutputConfiguration
|
|
@@ -48,6 +49,15 @@ declare const UpdateMembershipCommand_base: {
|
|
|
48
49
|
* },
|
|
49
50
|
* roleArn: "STRING_VALUE",
|
|
50
51
|
* },
|
|
52
|
+
* defaultJobResultConfiguration: { // MembershipProtectedJobResultConfiguration
|
|
53
|
+
* outputConfiguration: { // MembershipProtectedJobOutputConfiguration Union: only one key present
|
|
54
|
+
* s3: { // ProtectedJobS3OutputConfigurationInput
|
|
55
|
+
* bucket: "STRING_VALUE", // required
|
|
56
|
+
* keyPrefix: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
59
|
+
* roleArn: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
51
61
|
* };
|
|
52
62
|
* const command = new UpdateMembershipCommand(input);
|
|
53
63
|
* const response = await client.send(command);
|
|
@@ -64,14 +74,15 @@ declare const UpdateMembershipCommand_base: {
|
|
|
64
74
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
65
75
|
* // status: "STRING_VALUE", // required
|
|
66
76
|
* // memberAbilities: [ // MemberAbilities // required
|
|
67
|
-
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
77
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
68
78
|
* // ],
|
|
69
79
|
* // mlMemberAbilities: { // MLMemberAbilities
|
|
70
80
|
* // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
71
81
|
* // "CAN_RECEIVE_MODEL_OUTPUT" || "CAN_RECEIVE_INFERENCE_OUTPUT",
|
|
72
82
|
* // ],
|
|
73
83
|
* // },
|
|
74
|
-
* // queryLogStatus: "
|
|
84
|
+
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
85
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
75
86
|
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
|
|
76
87
|
* // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
|
|
77
88
|
* // s3: { // ProtectedQueryS3OutputConfiguration
|
|
@@ -83,6 +94,15 @@ declare const UpdateMembershipCommand_base: {
|
|
|
83
94
|
* // },
|
|
84
95
|
* // roleArn: "STRING_VALUE",
|
|
85
96
|
* // },
|
|
97
|
+
* // defaultJobResultConfiguration: { // MembershipProtectedJobResultConfiguration
|
|
98
|
+
* // outputConfiguration: { // MembershipProtectedJobOutputConfiguration Union: only one key present
|
|
99
|
+
* // s3: { // ProtectedJobS3OutputConfigurationInput
|
|
100
|
+
* // bucket: "STRING_VALUE", // required
|
|
101
|
+
* // keyPrefix: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // },
|
|
104
|
+
* // roleArn: "STRING_VALUE", // required
|
|
105
|
+
* // },
|
|
86
106
|
* // paymentConfiguration: { // MembershipPaymentConfiguration
|
|
87
107
|
* // queryCompute: { // MembershipQueryComputePaymentConfig
|
|
88
108
|
* // isResponsible: true || false, // required
|
|
@@ -95,6 +115,9 @@ declare const UpdateMembershipCommand_base: {
|
|
|
95
115
|
* // isResponsible: true || false, // required
|
|
96
116
|
* // },
|
|
97
117
|
* // },
|
|
118
|
+
* // jobCompute: { // MembershipJobComputePaymentConfig
|
|
119
|
+
* // isResponsible: true || false, // required
|
|
120
|
+
* // },
|
|
98
121
|
* // },
|
|
99
122
|
* // },
|
|
100
123
|
* // };
|