Skip to content

Commit

Permalink
feat(client-cleanrooms): This release adds the option for customers t…
Browse files Browse the repository at this point in the history
…o 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.
  • Loading branch information
awstools committed Oct 29, 2024
1 parent aae686f commit 2ccb11c
Show file tree
Hide file tree
Showing 33 changed files with 803 additions and 411 deletions.
2 changes: 1 addition & 1 deletion clients/client-cleanrooms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ party getting access to the other party's raw data.</p>

## Installing

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

- `npm install @aws-sdk/client-cleanrooms`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput
* // "STRING_VALUE",
* // ],
* // },
* // format: "STRING_VALUE", // required
* // format: "SQL", // required
* // source: { // AnalysisSource Union: only one key present
* // text: "STRING_VALUE",
* // },
* // analysisParameters: [ // AnalysisParameterList
* // { // AnalysisParameter
* // name: "STRING_VALUE", // required
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
* // 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
* // defaultValue: "STRING_VALUE",
* // },
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export interface BatchGetSchemaCommandOutput extends BatchGetSchemaOutput, __Met
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
* // ],
* // analysisMethod: "STRING_VALUE",
* // analysisMethod: "DIRECT_QUERY",
* // creatorAccountId: "STRING_VALUE", // required
* // name: "STRING_VALUE", // required
* // collaborationId: "STRING_VALUE", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
* description: "STRING_VALUE",
* membershipIdentifier: "STRING_VALUE", // required
* name: "STRING_VALUE", // required
* format: "STRING_VALUE", // required
* format: "SQL", // required
* source: { // AnalysisSource Union: only one key present
* text: "STRING_VALUE",
* },
Expand All @@ -54,7 +54,7 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
* analysisParameters: [ // AnalysisParameterList
* { // AnalysisParameter
* name: "STRING_VALUE", // required
* type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
* 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
* defaultValue: "STRING_VALUE",
* },
* ],
Expand All @@ -78,14 +78,14 @@ export interface CreateAnalysisTemplateCommandOutput extends CreateAnalysisTempl
* // "STRING_VALUE",
* // ],
* // },
* // format: "STRING_VALUE", // required
* // format: "SQL", // required
* // source: { // AnalysisSource Union: only one key present
* // text: "STRING_VALUE",
* // },
* // analysisParameters: [ // AnalysisParameterList
* // { // AnalysisParameter
* // name: "STRING_VALUE", // required
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
* // 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
* // defaultValue: "STRING_VALUE",
* // },
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
* { // MemberSpecification
* accountId: "STRING_VALUE", // required
* memberAbilities: [ // MemberAbilities // required
* "STRING_VALUE",
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* ],
* displayName: "STRING_VALUE", // required
* paymentConfiguration: { // PaymentConfiguration
Expand All @@ -53,7 +53,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
* name: "STRING_VALUE", // required
* description: "STRING_VALUE", // required
* creatorMemberAbilities: [ // required
* "STRING_VALUE",
* "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* ],
* creatorDisplayName: "STRING_VALUE", // required
* dataEncryptionMetadata: { // DataEncryptionMetadata
Expand All @@ -62,7 +62,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
* allowJoinsOnColumnsWithDifferentNames: true || false, // required
* preserveNulls: true || false, // required
* },
* queryLogStatus: "STRING_VALUE", // required
* queryLogStatus: "ENABLED" || "DISABLED", // required
* tags: { // TagMap
* "<keys>": "STRING_VALUE",
* },
Expand All @@ -71,6 +71,7 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
* isResponsible: true || false, // required
* },
* },
* analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
* };
* const command = new CreateCollaborationCommand(input);
* const response = await client.send(command);
Expand All @@ -93,7 +94,8 @@ export interface CreateCollaborationCommandOutput extends CreateCollaborationOut
* // allowJoinsOnColumnsWithDifferentNames: true || false, // required
* // preserveNulls: true || false, // required
* // },
* // queryLogStatus: "STRING_VALUE", // required
* // queryLogStatus: "ENABLED" || "DISABLED", // required
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface CreateConfiguredTableCommandOutput extends CreateConfiguredTabl
* allowedColumns: [ // AllowedColumnList // required
* "STRING_VALUE",
* ],
* analysisMethod: "STRING_VALUE", // required
* analysisMethod: "DIRECT_QUERY", // required
* tags: { // TagMap
* "<keys>": "STRING_VALUE",
* },
Expand All @@ -71,7 +71,7 @@ export interface CreateConfiguredTableCommandOutput extends CreateConfiguredTabl
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM",
* // ],
* // analysisMethod: "STRING_VALUE", // required
* // analysisMethod: "DIRECT_QUERY", // required
* // allowedColumns: [ // AllowedColumnList // required
* // "STRING_VALUE",
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
* resultFormat: "STRING_VALUE", // required
* bucket: "STRING_VALUE", // required
* keyPrefix: "STRING_VALUE",
* singleFileOutput: true || false,
* },
* },
* roleArn: "STRING_VALUE",
Expand All @@ -73,7 +74,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
* // updateTime: new Date("TIMESTAMP"), // required
* // status: "STRING_VALUE", // required
* // memberAbilities: [ // MemberAbilities // required
* // "STRING_VALUE",
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* // ],
* // queryLogStatus: "STRING_VALUE", // required
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
Expand All @@ -82,6 +83,7 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
* // resultFormat: "STRING_VALUE", // required
* // bucket: "STRING_VALUE", // required
* // keyPrefix: "STRING_VALUE",
* // singleFileOutput: true || false,
* // },
* // },
* // roleArn: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface DeleteConfiguredTableAssociationAnalysisRuleCommandOutput
__MetadataBearer {}

