@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
|
@@ -130,6 +130,104 @@ declare const BatchGetSchemaAnalysisRuleCommand_base: {
|
|
|
130
130
|
* // },
|
|
131
131
|
* // },
|
|
132
132
|
* // },
|
|
133
|
+
* // collaborationPolicy: { // ConfiguredTableAssociationAnalysisRulePolicy Union: only one key present
|
|
134
|
+
* // v1: { // ConfiguredTableAssociationAnalysisRulePolicyV1 Union: only one key present
|
|
135
|
+
* // list: { // ConfiguredTableAssociationAnalysisRuleList
|
|
136
|
+
* // allowedResultReceivers: [ // AllowedResultReceivers
|
|
137
|
+
* // "STRING_VALUE",
|
|
138
|
+
* // ],
|
|
139
|
+
* // allowedAdditionalAnalyses: [ // AllowedAdditionalAnalyses
|
|
140
|
+
* // "STRING_VALUE",
|
|
141
|
+
* // ],
|
|
142
|
+
* // },
|
|
143
|
+
* // aggregation: { // ConfiguredTableAssociationAnalysisRuleAggregation
|
|
144
|
+
* // allowedResultReceivers: [
|
|
145
|
+
* // "STRING_VALUE",
|
|
146
|
+
* // ],
|
|
147
|
+
* // allowedAdditionalAnalyses: [
|
|
148
|
+
* // "STRING_VALUE",
|
|
149
|
+
* // ],
|
|
150
|
+
* // },
|
|
151
|
+
* // custom: { // ConfiguredTableAssociationAnalysisRuleCustom
|
|
152
|
+
* // allowedResultReceivers: [
|
|
153
|
+
* // "STRING_VALUE",
|
|
154
|
+
* // ],
|
|
155
|
+
* // allowedAdditionalAnalyses: [
|
|
156
|
+
* // "STRING_VALUE",
|
|
157
|
+
* // ],
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // },
|
|
161
|
+
* // consolidatedPolicy: { // ConsolidatedPolicy Union: only one key present
|
|
162
|
+
* // v1: { // ConsolidatedPolicyV1 Union: only one key present
|
|
163
|
+
* // list: { // ConsolidatedPolicyList
|
|
164
|
+
* // joinColumns: "<AnalysisRuleColumnList>", // required
|
|
165
|
+
* // allowedJoinOperators: [
|
|
166
|
+
* // "STRING_VALUE",
|
|
167
|
+
* // ],
|
|
168
|
+
* // listColumns: "<AnalysisRuleColumnList>", // required
|
|
169
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
170
|
+
* // allowedResultReceivers: [
|
|
171
|
+
* // "STRING_VALUE",
|
|
172
|
+
* // ],
|
|
173
|
+
* // allowedAdditionalAnalyses: [
|
|
174
|
+
* // "STRING_VALUE",
|
|
175
|
+
* // ],
|
|
176
|
+
* // },
|
|
177
|
+
* // aggregation: { // ConsolidatedPolicyAggregation
|
|
178
|
+
* // aggregateColumns: [ // required
|
|
179
|
+
* // {
|
|
180
|
+
* // columnNames: [ // required
|
|
181
|
+
* // "STRING_VALUE",
|
|
182
|
+
* // ],
|
|
183
|
+
* // function: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // ],
|
|
186
|
+
* // joinColumns: "<AnalysisRuleColumnList>", // required
|
|
187
|
+
* // joinRequired: "STRING_VALUE",
|
|
188
|
+
* // allowedJoinOperators: [
|
|
189
|
+
* // "STRING_VALUE",
|
|
190
|
+
* // ],
|
|
191
|
+
* // dimensionColumns: "<AnalysisRuleColumnList>", // required
|
|
192
|
+
* // scalarFunctions: [ // required
|
|
193
|
+
* // "STRING_VALUE",
|
|
194
|
+
* // ],
|
|
195
|
+
* // outputConstraints: [ // required
|
|
196
|
+
* // {
|
|
197
|
+
* // columnName: "STRING_VALUE", // required
|
|
198
|
+
* // minimum: Number("int"), // required
|
|
199
|
+
* // type: "STRING_VALUE", // required
|
|
200
|
+
* // },
|
|
201
|
+
* // ],
|
|
202
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
203
|
+
* // allowedResultReceivers: [
|
|
204
|
+
* // "STRING_VALUE",
|
|
205
|
+
* // ],
|
|
206
|
+
* // allowedAdditionalAnalyses: [
|
|
207
|
+
* // "STRING_VALUE",
|
|
208
|
+
* // ],
|
|
209
|
+
* // },
|
|
210
|
+
* // custom: { // ConsolidatedPolicyCustom
|
|
211
|
+
* // allowedAnalyses: [ // required
|
|
212
|
+
* // "STRING_VALUE",
|
|
213
|
+
* // ],
|
|
214
|
+
* // allowedAnalysisProviders: [
|
|
215
|
+
* // "STRING_VALUE",
|
|
216
|
+
* // ],
|
|
217
|
+
* // additionalAnalyses: "ALLOWED" || "REQUIRED" || "NOT_ALLOWED",
|
|
218
|
+
* // disallowedOutputColumns: "<AnalysisRuleColumnList>",
|
|
219
|
+
* // differentialPrivacy: {
|
|
220
|
+
* // columns: [ // required
|
|
221
|
+
* // {
|
|
222
|
+
* // name: "STRING_VALUE", // required
|
|
223
|
+
* // },
|
|
224
|
+
* // ],
|
|
225
|
+
* // },
|
|
226
|
+
* // allowedResultReceivers: "<AllowedResultReceivers>",
|
|
227
|
+
* // allowedAdditionalAnalyses: "<AllowedAdditionalAnalyses>",
|
|
228
|
+
* // },
|
|
229
|
+
* // },
|
|
230
|
+
* // },
|
|
133
231
|
* // },
|
|
134
232
|
* // ],
|
|
135
233
|
* // errors: [ // BatchGetSchemaAnalysisRuleErrorList // required
|
|
@@ -60,7 +60,10 @@ declare const BatchGetSchemaCommand_base: {
|
|
|
60
60
|
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
|
|
61
61
|
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
|
|
62
62
|
* // ],
|
|
63
|
-
* // analysisMethod: "DIRECT_QUERY",
|
|
63
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE",
|
|
64
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
65
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
66
|
+
* // ],
|
|
64
67
|
* // creatorAccountId: "STRING_VALUE", // required
|
|
65
68
|
* // name: "STRING_VALUE", // required
|
|
66
69
|
* // collaborationId: "STRING_VALUE", // required
|
|
@@ -38,9 +38,26 @@ declare const CreateAnalysisTemplateCommand_base: {
|
|
|
38
38
|
* description: "STRING_VALUE",
|
|
39
39
|
* membershipIdentifier: "STRING_VALUE", // required
|
|
40
40
|
* name: "STRING_VALUE", // required
|
|
41
|
-
* format: "SQL", // required
|
|
41
|
+
* format: "SQL" || "PYSPARK_1_0", // required
|
|
42
42
|
* source: { // AnalysisSource Union: only one key present
|
|
43
43
|
* text: "STRING_VALUE",
|
|
44
|
+
* artifacts: { // AnalysisTemplateArtifacts
|
|
45
|
+
* entryPoint: { // AnalysisTemplateArtifact
|
|
46
|
+
* location: { // S3Location
|
|
47
|
+
* bucket: "STRING_VALUE", // required
|
|
48
|
+
* key: "STRING_VALUE", // required
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* additionalArtifacts: [ // AnalysisTemplateArtifactList
|
|
52
|
+
* {
|
|
53
|
+
* location: {
|
|
54
|
+
* bucket: "STRING_VALUE", // required
|
|
55
|
+
* key: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* },
|
|
58
|
+
* ],
|
|
59
|
+
* roleArn: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
44
61
|
* },
|
|
45
62
|
* tags: { // TagMap
|
|
46
63
|
* "<keys>": "STRING_VALUE",
|
|
@@ -52,6 +69,11 @@ declare const CreateAnalysisTemplateCommand_base: {
|
|
|
52
69
|
* defaultValue: "STRING_VALUE",
|
|
53
70
|
* },
|
|
54
71
|
* ],
|
|
72
|
+
* schema: { // AnalysisSchema
|
|
73
|
+
* referencedTables: [ // QueryTables
|
|
74
|
+
* "STRING_VALUE",
|
|
75
|
+
* ],
|
|
76
|
+
* },
|
|
55
77
|
* };
|
|
56
78
|
* const command = new CreateAnalysisTemplateCommand(input);
|
|
57
79
|
* const response = await client.send(command);
|
|
@@ -72,9 +94,38 @@ declare const CreateAnalysisTemplateCommand_base: {
|
|
|
72
94
|
* // "STRING_VALUE",
|
|
73
95
|
* // ],
|
|
74
96
|
* // },
|
|
75
|
-
* // format: "SQL", // required
|
|
97
|
+
* // format: "SQL" || "PYSPARK_1_0", // required
|
|
76
98
|
* // source: { // AnalysisSource Union: only one key present
|
|
77
99
|
* // text: "STRING_VALUE",
|
|
100
|
+
* // artifacts: { // AnalysisTemplateArtifacts
|
|
101
|
+
* // entryPoint: { // AnalysisTemplateArtifact
|
|
102
|
+
* // location: { // S3Location
|
|
103
|
+
* // bucket: "STRING_VALUE", // required
|
|
104
|
+
* // key: "STRING_VALUE", // required
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // additionalArtifacts: [ // AnalysisTemplateArtifactList
|
|
108
|
+
* // {
|
|
109
|
+
* // location: {
|
|
110
|
+
* // bucket: "STRING_VALUE", // required
|
|
111
|
+
* // key: "STRING_VALUE", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // roleArn: "STRING_VALUE", // required
|
|
116
|
+
* // },
|
|
117
|
+
* // },
|
|
118
|
+
* // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present
|
|
119
|
+
* // artifacts: { // AnalysisTemplateArtifactMetadata
|
|
120
|
+
* // entryPointHash: { // Hash
|
|
121
|
+
* // sha256: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
123
|
+
* // additionalArtifactHashes: [ // HashList
|
|
124
|
+
* // {
|
|
125
|
+
* // sha256: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
127
|
+
* // ],
|
|
128
|
+
* // },
|
|
78
129
|
* // },
|
|
79
130
|
* // analysisParameters: [ // AnalysisParameterList
|
|
80
131
|
* // { // AnalysisParameter
|
|
@@ -39,7 +39,7 @@ declare const CreateCollaborationCommand_base: {
|
|
|
39
39
|
* { // MemberSpecification
|
|
40
40
|
* accountId: "STRING_VALUE", // required
|
|
41
41
|
* memberAbilities: [ // MemberAbilities // required
|
|
42
|
-
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
42
|
+
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
43
43
|
* ],
|
|
44
44
|
* mlMemberAbilities: { // MLMemberAbilities
|
|
45
45
|
* customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
@@ -59,13 +59,16 @@ declare const CreateCollaborationCommand_base: {
|
|
|
59
59
|
* isResponsible: true || false, // required
|
|
60
60
|
* },
|
|
61
61
|
* },
|
|
62
|
+
* jobCompute: { // JobComputePaymentConfig
|
|
63
|
+
* isResponsible: true || false, // required
|
|
64
|
+
* },
|
|
62
65
|
* },
|
|
63
66
|
* },
|
|
64
67
|
* ],
|
|
65
68
|
* name: "STRING_VALUE", // required
|
|
66
69
|
* description: "STRING_VALUE", // required
|
|
67
70
|
* creatorMemberAbilities: [ // required
|
|
68
|
-
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
71
|
+
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
69
72
|
* ],
|
|
70
73
|
* creatorMLMemberAbilities: {
|
|
71
74
|
* customMLMemberAbilities: [ // required
|
|
@@ -80,6 +83,7 @@ declare const CreateCollaborationCommand_base: {
|
|
|
80
83
|
* preserveNulls: true || false, // required
|
|
81
84
|
* },
|
|
82
85
|
* queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
86
|
+
* jobLogStatus: "ENABLED" || "DISABLED",
|
|
83
87
|
* tags: { // TagMap
|
|
84
88
|
* "<keys>": "STRING_VALUE",
|
|
85
89
|
* },
|
|
@@ -95,6 +99,9 @@ declare const CreateCollaborationCommand_base: {
|
|
|
95
99
|
* isResponsible: true || false, // required
|
|
96
100
|
* },
|
|
97
101
|
* },
|
|
102
|
+
* jobCompute: {
|
|
103
|
+
* isResponsible: true || false, // required
|
|
104
|
+
* },
|
|
98
105
|
* },
|
|
99
106
|
* analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
100
107
|
* };
|
|
@@ -120,6 +127,7 @@ declare const CreateCollaborationCommand_base: {
|
|
|
120
127
|
* // preserveNulls: true || false, // required
|
|
121
128
|
* // },
|
|
122
129
|
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
130
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
123
131
|
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
124
132
|
* // },
|
|
125
133
|
* // };
|
|
@@ -203,6 +203,9 @@ declare const CreateConfiguredTableAnalysisRuleCommand_base: {
|
|
|
203
203
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
204
204
|
* <p>Request references a resource which does not exist.</p>
|
|
205
205
|
*
|
|
206
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
207
|
+
* <p>Request denied because service quota has been exceeded.</p>
|
|
208
|
+
*
|
|
206
209
|
* @throws {@link ThrottlingException} (client fault)
|
|
207
210
|
* <p>Request was denied due to request throttling.</p>
|
|
208
211
|
*
|
|
@@ -67,7 +67,10 @@ declare const CreateConfiguredTableCommand_base: {
|
|
|
67
67
|
* allowedColumns: [ // AllowedColumnList // required
|
|
68
68
|
* "STRING_VALUE",
|
|
69
69
|
* ],
|
|
70
|
-
* analysisMethod: "DIRECT_QUERY", // required
|
|
70
|
+
* analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
|
|
71
|
+
* selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
72
|
+
* "DIRECT_QUERY" || "DIRECT_JOB",
|
|
73
|
+
* ],
|
|
71
74
|
* tags: { // TagMap
|
|
72
75
|
* "<keys>": "STRING_VALUE",
|
|
73
76
|
* },
|
|
@@ -112,10 +115,13 @@ declare const CreateConfiguredTableCommand_base: {
|
|
|
112
115
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
113
116
|
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
114
117
|
* // ],
|
|
115
|
-
* // analysisMethod: "DIRECT_QUERY", // required
|
|
118
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
|
|
116
119
|
* // allowedColumns: [ // AllowedColumnList // required
|
|
117
120
|
* // "STRING_VALUE",
|
|
118
121
|
* // ],
|
|
122
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
123
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
124
|
+
* // ],
|
|
119
125
|
* // },
|
|
120
126
|
* // };
|
|
121
127
|
*
|
|
@@ -37,7 +37,8 @@ declare const CreateMembershipCommand_base: {
|
|
|
37
37
|
* const client = new CleanRoomsClient(config);
|
|
38
38
|
* const input = { // CreateMembershipInput
|
|
39
39
|
* collaborationIdentifier: "STRING_VALUE", // required
|
|
40
|
-
* queryLogStatus: "
|
|
40
|
+
* queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
41
|
+
* jobLogStatus: "ENABLED" || "DISABLED",
|
|
41
42
|
* tags: { // TagMap
|
|
42
43
|
* "<keys>": "STRING_VALUE",
|
|
43
44
|
* },
|
|
@@ -52,6 +53,15 @@ declare const CreateMembershipCommand_base: {
|
|
|
52
53
|
* },
|
|
53
54
|
* roleArn: "STRING_VALUE",
|
|
54
55
|
* },
|
|
56
|
+
* defaultJobResultConfiguration: { // MembershipProtectedJobResultConfiguration
|
|
57
|
+
* outputConfiguration: { // MembershipProtectedJobOutputConfiguration Union: only one key present
|
|
58
|
+
* s3: { // ProtectedJobS3OutputConfigurationInput
|
|
59
|
+
* bucket: "STRING_VALUE", // required
|
|
60
|
+
* keyPrefix: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* roleArn: "STRING_VALUE", // required
|
|
64
|
+
* },
|
|
55
65
|
* paymentConfiguration: { // MembershipPaymentConfiguration
|
|
56
66
|
* queryCompute: { // MembershipQueryComputePaymentConfig
|
|
57
67
|
* isResponsible: true || false, // required
|
|
@@ -64,6 +74,9 @@ declare const CreateMembershipCommand_base: {
|
|
|
64
74
|
* isResponsible: true || false, // required
|
|
65
75
|
* },
|
|
66
76
|
* },
|
|
77
|
+
* jobCompute: { // MembershipJobComputePaymentConfig
|
|
78
|
+
* isResponsible: true || false, // required
|
|
79
|
+
* },
|
|
67
80
|
* },
|
|
68
81
|
* };
|
|
69
82
|
* const command = new CreateMembershipCommand(input);
|
|
@@ -81,14 +94,15 @@ declare const CreateMembershipCommand_base: {
|
|
|
81
94
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
82
95
|
* // status: "STRING_VALUE", // required
|
|
83
96
|
* // memberAbilities: [ // MemberAbilities // required
|
|
84
|
-
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
97
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
85
98
|
* // ],
|
|
86
99
|
* // mlMemberAbilities: { // MLMemberAbilities
|
|
87
100
|
* // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
88
101
|
* // "CAN_RECEIVE_MODEL_OUTPUT" || "CAN_RECEIVE_INFERENCE_OUTPUT",
|
|
89
102
|
* // ],
|
|
90
103
|
* // },
|
|
91
|
-
* // queryLogStatus: "
|
|
104
|
+
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
105
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
92
106
|
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
|
|
93
107
|
* // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
|
|
94
108
|
* // s3: { // ProtectedQueryS3OutputConfiguration
|
|
@@ -100,6 +114,15 @@ declare const CreateMembershipCommand_base: {
|
|
|
100
114
|
* // },
|
|
101
115
|
* // roleArn: "STRING_VALUE",
|
|
102
116
|
* // },
|
|
117
|
+
* // defaultJobResultConfiguration: { // MembershipProtectedJobResultConfiguration
|
|
118
|
+
* // outputConfiguration: { // MembershipProtectedJobOutputConfiguration Union: only one key present
|
|
119
|
+
* // s3: { // ProtectedJobS3OutputConfigurationInput
|
|
120
|
+
* // bucket: "STRING_VALUE", // required
|
|
121
|
+
* // keyPrefix: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // roleArn: "STRING_VALUE", // required
|
|
125
|
+
* // },
|
|
103
126
|
* // paymentConfiguration: { // MembershipPaymentConfiguration
|
|
104
127
|
* // queryCompute: { // MembershipQueryComputePaymentConfig
|
|
105
128
|
* // isResponsible: true || false, // required
|
|
@@ -112,6 +135,9 @@ declare const CreateMembershipCommand_base: {
|
|
|
112
135
|
* // isResponsible: true || false, // required
|
|
113
136
|
* // },
|
|
114
137
|
* // },
|
|
138
|
+
* // jobCompute: { // MembershipJobComputePaymentConfig
|
|
139
|
+
* // isResponsible: true || false, // required
|
|
140
|
+
* // },
|
|
115
141
|
* // },
|
|
116
142
|
* // },
|
|
117
143
|
* // };
|
|
@@ -57,9 +57,38 @@ declare const GetAnalysisTemplateCommand_base: {
|
|
|
57
57
|
* // "STRING_VALUE",
|
|
58
58
|
* // ],
|
|
59
59
|
* // },
|
|
60
|
-
* // format: "SQL", // required
|
|
60
|
+
* // format: "SQL" || "PYSPARK_1_0", // required
|
|
61
61
|
* // source: { // AnalysisSource Union: only one key present
|
|
62
62
|
* // text: "STRING_VALUE",
|
|
63
|
+
* // artifacts: { // AnalysisTemplateArtifacts
|
|
64
|
+
* // entryPoint: { // AnalysisTemplateArtifact
|
|
65
|
+
* // location: { // S3Location
|
|
66
|
+
* // bucket: "STRING_VALUE", // required
|
|
67
|
+
* // key: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // additionalArtifacts: [ // AnalysisTemplateArtifactList
|
|
71
|
+
* // {
|
|
72
|
+
* // location: {
|
|
73
|
+
* // bucket: "STRING_VALUE", // required
|
|
74
|
+
* // key: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // roleArn: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present
|
|
82
|
+
* // artifacts: { // AnalysisTemplateArtifactMetadata
|
|
83
|
+
* // entryPointHash: { // Hash
|
|
84
|
+
* // sha256: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // additionalArtifactHashes: [ // HashList
|
|
87
|
+
* // {
|
|
88
|
+
* // sha256: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // },
|
|
63
92
|
* // },
|
|
64
93
|
* // analysisParameters: [ // AnalysisParameterList
|
|
65
94
|
* // { // AnalysisParameter
|
|
@@ -56,9 +56,38 @@ declare const GetCollaborationAnalysisTemplateCommand_base: {
|
|
|
56
56
|
* // "STRING_VALUE",
|
|
57
57
|
* // ],
|
|
58
58
|
* // },
|
|
59
|
-
* // format: "SQL", // required
|
|
59
|
+
* // format: "SQL" || "PYSPARK_1_0", // required
|
|
60
60
|
* // source: { // AnalysisSource Union: only one key present
|
|
61
61
|
* // text: "STRING_VALUE",
|
|
62
|
+
* // artifacts: { // AnalysisTemplateArtifacts
|
|
63
|
+
* // entryPoint: { // AnalysisTemplateArtifact
|
|
64
|
+
* // location: { // S3Location
|
|
65
|
+
* // bucket: "STRING_VALUE", // required
|
|
66
|
+
* // key: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // additionalArtifacts: [ // AnalysisTemplateArtifactList
|
|
70
|
+
* // {
|
|
71
|
+
* // location: {
|
|
72
|
+
* // bucket: "STRING_VALUE", // required
|
|
73
|
+
* // key: "STRING_VALUE", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // roleArn: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present
|
|
81
|
+
* // artifacts: { // AnalysisTemplateArtifactMetadata
|
|
82
|
+
* // entryPointHash: { // Hash
|
|
83
|
+
* // sha256: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // additionalArtifactHashes: [ // HashList
|
|
86
|
+
* // {
|
|
87
|
+
* // sha256: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // },
|
|
62
91
|
* // },
|
|
63
92
|
* // analysisParameters: [ // AnalysisParameterList
|
|
64
93
|
* // { // AnalysisParameter
|
|
@@ -59,6 +59,7 @@ declare const GetCollaborationCommand_base: {
|
|
|
59
59
|
* // preserveNulls: true || false, // required
|
|
60
60
|
* // },
|
|
61
61
|
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
62
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
62
63
|
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
63
64
|
* // },
|
|
64
65
|
* // };
|
|
@@ -77,10 +77,13 @@ declare const GetConfiguredTableCommand_base: {
|
|
|
77
77
|
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
|
|
78
78
|
* // "AGGREGATION" || "LIST" || "CUSTOM",
|
|
79
79
|
* // ],
|
|
80
|
-
* // analysisMethod: "DIRECT_QUERY", // required
|
|
80
|
+
* // analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
|
|
81
81
|
* // allowedColumns: [ // AllowedColumnList // required
|
|
82
82
|
* // "STRING_VALUE",
|
|
83
83
|
* // ],
|
|
84
|
+
* // selectedAnalysisMethods: [ // SelectedAnalysisMethods
|
|
85
|
+
* // "DIRECT_QUERY" || "DIRECT_JOB",
|
|
86
|
+
* // ],
|
|
84
87
|
* // },
|
|
85
88
|
* // };
|
|
86
89
|
*
|
|
@@ -52,14 +52,15 @@ declare const GetMembershipCommand_base: {
|
|
|
52
52
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
53
53
|
* // status: "STRING_VALUE", // required
|
|
54
54
|
* // memberAbilities: [ // MemberAbilities // required
|
|
55
|
-
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
|
|
55
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
56
56
|
* // ],
|
|
57
57
|
* // mlMemberAbilities: { // MLMemberAbilities
|
|
58
58
|
* // customMLMemberAbilities: [ // CustomMLMemberAbilities // required
|
|
59
59
|
* // "CAN_RECEIVE_MODEL_OUTPUT" || "CAN_RECEIVE_INFERENCE_OUTPUT",
|
|
60
60
|
* // ],
|
|
61
61
|
* // },
|
|
62
|
-
* // queryLogStatus: "
|
|
62
|
+
* // queryLogStatus: "ENABLED" || "DISABLED", // required
|
|
63
|
+
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
63
64
|
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
|
|
64
65
|
* // outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
|
|
65
66
|
* // s3: { // ProtectedQueryS3OutputConfiguration
|
|
@@ -71,6 +72,15 @@ declare const GetMembershipCommand_base: {
|
|
|
71
72
|
* // },
|
|
72
73
|
* // roleArn: "STRING_VALUE",
|
|
73
74
|
* // },
|
|
75
|
+
* // defaultJobResultConfiguration: { // MembershipProtectedJobResultConfiguration
|
|
76
|
+
* // outputConfiguration: { // MembershipProtectedJobOutputConfiguration Union: only one key present
|
|
77
|
+
* // s3: { // ProtectedJobS3OutputConfigurationInput
|
|
78
|
+
* // bucket: "STRING_VALUE", // required
|
|
79
|
+
* // keyPrefix: "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // roleArn: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
74
84
|
* // paymentConfiguration: { // MembershipPaymentConfiguration
|
|
75
85
|
* // queryCompute: { // MembershipQueryComputePaymentConfig
|
|
76
86
|
* // isResponsible: true || false, // required
|
|
@@ -83,6 +93,9 @@ declare const GetMembershipCommand_base: {
|
|
|
83
93
|
* // isResponsible: true || false, // required
|
|
84
94
|
* // },
|
|
85
95
|
* // },
|
|
96
|
+
* // jobCompute: { // MembershipJobComputePaymentConfig
|
|
97
|
+
* // isResponsible: true || false, // required
|
|
98
|
+
* // },
|
|
86
99
|
* // },
|
|
87
100
|
* // },
|
|
88
101
|
* // };
|
|
@@ -0,0 +1,130 @@
|
|
|
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 { GetProtectedJobInput } from "../models/models_0";
|
|
5
|
+
import { GetProtectedJobOutput } from "../models/models_1";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link GetProtectedJobCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface GetProtectedJobCommandInput extends GetProtectedJobInput {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link GetProtectedJobCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface GetProtectedJobCommandOutput extends GetProtectedJobOutput, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const GetProtectedJobCommand_base: {
|
|
26
|
+
new (input: GetProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetProtectedJobCommandInput, GetProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (__0_0: GetProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetProtectedJobCommandInput, GetProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Returns job processing metadata.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CleanRoomsClient, GetProtectedJobCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
36
|
+
* // const { CleanRoomsClient, GetProtectedJobCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
37
|
+
* const client = new CleanRoomsClient(config);
|
|
38
|
+
* const input = { // GetProtectedJobInput
|
|
39
|
+
* membershipIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* protectedJobIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetProtectedJobCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetProtectedJobOutput
|
|
45
|
+
* // protectedJob: { // ProtectedJob
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // membershipId: "STRING_VALUE", // required
|
|
48
|
+
* // membershipArn: "STRING_VALUE", // required
|
|
49
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // jobParameters: { // ProtectedJobParameters
|
|
51
|
+
* // analysisTemplateArn: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS", // required
|
|
54
|
+
* // resultConfiguration: { // ProtectedJobResultConfigurationOutput
|
|
55
|
+
* // outputConfiguration: { // ProtectedJobOutputConfigurationOutput Union: only one key present
|
|
56
|
+
* // s3: { // ProtectedJobS3OutputConfigurationOutput
|
|
57
|
+
* // bucket: "STRING_VALUE", // required
|
|
58
|
+
* // keyPrefix: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // member: { // ProtectedJobMemberOutputConfigurationOutput
|
|
61
|
+
* // accountId: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // statistics: { // ProtectedJobStatistics
|
|
66
|
+
* // totalDurationInMillis: Number("long"),
|
|
67
|
+
* // billedResourceUtilization: { // BilledJobResourceUtilization
|
|
68
|
+
* // units: Number("double"), // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // result: { // ProtectedJobResult
|
|
72
|
+
* // output: { // ProtectedJobOutput Union: only one key present
|
|
73
|
+
* // s3: { // ProtectedJobS3Output
|
|
74
|
+
* // location: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // memberList: [ // ProtectedJobMemberOutputList
|
|
77
|
+
* // { // ProtectedJobSingleMemberOutput
|
|
78
|
+
* // accountId: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // error: { // ProtectedJobError
|
|
84
|
+
* // message: "STRING_VALUE", // required
|
|
85
|
+
* // code: "STRING_VALUE", // required
|
|
86
|
+
* // },
|
|
87
|
+
* // },
|
|
88
|
+
* // };
|
|
89
|
+
*
|
|
90
|
+
* ```
|
|
91
|
+
*
|
|
92
|
+
* @param GetProtectedJobCommandInput - {@link GetProtectedJobCommandInput}
|
|
93
|
+
* @returns {@link GetProtectedJobCommandOutput}
|
|
94
|
+
* @see {@link GetProtectedJobCommandInput} for command's `input` shape.
|
|
95
|
+
* @see {@link GetProtectedJobCommandOutput} for command's `response` shape.
|
|
96
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
99
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link InternalServerException} (server fault)
|
|
102
|
+
* <p>Unexpected error during processing of request.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
105
|
+
* <p>Request references a resource which does not exist.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
108
|
+
* <p>Request was denied due to request throttling.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ValidationException} (client fault)
|
|
111
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link CleanRoomsServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
115
|
+
*
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export declare class GetProtectedJobCommand extends GetProtectedJobCommand_base {
|
|
119
|
+
/** @internal type navigation helper, not in runtime. */
|
|
120
|
+
protected static __types: {
|
|
121
|
+
api: {
|
|
122
|
+
input: GetProtectedJobInput;
|
|
123
|
+
output: GetProtectedJobOutput;
|
|
124
|
+
};
|
|
125
|
+
sdk: {
|
|
126
|
+
input: GetProtectedJobCommandInput;
|
|
127
|
+
output: GetProtectedJobCommandOutput;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
}
|
|
@@ -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 { GetProtectedQueryInput, GetProtectedQueryOutput } from "../models/
|
|
4
|
+
import { GetProtectedQueryInput, GetProtectedQueryOutput } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|