Skip to content

Commit f72f1fc

Browse files
author
awstools
committed
feat(client-cleanrooms): This feature provides the ability to update the table reference and allowed columns on an existing configured table.
1 parent b1f31dd commit f72f1fc

File tree

7 files changed

+75
-16
lines changed

7 files changed

+75
-16
lines changed

clients/client-cleanrooms/src/commands/CreatePrivacyBudgetTemplateCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface CreatePrivacyBudgetTemplateCommandInput extends CreatePrivacyBu
3131
export interface CreatePrivacyBudgetTemplateCommandOutput extends CreatePrivacyBudgetTemplateOutput, __MetadataBearer {}
3232

3333
/**
34-
* <p>Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the <a>UpdatePrivacyBudgetTemplate</a> operation.</p>
34+
* <p>Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the <a>UpdatePrivacyBudgetTemplate</a> operation.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

clients/client-cleanrooms/src/commands/DeletePrivacyBudgetTemplateCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface DeletePrivacyBudgetTemplateCommandInput extends DeletePrivacyBu
3131
export interface DeletePrivacyBudgetTemplateCommandOutput extends DeletePrivacyBudgetTemplateOutput, __MetadataBearer {}
3232

3333
/**
34-
* <p>Deletes a privacy budget template for a specified membership.</p>
34+
* <p>Deletes a privacy budget template for a specified collaboration.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

clients/client-cleanrooms/src/commands/UpdateConfiguredTableCommand.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,36 @@ export interface UpdateConfiguredTableCommandOutput extends UpdateConfiguredTabl
3939
* configuredTableIdentifier: "STRING_VALUE", // required
4040
* name: "STRING_VALUE",
4141
* description: "STRING_VALUE",
42+
* tableReference: { // TableReference Union: only one key present
43+
* glue: { // GlueTableReference
44+
* tableName: "STRING_VALUE", // required
45+
* databaseName: "STRING_VALUE", // required
46+
* },
47+
* snowflake: { // SnowflakeTableReference
48+
* secretArn: "STRING_VALUE", // required
49+
* accountIdentifier: "STRING_VALUE", // required
50+
* databaseName: "STRING_VALUE", // required
51+
* tableName: "STRING_VALUE", // required
52+
* schemaName: "STRING_VALUE", // required
53+
* tableSchema: { // SnowflakeTableSchema Union: only one key present
54+
* v1: [ // SnowflakeTableSchemaList
55+
* { // SnowflakeTableSchemaV1
56+
* columnName: "STRING_VALUE", // required
57+
* columnType: "STRING_VALUE", // required
58+
* },
59+
* ],
60+
* },
61+
* },
62+
* athena: { // AthenaTableReference
63+
* workGroup: "STRING_VALUE", // required
64+
* outputLocation: "STRING_VALUE",
65+
* databaseName: "STRING_VALUE", // required
66+
* tableName: "STRING_VALUE", // required
67+
* },
68+
* },
69+
* allowedColumns: [ // AllowedColumnList
70+
* "STRING_VALUE",
71+
* ],
4272
* analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE",
4373
* selectedAnalysisMethods: [ // SelectedAnalysisMethods
4474
* "DIRECT_QUERY" || "DIRECT_JOB",
@@ -114,6 +144,9 @@ export interface UpdateConfiguredTableCommandOutput extends UpdateConfiguredTabl
114144
* @throws {@link ResourceNotFoundException} (client fault)
115145
* <p>Request references a resource which does not exist.</p>
116146
*
147+
* @throws {@link ServiceQuotaExceededException} (client fault)
148+
* <p>Request denied because service quota has been exceeded.</p>
149+
*
117150
* @throws {@link ThrottlingException} (client fault)
118151
* <p>Request was denied due to request throttling.</p>
119152
*

clients/client-cleanrooms/src/commands/UpdatePrivacyBudgetTemplateCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface UpdatePrivacyBudgetTemplateCommandInput extends UpdatePrivacyBu
3131
export interface UpdatePrivacyBudgetTemplateCommandOutput extends UpdatePrivacyBudgetTemplateOutput, __MetadataBearer {}
3232

3333
/**
34-
* <p>Updates the privacy budget template for the specified membership.</p>
34+
* <p>Updates the privacy budget template for the specified collaboration.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

clients/client-cleanrooms/src/models/models_0.ts

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@ export interface CreateAnalysisTemplateInput {
15931593
format: AnalysisFormat | undefined;
15941594

15951595
/**
1596-
* <p>The information in the analysis template. Currently supports <code>text</code>, the query text for the analysis template.</p>
1596+
* <p>The information in the analysis template.</p>
15971597
* @public
15981598
*/
15991599
source: AnalysisSource | undefined;
@@ -2971,7 +2971,7 @@ export interface CreateCollaborationInput {
29712971
creatorPaymentConfiguration?: PaymentConfiguration | undefined;
29722972

29732973
/**
2974-
* <p> The analytics engine.</p>
2974+
* <p> The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>
29752975
* @public
29762976
*/
29772977
analyticsEngine?: AnalyticsEngine | undefined;
@@ -3083,7 +3083,7 @@ export interface Collaboration {
30833083
jobLogStatus?: CollaborationJobLogStatus | undefined;
30843084

30853085
/**
3086-
* <p> The analytics engine for the collaboration.</p>
3086+
* <p> The analytics engine for the collaboration.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>
30873087
* @public
30883088
*/
30893089
analyticsEngine?: AnalyticsEngine | undefined;
@@ -4411,7 +4411,7 @@ export interface CollaborationSummary {
44114411
membershipArn?: string | undefined;
44124412

44134413
/**
4414-
* <p> The analytics engine.</p>
4414+
* <p> The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>
44154415
* @public
44164416
*/
44174417
analyticsEngine?: AnalyticsEngine | undefined;
@@ -4675,7 +4675,7 @@ export interface UpdateCollaborationInput {
46754675
description?: string | undefined;
46764676

46774677
/**
4678-
* <p>The analytics engine.</p>
4678+
* <p>The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>
46794679
* @public
46804680
*/
46814681
analyticsEngine?: AnalyticsEngine | undefined;
@@ -6272,6 +6272,18 @@ export interface UpdateConfiguredTableInput {
62726272
*/
62736273
description?: string | undefined;
62746274

6275+
/**
6276+
* <p>A pointer to the dataset that underlies this table.</p>
6277+
* @public
6278+
*/
6279+
tableReference?: TableReference | undefined;
6280+
6281+
/**
6282+
* <p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>
6283+
* @public
6284+
*/
6285+
allowedColumns?: string[] | undefined;
6286+
62756287
/**
62766288
* <p> The analysis method for the configured table.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
62776289
* @public

clients/client-cleanrooms/src/protocols/Aws_restJson1.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2042,10 +2042,12 @@ export const se_UpdateConfiguredTableCommand = async (
20422042
let body: any;
20432043
body = JSON.stringify(
20442044
take(input, {
2045+
allowedColumns: (_) => _json(_),
20452046
analysisMethod: [],
20462047
description: [],
20472048
name: [],
20482049
selectedAnalysisMethods: (_) => _json(_),
2050+
tableReference: (_) => _json(_),
20492051
})
20502052
);
20512053
b.m("PATCH").h(headers).b(body);

codegen/sdk-codegen/aws-models/cleanrooms.json

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,7 +2493,7 @@
24932493
"analyticsEngine": {
24942494
"target": "com.amazonaws.cleanrooms#AnalyticsEngine",
24952495
"traits": {
2496-
"smithy.api#documentation": "<p> The analytics engine for the collaboration.</p>"
2496+
"smithy.api#documentation": "<p> The analytics engine for the collaboration.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"
24972497
}
24982498
}
24992499
},
@@ -3495,7 +3495,7 @@
34953495
"analyticsEngine": {
34963496
"target": "com.amazonaws.cleanrooms#AnalyticsEngine",
34973497
"traits": {
3498-
"smithy.api#documentation": "<p> The analytics engine.</p>"
3498+
"smithy.api#documentation": "<p> The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"
34993499
}
35003500
}
35013501
},
@@ -4955,7 +4955,7 @@
49554955
"source": {
49564956
"target": "com.amazonaws.cleanrooms#AnalysisSource",
49574957
"traits": {
4958-
"smithy.api#documentation": "<p>The information in the analysis template. Currently supports <code>text</code>, the query text for the analysis template.</p>",
4958+
"smithy.api#documentation": "<p>The information in the analysis template.</p>",
49594959
"smithy.api#required": {}
49604960
}
49614961
},
@@ -5101,7 +5101,7 @@
51015101
"analyticsEngine": {
51025102
"target": "com.amazonaws.cleanrooms#AnalyticsEngine",
51035103
"traits": {
5104-
"smithy.api#documentation": "<p> The analytics engine.</p>"
5104+
"smithy.api#documentation": "<p> The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"
51055105
}
51065106
}
51075107
}
@@ -5950,7 +5950,7 @@
59505950
],
59515951
"traits": {
59525952
"aws.iam#actionPermissionDescription": "Grants permission to create a new privacy budget template",
5953-
"smithy.api#documentation": "<p>Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the <a>UpdatePrivacyBudgetTemplate</a> operation.</p>",
5953+
"smithy.api#documentation": "<p>Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the <a>UpdatePrivacyBudgetTemplate</a> operation.</p>",
59545954
"smithy.api#http": {
59555955
"code": 200,
59565956
"method": "POST",
@@ -6828,7 +6828,7 @@
68286828
],
68296829
"traits": {
68306830
"aws.iam#actionPermissionDescription": "Grants permission to remove a privacy budget from a collaboration",
6831-
"smithy.api#documentation": "<p>Deletes a privacy budget template for a specified membership.</p>",
6831+
"smithy.api#documentation": "<p>Deletes a privacy budget template for a specified collaboration.</p>",
68326832
"smithy.api#http": {
68336833
"code": 204,
68346834
"method": "DELETE",
@@ -15490,7 +15490,7 @@
1549015490
"analyticsEngine": {
1549115491
"target": "com.amazonaws.cleanrooms#AnalyticsEngine",
1549215492
"traits": {
15493-
"smithy.api#documentation": "<p>The analytics engine.</p>"
15493+
"smithy.api#documentation": "<p>The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"
1549415494
}
1549515495
}
1549615496
}
@@ -15616,6 +15616,9 @@
1561615616
{
1561715617
"target": "com.amazonaws.cleanrooms#ResourceNotFoundException"
1561815618
},
15619+
{
15620+
"target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException"
15621+
},
1561915622
{
1562015623
"target": "com.amazonaws.cleanrooms#ThrottlingException"
1562115624
},
@@ -15918,6 +15921,15 @@
1591815921
"smithy.api#documentation": "<p>A new description for the configured table.</p>"
1591915922
}
1592015923
},
15924+
"tableReference": {
15925+
"target": "com.amazonaws.cleanrooms#TableReference"
15926+
},
15927+
"allowedColumns": {
15928+
"target": "com.amazonaws.cleanrooms#AllowedColumnList",
15929+
"traits": {
15930+
"smithy.api#documentation": "<p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>"
15931+
}
15932+
},
1592115933
"analysisMethod": {
1592215934
"target": "com.amazonaws.cleanrooms#AnalysisMethod",
1592315935
"traits": {
@@ -16243,7 +16255,7 @@
1624316255
],
1624416256
"traits": {
1624516257
"aws.iam#actionPermissionDescription": "Grants permission to update a privacy budget template",
16246-
"smithy.api#documentation": "<p>Updates the privacy budget template for the specified membership.</p>",
16258+
"smithy.api#documentation": "<p>Updates the privacy budget template for the specified collaboration.</p>",
1624716259
"smithy.api#http": {
1624816260
"code": 200,
1624916261
"method": "PATCH",

0 commit comments

Comments
 (0)