/**
* <p>Deletes
* an analysis rule for a configured table association.</p>
* <p>Deletes an analysis rule for a configured table association.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,14 @@ export interface GetAnalysisTemplateCommandOutput extends GetAnalysisTemplateOut
* // "STRING_VALUE",
* // ],
* // },
* // format: "STRING_VALUE", // required
* // format: "SQL", // required
* // source: { // AnalysisSource Union: only one key present
* // text: "STRING_VALUE",
* // },
* // analysisParameters: [ // AnalysisParameterList
* // { // AnalysisParameter
* // name: "STRING_VALUE", // required
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
* // 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
* // defaultValue: "STRING_VALUE",
* // },
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ export interface GetCollaborationAnalysisTemplateCommandOutput
* // "STRING_VALUE",
* // ],
* // },
* // format: "STRING_VALUE", // required
* // format: "SQL", // required
* // source: { // AnalysisSource Union: only one key present
* // text: "STRING_VALUE",
* // },
* // analysisParameters: [ // AnalysisParameterList
* // { // AnalysisParameter
* // name: "STRING_VALUE", // required
* // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE", // required
* // 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
* // defaultValue: "STRING_VALUE",
* // },
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ export interface GetCollaborationCommandOutput extends GetCollaborationOutput, _
* // allowJoinsOnColumnsWithDifferentNames: true || false, // required
* // preserveNulls: true || false, // required
* // },
* // queryLogStatus: "STRING_VALUE", // required
* // queryLogStatus: "ENABLED" || "DISABLED", // required
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ export interface GetConfiguredTableAssociationAnalysisRuleCommandOutput
__MetadataBearer {}

/**
* <p>
* Retrieves
* the analysis rule for a configured table association.</p>
* <p> Retrieves the analysis rule for a configured table association.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface GetConfiguredTableCommandOutput extends GetConfiguredTableOutpu
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM",
* // ],
* // analysisMethod: "STRING_VALUE", // required
* // analysisMethod: "DIRECT_QUERY", // required
* // allowedColumns: [ // AllowedColumnList // required
* // "STRING_VALUE",
* // ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface GetMembershipCommandOutput extends GetMembershipOutput, __Metad
* // updateTime: new Date("TIMESTAMP"), // required
* // status: "STRING_VALUE", // required
* // memberAbilities: [ // MemberAbilities // required
* // "STRING_VALUE",
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* // ],
* // queryLogStatus: "STRING_VALUE", // required
* // defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
Expand All @@ -62,6 +62,7 @@ export interface GetMembershipCommandOutput extends GetMembershipOutput, __Metad
* // resultFormat: "STRING_VALUE", // required
* // bucket: "STRING_VALUE", // required
* // keyPrefix: "STRING_VALUE",
* // singleFileOutput: true || false,
* // },
* // },
* // roleArn: "STRING_VALUE",
Expand Down
10 changes: 10 additions & 0 deletions clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
* // resultFormat: "STRING_VALUE", // required
* // bucket: "STRING_VALUE", // required
* // keyPrefix: "STRING_VALUE",
* // singleFileOutput: true || false,
* // },
* // member: { // ProtectedQueryMemberOutputConfiguration
* // accountId: "STRING_VALUE", // required
Expand All @@ -73,6 +74,9 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
* // },
* // statistics: { // ProtectedQueryStatistics
* // totalDurationInMillis: Number("long"),
* // billedResourceUtilization: { // BilledResourceUtilization
* // units: Number("double"), // required
* // },
* // },
* // result: { // ProtectedQueryResult
* // output: { // ProtectedQueryOutput Union: only one key present
Expand Down Expand Up @@ -101,6 +105,12 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
* // },
* // ],
* // },
* // computeConfiguration: { // ComputeConfiguration Union: only one key present
* // worker: { // WorkerComputeConfiguration
* // type: "CR.1X" || "CR.4X",
* // number: Number("int"),
* // },
* // },
* // },
* // };
*
Expand Down
2 changes: 1 addition & 1 deletion clients/client-cleanrooms/src/commands/GetSchemaCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface GetSchemaCommandOutput extends GetSchemaOutput, __MetadataBeare
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
* // ],
* // analysisMethod: "STRING_VALUE",
* // analysisMethod: "DIRECT_QUERY",
* // creatorAccountId: "STRING_VALUE", // required
* // name: "STRING_VALUE", // required
* // collaborationId: "STRING_VALUE", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export interface ListCollaborationsCommandOutput extends ListCollaborationsOutpu
* // memberStatus: "STRING_VALUE", // required
* // membershipId: "STRING_VALUE",
* // membershipArn: "STRING_VALUE",
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
* // },
* // ],
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface ListConfiguredTablesCommandOutput extends ListConfiguredTablesO
* // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM",
* // ],
* // analysisMethod: "STRING_VALUE", // required
* // analysisMethod: "DIRECT_QUERY", // required
* // },
* // ],
* // nextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface ListMembersCommandOutput extends ListMembersOutput, __MetadataB
* // status: "STRING_VALUE", // required
* // displayName: "STRING_VALUE", // required
* // abilities: [ // MemberAbilities // required
* // "STRING_VALUE",
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* // ],
* // createTime: new Date("TIMESTAMP"), // required
* // updateTime: new Date("TIMESTAMP"), // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface ListMembershipsCommandOutput extends ListMembershipsOutput, __M
* // updateTime: new Date("TIMESTAMP"), // required
* // status: "STRING_VALUE", // required
* // memberAbilities: [ // MemberAbilities // required
* // "STRING_VALUE",
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS",
* // ],
* // paymentConfiguration: { // MembershipPaymentConfiguration
* // queryCompute: { // MembershipQueryComputePaymentConfig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface ListSchemasCommandOutput extends ListSchemasOutput, __MetadataB
* // analysisRuleTypes: [ // AnalysisRuleTypeList // required
* // "AGGREGATION" || "LIST" || "CUSTOM" || "ID_MAPPING_TABLE",
* // ],
* // analysisMethod: "STRING_VALUE",
* // analysisMethod: "DIRECT_QUERY",
* // },
* // ],
* // nextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ export interface PopulateIdMappingTableCommandOutput extends PopulateIdMappingTa
* @throws {@link ResourceNotFoundException} (client fault)
* <p>Request references a resource which does not exist.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>Request denied because service quota has been exceeded.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>Request was denied due to request throttling.</p>
*
Expand Down
Loading

0 comments on commit 2ccb11c

Please sign in to comment.