Skip to content

Commit 2ccb11c

Browse files
author
awstools
committed
feat(client-cleanrooms): This release adds the option for customers to configure analytics engine when creating a collaboration, and introduces the new SPARK analytics engine type in addition to maintaining the legacy CLEAN_ROOMS_SQL engine type.
1 parent aae686f commit 2ccb11c

33 files changed

+803
-411
lines changed

‎clients/client-cleanrooms/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ party getting access to the other party's raw data.</p>
1818

1919
## Installing
2020

21-
To install the this package, simply type add or install @aws-sdk/client-cleanrooms
21+
To install this package, simply type add or install @aws-sdk/client-cleanrooms
2222
using your favorite package manager:
2323

2424
- `npm install @aws-sdk/client-cleanrooms`

‎clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput
7070
* // "STRING_VALUE",
7171
* // ],
7272
* // },
73-
* // format: "STRING_VALUE", // required
73+
* // format: "SQL", // required
7474
* // source: { // AnalysisSource Union: only one key present
7575
* // text: "STRING_VALUE",
7676
* // },
7777
* // analysisParameters: [ // AnalysisParameterList
7878
* // { // AnalysisParameter
7979
* // name: "STRING_VALUE", // required
80-
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
80+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required
8181
* // defaultValue: "STRING_VALUE",
8282
* // },
8383
* // ],

‎clients/client-cleanrooms/src/commands/BatchGetSchemaCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export interface BatchGetSchemaCommandOutput extends BatchGetSchemaOutput, __Met
6161
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
6262
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
6363
* // ],
64-
* // analysisMethod: "STRING_VALUE",
64+
* // analysisMethod: "DIRECT_QUERY",
6565
* // creatorAccountId: "STRING_VALUE", // required
6666
* // name: "STRING_VALUE", // required
6767
* // collaborationId: "STRING_VALUE", // required

‎clients/client-cleanrooms/src/commands/CreateAnalysisTemplateCommand.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
4444
* description: "STRING_VALUE",
4545
* membershipIdentifier: "STRING_VALUE", // required
4646
* name: "STRING_VALUE", // required
47-
* format: "STRING_VALUE", // required
47+
* format: "SQL", // required
4848
* source: { // AnalysisSource Union: only one key present
4949
* text: "STRING_VALUE",
5050
* },
@@ -54,7 +54,7 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
5454
* analysisParameters: [ // AnalysisParameterList
5555
* { // AnalysisParameter
5656
* name: "STRING_VALUE", // required
57-
* type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
57+
* type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required
5858
* defaultValue: "STRING_VALUE",
5959
* },
6060
* ],
@@ -78,14 +78,14 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
7878
* // "STRING_VALUE",
7979
* // ],
8080
* // },
81-
* // format: "STRING_VALUE", // required
81+
* // format: "SQL", // required
8282
* // source: { // AnalysisSource Union: only one key present
8383
* // text: "STRING_VALUE",
8484
* // },
8585
* // analysisParameters: [ // AnalysisParameterList
8686
* // { // AnalysisParameter
8787
* // name: "STRING_VALUE", // required
88-
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
88+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required
8989
* // defaultValue: "STRING_VALUE",
9090
* // },
9191
* // ],

‎clients/client-cleanrooms/src/commands/CreateCollaborationCommand.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
4040
* { // MemberSpecification
4141
* accountId: "STRING_VALUE", // required
4242
* memberAbilities: [ // MemberAbilities // required
43-
* "STRING_VALUE",
43+
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
4444
* ],
4545
* displayName: "STRING_VALUE", // required
4646
* paymentConfiguration: { // PaymentConfiguration
@@ -53,7 +53,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
5353
* name: "STRING_VALUE", // required
5454
* description: "STRING_VALUE", // required
5555
* creatorMemberAbilities: [ // required
56-
* "STRING_VALUE",
56+
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
5757
* ],
5858
* creatorDisplayName: "STRING_VALUE", // required
5959
* dataEncryptionMetadata: { // DataEncryptionMetadata
@@ -62,7 +62,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
6262
* allowJoinsOnColumnsWithDifferentNames: true || false, // required
6363
* preserveNulls: true || false, // required
6464
* },
65-
* queryLogStatus: "STRING_VALUE", // required
65+
* queryLogStatus: "ENABLED" || "DISABLED", // required
6666
* tags: { // TagMap
6767
* "<keys>": "STRING_VALUE",
6868
* },
@@ -71,6 +71,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
7171
* isResponsible: true || false, // required
7272
* },
7373
* },
74+
* analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
7475
* };
7576
* const command = new CreateCollaborationCommand(input);
7677
* const response = await client.send(command);
@@ -93,7 +94,8 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
9394
* // allowJoinsOnColumnsWithDifferentNames: true || false, // required
9495
* // preserveNulls: true || false, // required
9596
* // },
96-
* // queryLogStatus: "STRING_VALUE", // required
97+
* // queryLogStatus: "ENABLED" || "DISABLED", // required
98+
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
9799
* // },
98100
* // };
99101
*

‎clients/client-cleanrooms/src/commands/CreateConfiguredTableCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface CreateConfiguredTableCommandOutput extends CreateConfiguredTabl
4747
* allowedColumns: [ // AllowedColumnList // required
4848
* "STRING_VALUE",
4949
* ],
50-
* analysisMethod: "STRING_VALUE", // required
50+
* analysisMethod: "DIRECT_QUERY", // required
5151
* tags: { // TagMap
5252
* "<keys>": "STRING_VALUE",
5353
* },
@@ -71,7 +71,7 @@ export interface CreateConfiguredTableCommandOutput extends CreateConfiguredTabl
7171
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
7272
* // "AGGREGATION" || "LIST" || "CUSTOM",
7373
* // ],
74-
* // analysisMethod: "STRING_VALUE", // required
74+
* // analysisMethod: "DIRECT_QUERY", // required
7575
* // allowedColumns: [ // AllowedColumnList // required
7676
* // "STRING_VALUE",
7777
* // ],

‎clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
4848
* resultFormat: "STRING_VALUE", // required
4949
* bucket: "STRING_VALUE", // required
5050
* keyPrefix: "STRING_VALUE",
51+
* singleFileOutput: true || false,
5152
* },
5253
* },
5354
* roleArn: "STRING_VALUE",
@@ -73,7 +74,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
7374
* // updateTime: new Date("TIMESTAMP"), // required
7475
* // status: "STRING_VALUE", // required
7576
* // memberAbilities: [ // MemberAbilities // required
76-
* // "STRING_VALUE",
77+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
7778
* // ],
7879
* // queryLogStatus: "STRING_VALUE", // required
7980
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
@@ -82,6 +83,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
8283
* // resultFormat: "STRING_VALUE", // required
8384
* // bucket: "STRING_VALUE", // required
8485
* // keyPrefix: "STRING_VALUE",
86+
* // singleFileOutput: true || false,
8587
* // },
8688
* // },
8789
* // roleArn: "STRING_VALUE",

‎clients/client-cleanrooms/src/commands/DeleteConfiguredTableAssociationAnalysisRuleCommand.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ export interface DeleteConfiguredTableAssociationAnalysisRuleCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Deletes
41-
* an analysis rule for a configured table association.</p>
40+
* <p>Deletes an analysis rule for a configured table association.</p>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
4443
* ```javascript

‎clients/client-cleanrooms/src/commands/GetAnalysisTemplateCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ export interface GetAnalysisTemplateCommandOutput extends GetAnalysisTemplateOut
6262
* // "STRING_VALUE",
6363
* // ],
6464
* // },
65-
* // format: "STRING_VALUE", // required
65+
* // format: "SQL", // required
6666
* // source: { // AnalysisSource Union: only one key present
6767
* // text: "STRING_VALUE",
6868
* // },
6969
* // analysisParameters: [ // AnalysisParameterList
7070
* // { // AnalysisParameter
7171
* // name: "STRING_VALUE", // required
72-
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
72+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required
7373
* // defaultValue: "STRING_VALUE",
7474
* // },
7575
* // ],

‎clients/client-cleanrooms/src/commands/GetCollaborationAnalysisTemplateCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,14 @@ export interface GetCollaborationAnalysisTemplateCommandOutput
6666
* // "STRING_VALUE",
6767
* // ],
6868
* // },
69-
* // format: "STRING_VALUE", // required
69+
* // format: "SQL", // required
7070
* // source: { // AnalysisSource Union: only one key present
7171
* // text: "STRING_VALUE",
7272
* // },
7373
* // analysisParameters: [ // AnalysisParameterList
7474
* // { // AnalysisParameter
7575
* // name: "STRING_VALUE", // required
76-
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
76+
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required
7777
* // defaultValue: "STRING_VALUE",
7878
* // },
7979
* // ],

0 commit comments

Comments
 (0)