diff --git a/clients/client-cleanrooms/README.md b/clients/client-cleanrooms/README.md index 6f6816877916c..ad678b99e2f51 100644 --- a/clients/client-cleanrooms/README.md +++ b/clients/client-cleanrooms/README.md @@ -18,7 +18,7 @@ party getting access to the other party's raw data.

## 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` diff --git a/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts index 5bce821e5c210..e5c25b67dfae6 100644 --- a/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts @@ -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", * // }, * // ], diff --git a/clients/client-cleanrooms/src/commands/BatchGetSchemaCommand.ts b/clients/client-cleanrooms/src/commands/BatchGetSchemaCommand.ts index 1af90a9bd70e0..61e4b34c0674a 100644 --- a/clients/client-cleanrooms/src/commands/BatchGetSchemaCommand.ts +++ b/clients/client-cleanrooms/src/commands/BatchGetSchemaCommand.ts @@ -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 diff --git a/clients/client-cleanrooms/src/commands/CreateAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/CreateAnalysisTemplateCommand.ts index 09915baf810a7..b1fe0b5af5537 100644 --- a/clients/client-cleanrooms/src/commands/CreateAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/CreateAnalysisTemplateCommand.ts @@ -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", * }, @@ -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", * }, * ], @@ -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", * // }, * // ], diff --git a/clients/client-cleanrooms/src/commands/CreateCollaborationCommand.ts b/clients/client-cleanrooms/src/commands/CreateCollaborationCommand.ts index e9a446d479c9f..6071f33f0dc3d 100644 --- a/clients/client-cleanrooms/src/commands/CreateCollaborationCommand.ts +++ b/clients/client-cleanrooms/src/commands/CreateCollaborationCommand.ts @@ -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 @@ -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 @@ -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 * "": "STRING_VALUE", * }, @@ -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); @@ -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", * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/CreateConfiguredTableCommand.ts b/clients/client-cleanrooms/src/commands/CreateConfiguredTableCommand.ts index ccd7a1ac0b3f1..f0f38e5b0dc0e 100644 --- a/clients/client-cleanrooms/src/commands/CreateConfiguredTableCommand.ts +++ b/clients/client-cleanrooms/src/commands/CreateConfiguredTableCommand.ts @@ -47,7 +47,7 @@ export interface CreateConfiguredTableCommandOutput extends CreateConfiguredTabl * allowedColumns: [ // AllowedColumnList // required * "STRING_VALUE", * ], - * analysisMethod: "STRING_VALUE", // required + * analysisMethod: "DIRECT_QUERY", // required * tags: { // TagMap * "": "STRING_VALUE", * }, @@ -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", * // ], diff --git a/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts index 6800037e6db83..15a174645169d 100644 --- a/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts @@ -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", @@ -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 @@ -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", diff --git a/clients/client-cleanrooms/src/commands/DeleteConfiguredTableAssociationAnalysisRuleCommand.ts b/clients/client-cleanrooms/src/commands/DeleteConfiguredTableAssociationAnalysisRuleCommand.ts index b26533e10c4ae..4413506dacf9f 100644 --- a/clients/client-cleanrooms/src/commands/DeleteConfiguredTableAssociationAnalysisRuleCommand.ts +++ b/clients/client-cleanrooms/src/commands/DeleteConfiguredTableAssociationAnalysisRuleCommand.ts @@ -37,8 +37,7 @@ export interface DeleteConfiguredTableAssociationAnalysisRuleCommandOutput __MetadataBearer {} /** - *

Deletes - * an analysis rule for a configured table association.

+ *

Deletes an analysis rule for a configured table association.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cleanrooms/src/commands/GetAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/GetAnalysisTemplateCommand.ts index 958a319e4769f..0bc7abf62884d 100644 --- a/clients/client-cleanrooms/src/commands/GetAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetAnalysisTemplateCommand.ts @@ -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", * // }, * // ], diff --git a/clients/client-cleanrooms/src/commands/GetCollaborationAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/GetCollaborationAnalysisTemplateCommand.ts index e886f5810e067..8935b00df0752 100644 --- a/clients/client-cleanrooms/src/commands/GetCollaborationAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetCollaborationAnalysisTemplateCommand.ts @@ -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", * // }, * // ], diff --git a/clients/client-cleanrooms/src/commands/GetCollaborationCommand.ts b/clients/client-cleanrooms/src/commands/GetCollaborationCommand.ts index 6647fdd388768..e155c976ffa86 100644 --- a/clients/client-cleanrooms/src/commands/GetCollaborationCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetCollaborationCommand.ts @@ -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", * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/GetConfiguredTableAssociationAnalysisRuleCommand.ts b/clients/client-cleanrooms/src/commands/GetConfiguredTableAssociationAnalysisRuleCommand.ts index fb5465d545a30..18d1514c5e8cb 100644 --- a/clients/client-cleanrooms/src/commands/GetConfiguredTableAssociationAnalysisRuleCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetConfiguredTableAssociationAnalysisRuleCommand.ts @@ -37,9 +37,7 @@ export interface GetConfiguredTableAssociationAnalysisRuleCommandOutput __MetadataBearer {} /** - *

- * Retrieves - * the analysis rule for a configured table association.

+ *

Retrieves the analysis rule for a configured table association.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cleanrooms/src/commands/GetConfiguredTableCommand.ts b/clients/client-cleanrooms/src/commands/GetConfiguredTableCommand.ts index 1a40190fe8f3f..1222f150b1b2a 100644 --- a/clients/client-cleanrooms/src/commands/GetConfiguredTableCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetConfiguredTableCommand.ts @@ -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", * // ], diff --git a/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts b/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts index de3bf549a7deb..cdfb1ad0c83ed 100644 --- a/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts @@ -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 @@ -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", diff --git a/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts index 8c96055437ae7..1a3cd363a6808 100644 --- a/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts @@ -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 @@ -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 @@ -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"), + * // }, + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/GetSchemaCommand.ts b/clients/client-cleanrooms/src/commands/GetSchemaCommand.ts index f2b217c37f59e..4ad90fcc204e5 100644 --- a/clients/client-cleanrooms/src/commands/GetSchemaCommand.ts +++ b/clients/client-cleanrooms/src/commands/GetSchemaCommand.ts @@ -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 diff --git a/clients/client-cleanrooms/src/commands/ListCollaborationsCommand.ts b/clients/client-cleanrooms/src/commands/ListCollaborationsCommand.ts index d12cea743aecd..fe96056e8f09b 100644 --- a/clients/client-cleanrooms/src/commands/ListCollaborationsCommand.ts +++ b/clients/client-cleanrooms/src/commands/ListCollaborationsCommand.ts @@ -56,6 +56,7 @@ export interface ListCollaborationsCommandOutput extends ListCollaborationsOutpu * // memberStatus: "STRING_VALUE", // required * // membershipId: "STRING_VALUE", * // membershipArn: "STRING_VALUE", + * // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL", * // }, * // ], * // }; diff --git a/clients/client-cleanrooms/src/commands/ListConfiguredTablesCommand.ts b/clients/client-cleanrooms/src/commands/ListConfiguredTablesCommand.ts index 17a39a9273233..ba1a5ecf8bd4f 100644 --- a/clients/client-cleanrooms/src/commands/ListConfiguredTablesCommand.ts +++ b/clients/client-cleanrooms/src/commands/ListConfiguredTablesCommand.ts @@ -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", diff --git a/clients/client-cleanrooms/src/commands/ListMembersCommand.ts b/clients/client-cleanrooms/src/commands/ListMembersCommand.ts index ef31aa874aa60..3e30c44aa57aa 100644 --- a/clients/client-cleanrooms/src/commands/ListMembersCommand.ts +++ b/clients/client-cleanrooms/src/commands/ListMembersCommand.ts @@ -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 diff --git a/clients/client-cleanrooms/src/commands/ListMembershipsCommand.ts b/clients/client-cleanrooms/src/commands/ListMembershipsCommand.ts index bdb24c20fcaab..3cf192da11375 100644 --- a/clients/client-cleanrooms/src/commands/ListMembershipsCommand.ts +++ b/clients/client-cleanrooms/src/commands/ListMembershipsCommand.ts @@ -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 diff --git a/clients/client-cleanrooms/src/commands/ListSchemasCommand.ts b/clients/client-cleanrooms/src/commands/ListSchemasCommand.ts index b23100911cd78..57f5cd068fdac 100644 --- a/clients/client-cleanrooms/src/commands/ListSchemasCommand.ts +++ b/clients/client-cleanrooms/src/commands/ListSchemasCommand.ts @@ -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", diff --git a/clients/client-cleanrooms/src/commands/PopulateIdMappingTableCommand.ts b/clients/client-cleanrooms/src/commands/PopulateIdMappingTableCommand.ts index 4dd41ffd2e588..da0e1c310b8cf 100644 --- a/clients/client-cleanrooms/src/commands/PopulateIdMappingTableCommand.ts +++ b/clients/client-cleanrooms/src/commands/PopulateIdMappingTableCommand.ts @@ -65,6 +65,9 @@ export interface PopulateIdMappingTableCommandOutput extends PopulateIdMappingTa * @throws {@link ResourceNotFoundException} (client fault) *

Request references a resource which does not exist.

* + * @throws {@link ServiceQuotaExceededException} (client fault) + *

Request denied because service quota has been exceeded.

+ * * @throws {@link ThrottlingException} (client fault) *

Request was denied due to request throttling.

* diff --git a/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts index 8f16dc509921e..1d618870995f9 100644 --- a/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts @@ -6,12 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - StartProtectedQueryInput, - StartProtectedQueryInputFilterSensitiveLog, - StartProtectedQueryOutput, - StartProtectedQueryOutputFilterSensitiveLog, -} from "../models/models_0"; +import { StartProtectedQueryInput, StartProtectedQueryInputFilterSensitiveLog } from "../models/models_0"; +import { StartProtectedQueryOutput, StartProtectedQueryOutputFilterSensitiveLog } from "../models/models_1"; import { de_StartProtectedQueryCommand, se_StartProtectedQueryCommand } from "../protocols/Aws_restJson1"; /** @@ -56,12 +52,19 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut * resultFormat: "STRING_VALUE", // required * bucket: "STRING_VALUE", // required * keyPrefix: "STRING_VALUE", + * singleFileOutput: true || false, * }, * member: { // ProtectedQueryMemberOutputConfiguration * accountId: "STRING_VALUE", // required * }, * }, * }, + * computeConfiguration: { // ComputeConfiguration Union: only one key present + * worker: { // WorkerComputeConfiguration + * type: "CR.1X" || "CR.4X", + * number: Number("int"), + * }, + * }, * }; * const command = new StartProtectedQueryCommand(input); * const response = await client.send(command); @@ -85,6 +88,7 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut * // resultFormat: "STRING_VALUE", // required * // bucket: "STRING_VALUE", // required * // keyPrefix: "STRING_VALUE", + * // singleFileOutput: true || false, * // }, * // member: { // ProtectedQueryMemberOutputConfiguration * // accountId: "STRING_VALUE", // required @@ -93,6 +97,9 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut * // }, * // statistics: { // ProtectedQueryStatistics * // totalDurationInMillis: Number("long"), + * // billedResourceUtilization: { // BilledResourceUtilization + * // units: Number("double"), // required + * // }, * // }, * // result: { // ProtectedQueryResult * // output: { // ProtectedQueryOutput Union: only one key present @@ -121,6 +128,12 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut * // }, * // ], * // }, + * // computeConfiguration: { // ComputeConfiguration Union: only one key present + * // worker: { // WorkerComputeConfiguration + * // type: "CR.1X" || "CR.4X", + * // number: Number("int"), + * // }, + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/UpdateAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/UpdateAnalysisTemplateCommand.ts index 3898a93bda2a7..9ff4d7cef519b 100644 --- a/clients/client-cleanrooms/src/commands/UpdateAnalysisTemplateCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateAnalysisTemplateCommand.ts @@ -63,14 +63,14 @@ export interface UpdateAnalysisTemplateCommandOutput extends UpdateAnalysisTempl * // "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", * // }, * // ], diff --git a/clients/client-cleanrooms/src/commands/UpdateCollaborationCommand.ts b/clients/client-cleanrooms/src/commands/UpdateCollaborationCommand.ts index 558a0fbdea762..6b3992963af3e 100644 --- a/clients/client-cleanrooms/src/commands/UpdateCollaborationCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateCollaborationCommand.ts @@ -61,7 +61,8 @@ export interface UpdateCollaborationCommandOutput extends UpdateCollaborationOut * // allowJoinsOnColumnsWithDifferentNames: true || false, // required * // preserveNulls: true || false, // required * // }, - * // queryLogStatus: "STRING_VALUE", // required + * // queryLogStatus: "ENABLED" || "DISABLED", // required + * // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL", * // }, * // }; * diff --git a/clients/client-cleanrooms/src/commands/UpdateConfiguredTableAssociationAnalysisRuleCommand.ts b/clients/client-cleanrooms/src/commands/UpdateConfiguredTableAssociationAnalysisRuleCommand.ts index d10a68ab7cd04..0d45c1bbf5da2 100644 --- a/clients/client-cleanrooms/src/commands/UpdateConfiguredTableAssociationAnalysisRuleCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateConfiguredTableAssociationAnalysisRuleCommand.ts @@ -37,9 +37,7 @@ export interface UpdateConfiguredTableAssociationAnalysisRuleCommandOutput __MetadataBearer {} /** - *

- * Updates - * the analysis rule for a configured table association.

+ *

Updates the analysis rule for a configured table association.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cleanrooms/src/commands/UpdateConfiguredTableCommand.ts b/clients/client-cleanrooms/src/commands/UpdateConfiguredTableCommand.ts index 1b197a53317e5..5c73bae8b2c76 100644 --- a/clients/client-cleanrooms/src/commands/UpdateConfiguredTableCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateConfiguredTableCommand.ts @@ -59,7 +59,7 @@ export interface UpdateConfiguredTableCommandOutput extends UpdateConfiguredTabl * // analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required * // "AGGREGATION" || "LIST" || "CUSTOM", * // ], - * // analysisMethod: "STRING_VALUE", // required + * // analysisMethod: "DIRECT_QUERY", // required * // allowedColumns: [ // AllowedColumnList // required * // "STRING_VALUE", * // ], diff --git a/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts index cef4f64cd6763..b288348df8b19 100644 --- a/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateMembershipInput, UpdateMembershipOutput } from "../models/models_0"; +import { UpdateMembershipInput, UpdateMembershipOutput } from "../models/models_1"; import { de_UpdateMembershipCommand, se_UpdateMembershipCommand } from "../protocols/Aws_restJson1"; /** @@ -44,6 +44,7 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _ * resultFormat: "STRING_VALUE", // required * bucket: "STRING_VALUE", // required * keyPrefix: "STRING_VALUE", + * singleFileOutput: true || false, * }, * }, * roleArn: "STRING_VALUE", @@ -64,7 +65,7 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _ * // 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 @@ -73,6 +74,7 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _ * // resultFormat: "STRING_VALUE", // required * // bucket: "STRING_VALUE", // required * // keyPrefix: "STRING_VALUE", + * // singleFileOutput: true || false, * // }, * // }, * // roleArn: "STRING_VALUE", diff --git a/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts index 3f05ab343cd24..174df904ed528 100644 --- a/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts +++ b/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts @@ -6,8 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateProtectedQueryInput } from "../models/models_0"; -import { UpdateProtectedQueryOutput, UpdateProtectedQueryOutputFilterSensitiveLog } from "../models/models_1"; +import { + UpdateProtectedQueryInput, + UpdateProtectedQueryOutput, + UpdateProtectedQueryOutputFilterSensitiveLog, +} from "../models/models_1"; import { de_UpdateProtectedQueryCommand, se_UpdateProtectedQueryCommand } from "../protocols/Aws_restJson1"; /** @@ -63,6 +66,7 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO * // resultFormat: "STRING_VALUE", // required * // bucket: "STRING_VALUE", // required * // keyPrefix: "STRING_VALUE", + * // singleFileOutput: true || false, * // }, * // member: { // ProtectedQueryMemberOutputConfiguration * // accountId: "STRING_VALUE", // required @@ -71,6 +75,9 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO * // }, * // statistics: { // ProtectedQueryStatistics * // totalDurationInMillis: Number("long"), + * // billedResourceUtilization: { // BilledResourceUtilization + * // units: Number("double"), // required + * // }, * // }, * // result: { // ProtectedQueryResult * // output: { // ProtectedQueryOutput Union: only one key present @@ -99,6 +106,12 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO * // }, * // ], * // }, + * // computeConfiguration: { // ComputeConfiguration Union: only one key present + * // worker: { // WorkerComputeConfiguration + * // type: "CR.1X" || "CR.4X", + * // number: Number("int"), + * // }, + * // }, * // }, * // }; * diff --git a/clients/client-cleanrooms/src/models/models_0.ts b/clients/client-cleanrooms/src/models/models_0.ts index 16912cfec5633..b1704ce79249a 100644 --- a/clients/client-cleanrooms/src/models/models_0.ts +++ b/clients/client-cleanrooms/src/models/models_0.ts @@ -170,18 +170,31 @@ export type AnalysisMethod = (typeof AnalysisMethod)[keyof typeof AnalysisMethod */ export const ParameterType = { BIGINT: "BIGINT", + BINARY: "BINARY", BOOLEAN: "BOOLEAN", + BYTE: "BYTE", CHAR: "CHAR", + CHARACTER: "CHARACTER", DATE: "DATE", DECIMAL: "DECIMAL", + DOUBLE: "DOUBLE", DOUBLE_PRECISION: "DOUBLE_PRECISION", + FLOAT: "FLOAT", + INT: "INT", INTEGER: "INTEGER", + LONG: "LONG", + NUMERIC: "NUMERIC", REAL: "REAL", + SHORT: "SHORT", SMALLINT: "SMALLINT", + STRING: "STRING", TIME: "TIME", TIMESTAMP: "TIMESTAMP", TIMESTAMPTZ: "TIMESTAMPTZ", + TIMESTAMP_LTZ: "TIMESTAMP_LTZ", + TIMESTAMP_NTZ: "TIMESTAMP_NTZ", TIMETZ: "TIMETZ", + TINYINT: "TINYINT", VARBYTE: "VARBYTE", VARCHAR: "VARCHAR", } as const; @@ -336,12 +349,9 @@ export interface AnalysisRuleAggregation { /** *

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

- *

The - * additionalAnalyses - * parameter is - * currently - * supported for the list analysis rule (AnalysisRuleList) and the custom - * analysis rule (AnalysisRuleCustom).

+ *

The additionalAnalyses parameter is currently supported for the list + * analysis rule (AnalysisRuleList) and the custom analysis rule + * (AnalysisRuleCustom).

* @public */ additionalAnalyses?: AdditionalAnalyses; @@ -1286,14 +1296,14 @@ export interface ListAnalysisTemplatesInput { membershipIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -1371,8 +1381,7 @@ export interface AnalysisTemplateSummary { */ export interface ListAnalysisTemplatesOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -1432,6 +1441,20 @@ export const AnalysisType = { */ export type AnalysisType = (typeof AnalysisType)[keyof typeof AnalysisType]; +/** + * @public + * @enum + */ +export const AnalyticsEngine = { + CLEAN_ROOMS_SQL: "CLEAN_ROOMS_SQL", + SPARK: "SPARK", +} as const; + +/** + * @public + */ +export type AnalyticsEngine = (typeof AnalyticsEngine)[keyof typeof AnalyticsEngine]; + /** * @public */ @@ -1856,7 +1879,7 @@ export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType]; */ export interface Schema { /** - *

The columns for the relation this schema represents.

+ *

The columns for the relation that this schema represents.

* @public */ columns: Column[] | undefined; @@ -1868,7 +1891,7 @@ export interface Schema { partitionKeys: Column[] | undefined; /** - *

The analysis rule types associated with the schema. Currently, only one entry is + *

The analysis rule types that are associated with the schema. Currently, only one entry is * present.

* @public */ @@ -1876,7 +1899,7 @@ export interface Schema { /** *

The analysis method for the schema. The only valid value is currently - * DIRECT_QUERY.

+ * DIRECT_QUERY.

* @public */ analysisMethod?: AnalysisMethod; @@ -1901,7 +1924,7 @@ export interface Schema { collaborationId: string | undefined; /** - *

The unique ARN for the collaboration that the schema belongs to.

+ *

The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

* @public */ collaborationArn: string | undefined; @@ -1913,19 +1936,19 @@ export interface Schema { description: string | undefined; /** - *

The time the schema was created.

+ *

The time at which the schema was created.

* @public */ createTime: Date | undefined; /** - *

The time the schema was last updated.

+ *

The most recent time at which the schema was updated.

* @public */ updateTime: Date | undefined; /** - *

The type of schema. The only valid value is currently `TABLE`.

+ *

The type of schema.

* @public */ type: SchemaType | undefined; @@ -2240,6 +2263,12 @@ export interface CreateCollaborationInput { * @public */ creatorPaymentConfiguration?: PaymentConfiguration; + + /** + *

The analytics engine.

+ * @public + */ + analyticsEngine?: AnalyticsEngine; } /** @@ -2344,6 +2373,12 @@ export interface Collaboration { * @public */ queryLogStatus: CollaborationQueryLogStatus | undefined; + + /** + *

The analytics engine for the collaboration.

+ * @public + */ + analyticsEngine?: AnalyticsEngine; } /** @@ -2512,7 +2547,7 @@ export interface CollaborationConfiguredAudienceModelAssociation { description?: string; /** - *

The identifier used to reference members of the collaboration. Only supports AWS account ID.

+ *

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

* @public */ creatorAccountId: string | undefined; @@ -2957,14 +2992,14 @@ export interface ListCollaborationAnalysisTemplatesInput { collaborationIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3039,8 +3074,7 @@ export interface CollaborationAnalysisTemplateSummary { */ export interface ListCollaborationAnalysisTemplatesOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3063,13 +3097,14 @@ export interface ListCollaborationConfiguredAudienceModelAssociationsInput { collaborationIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3123,7 +3158,7 @@ export interface CollaborationConfiguredAudienceModelAssociationSummary { collaborationId: string | undefined; /** - *

The identifier used to reference members of the collaboration. Only supports AWS account ID.

+ *

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

* @public */ creatorAccountId: string | undefined; @@ -3148,7 +3183,7 @@ export interface ListCollaborationConfiguredAudienceModelAssociationsOutput { | undefined; /** - *

The token value retrieved from a previous call to access the next page of results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3295,16 +3330,14 @@ export interface ListCollaborationPrivacyBudgetsInput { privacyBudgetType: PrivacyBudgetType | undefined; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3485,8 +3518,7 @@ export interface ListCollaborationPrivacyBudgetsOutput { collaborationPrivacyBudgetSummaries: CollaborationPrivacyBudgetSummary[] | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3503,16 +3535,14 @@ export interface ListCollaborationPrivacyBudgetTemplatesInput { collaborationIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3577,8 +3607,7 @@ export interface CollaborationPrivacyBudgetTemplateSummary { */ export interface ListCollaborationPrivacyBudgetTemplatesOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3609,16 +3638,14 @@ export type FilterableMemberStatus = (typeof FilterableMemberStatus)[keyof typeo */ export interface ListCollaborationsInput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3696,6 +3723,12 @@ export interface CollaborationSummary { * @public */ membershipArn?: string; + + /** + *

The analytics engine.

+ * @public + */ + analyticsEngine?: AnalyticsEngine; } /** @@ -3703,8 +3736,7 @@ export interface CollaborationSummary { */ export interface ListCollaborationsOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3727,14 +3759,14 @@ export interface ListMembersInput { collaborationIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3806,8 +3838,7 @@ export interface MemberSummary { */ export interface ListMembersOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -3831,21 +3862,20 @@ export interface ListSchemasInput { collaborationIdentifier: string | undefined; /** - *

If present, filter schemas by schema type. The only valid schema type is currently - * `TABLE`.

+ *

If present, filter schemas by schema type.

* @public */ schemaType?: SchemaType; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -3863,7 +3893,7 @@ export interface SchemaSummary { name: string | undefined; /** - *

The type of schema object. The only valid schema type is currently `TABLE`.

+ *

The type of schema object.

* @public */ type: SchemaType | undefined; @@ -3923,8 +3953,7 @@ export interface ListSchemasOutput { schemaSummaries: SchemaSummary[] | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -4162,15 +4191,14 @@ export interface ListConfiguredAudienceModelAssociationsInput { membershipIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -4473,11 +4501,8 @@ export interface ConfiguredTableAssociationAnalysisRuleAggregation { /** *

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

- *

The - * allowedAdditionalAnalyses - * parameter - * is currently supported for the list analysis rule - * (AnalysisRuleList) and the custom analysis rule + *

The allowedAdditionalAnalyses parameter is currently supported for the list + * analysis rule (AnalysisRuleList) and the custom analysis rule * (AnalysisRuleCustom).

* @public */ @@ -4490,10 +4515,8 @@ export interface ConfiguredTableAssociationAnalysisRuleAggregation { */ export interface ConfiguredTableAssociationAnalysisRuleCustom { /** - *

The list of - * collaboration members who are allowed - * to - * receive results of queries run with this configured table.

+ *

The list of collaboration members who are allowed to receive results of queries run + * with this configured table.

* @public */ allowedResultReceivers?: string[]; @@ -4669,11 +4692,9 @@ export interface CreateConfiguredTableAssociationAnalysisRuleInput { } /** - *

An - * analysis rule for a configured table association. This analysis rule specifies how data - * from the table can be used within its associated - * collaboration. - * In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the + *

An analysis rule for a configured table association. This analysis rule specifies how + * data from the table can be used within its associated collaboration. In the console, the + * ConfiguredTableAssociationAnalysisRule is referred to as the * collaboration analysis rule.

* @public */ @@ -4685,17 +4706,13 @@ export interface ConfiguredTableAssociationAnalysisRule { membershipIdentifier: string | undefined; /** - *

- * The - * unique identifier for the configured table association.

+ *

The unique identifier for the configured table association.

* @public */ configuredTableAssociationId: string | undefined; /** - *

- * The - * Amazon Resource Name (ARN) of the configured table association.

+ *

The Amazon Resource Name (ARN) of the configured table association.

* @public */ configuredTableAssociationArn: string | undefined; @@ -4730,8 +4747,7 @@ export interface ConfiguredTableAssociationAnalysisRule { */ export interface CreateConfiguredTableAssociationAnalysisRuleOutput { /** - *

The analysis rule for the configured table association. - * In the console, the + *

The analysis rule for the configured table association. In the console, the * ConfiguredTableAssociationAnalysisRule is referred to as the * collaboration analysis rule.

* @public @@ -4775,16 +4791,14 @@ export interface DeleteConfiguredTableAssociationAnalysisRuleInput { membershipIdentifier: string | undefined; /** - *

The - * identifier for the configured table association that's related to the analysis rule that you - * want to delete.

+ *

The identifier for the configured table association that's related to the analysis rule + * that you want to delete.

* @public */ configuredTableAssociationIdentifier: string | undefined; /** - *

The - * type of the analysis rule that you want to delete.

+ *

The type of the analysis rule that you want to delete.

* @public */ analysisRuleType: ConfiguredTableAssociationAnalysisRuleType | undefined; @@ -4837,18 +4851,14 @@ export interface GetConfiguredTableAssociationAnalysisRuleInput { membershipIdentifier: string | undefined; /** - *

- * The - * identifier for the configured table association that's related to the analysis + *

The identifier for the configured table association that's related to the analysis * rule.

* @public */ configuredTableAssociationIdentifier: string | undefined; /** - *

- * The - * type of analysis rule that you want to retrieve.

+ *

The type of analysis rule that you want to retrieve.

* @public */ analysisRuleType: ConfiguredTableAssociationAnalysisRuleType | undefined; @@ -4859,10 +4869,9 @@ export interface GetConfiguredTableAssociationAnalysisRuleInput { */ export interface GetConfiguredTableAssociationAnalysisRuleOutput { /** - *

The - * analysis rule for the configured table association. In the console, the - * ConfiguredTableAssociationAnalysisRule is referred to as the - * collaboration analysis rule.

+ *

The analysis rule for the configured table association. In the console, the + * ConfiguredTableAssociationAnalysisRule is referred to as the + * collaboration analysis rule.

* @public */ analysisRule: ConfiguredTableAssociationAnalysisRule | undefined; @@ -4880,14 +4889,14 @@ export interface ListConfiguredTableAssociationsInput { membershipIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -4961,8 +4970,7 @@ export interface ListConfiguredTableAssociationsOutput { configuredTableAssociationSummaries: ConfiguredTableAssociationSummary[] | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -5028,17 +5036,13 @@ export interface UpdateConfiguredTableAssociationAnalysisRuleInput { configuredTableAssociationIdentifier: string | undefined; /** - *

The analysis rule type - * that - * you want to update.

+ *

The analysis rule type that you want to update.

* @public */ analysisRuleType: ConfiguredTableAssociationAnalysisRuleType | undefined; /** - *

- * The - * updated analysis rule policy for the configured table association.

+ *

The updated analysis rule policy for the configured table association.

* @public */ analysisRulePolicy: ConfiguredTableAssociationAnalysisRulePolicy | undefined; @@ -5049,9 +5053,7 @@ export interface UpdateConfiguredTableAssociationAnalysisRuleInput { */ export interface UpdateConfiguredTableAssociationAnalysisRuleOutput { /** - *

- * The - * updated analysis rule for the configured table association. In the console, the + *

The updated analysis rule for the configured table association. In the console, the * ConfiguredTableAssociationAnalysisRule is referred to as the * collaboration analysis rule.

* @public @@ -5549,14 +5551,14 @@ export interface GetConfiguredTableAnalysisRuleOutput { */ export interface ListConfiguredTablesInput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -5622,8 +5624,7 @@ export interface ListConfiguredTablesOutput { configuredTableSummaries: ConfiguredTableSummary[] | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -6512,6 +6513,14 @@ export interface ProtectedQueryS3OutputConfiguration { * @public */ keyPrefix?: string; + + /** + *

Indicates whether files should be output as a single file (TRUE) or output + * as multiple files (FALSE). This parameter is only supported for analyses with + * the Spark analytics engine.

+ * @public + */ + singleFileOutput?: boolean; } /** @@ -6846,6 +6855,77 @@ export interface GetProtectedQueryInput { protectedQueryIdentifier: string | undefined; } +/** + * @public + * @enum + */ +export const WorkerComputeType = { + CR1X: "CR.1X", + CR4X: "CR.4X", +} as const; + +/** + * @public + */ +export type WorkerComputeType = (typeof WorkerComputeType)[keyof typeof WorkerComputeType]; + +/** + *

The configuration of the compute resources for workers running an analysis with the + * Clean Rooms SQL analytics engine.

+ * @public + */ +export interface WorkerComputeConfiguration { + /** + *

The worker compute configuration type.

+ * @public + */ + type?: WorkerComputeType; + + /** + *

The number of workers.

+ * @public + */ + number?: number; +} + +/** + *

The configuration of the compute resources for an analysis with the Spark analytics engine.

+ * @public + */ +export type ComputeConfiguration = ComputeConfiguration.WorkerMember | ComputeConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace ComputeConfiguration { + /** + *

The worker configuration for the compute environment.

+ * @public + */ + export interface WorkerMember { + worker: WorkerComputeConfiguration; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + worker?: never; + $unknown: [string, any]; + } + + export interface Visitor { + worker: (value: WorkerComputeConfiguration) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ComputeConfiguration, visitor: Visitor): T => { + if (value.worker !== undefined) return visitor.worker(value.worker); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + /** *

Provides the sensitivity parameters.

* @public @@ -7010,8 +7090,7 @@ export interface ProtectedQueryResult { */ export interface ProtectedQueryMemberOutputConfiguration { /** - *

The - * unique identifier for the account.

+ *

The unique identifier for the account.

* @public */ accountId: string | undefined; @@ -7031,9 +7110,7 @@ export type ProtectedQueryOutputConfiguration = */ export namespace ProtectedQueryOutputConfiguration { /** - *

Required configuration for a protected query with an - * s3 - * output type.

+ *

Required configuration for a protected query with an s3 output type.

* @public */ export interface S3Member { @@ -7111,6 +7188,18 @@ export interface ProtectedQuerySQLParameters { parameters?: Record; } +/** + *

Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.

+ * @public + */ +export interface BilledResourceUtilization { + /** + *

The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.

+ * @public + */ + units: number | undefined; +} + /** *

Contains statistics about the execution of the protected query.

* @public @@ -7121,6 +7210,12 @@ export interface ProtectedQueryStatistics { * @public */ totalDurationInMillis?: number; + + /** + *

The billed resource utilization.

+ * @public + */ + billedResourceUtilization?: BilledResourceUtilization; } /** @@ -7212,6 +7307,12 @@ export interface ProtectedQuery { * @public */ differentialPrivacy?: DifferentialPrivacyParameters; + + /** + *

The compute configuration for the protected query.

+ * @public + */ + computeConfiguration?: ComputeConfiguration; } /** @@ -7230,14 +7331,14 @@ export interface GetProtectedQueryOutput { */ export interface ListMembershipsInput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -7333,8 +7434,7 @@ export interface MembershipSummary { */ export interface ListMembershipsOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -7363,16 +7463,14 @@ export interface ListPrivacyBudgetsInput { privacyBudgetType: PrivacyBudgetType | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -7461,8 +7559,7 @@ export interface ListPrivacyBudgetsOutput { privacyBudgetSummaries: PrivacyBudgetSummary[] | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -7485,16 +7582,14 @@ export interface ListProtectedQueriesInput { status?: ProtectedQueryStatus; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service can return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -7601,8 +7696,7 @@ export interface ProtectedQuerySummary { createTime: Date | undefined; /** - *

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, - * `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

+ *

The status of the protected query.

* @public */ status: ProtectedQueryStatus | undefined; @@ -7619,8 +7713,7 @@ export interface ProtectedQuerySummary { */ export interface ListProtectedQueriesOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -7827,90 +7920,12 @@ export interface StartProtectedQueryInput { * @public */ resultConfiguration?: ProtectedQueryResultConfiguration; -} -/** - * @public - */ -export interface StartProtectedQueryOutput { /** - *

The protected query.

+ *

The compute configuration for the protected query.

* @public */ - protectedQuery: ProtectedQuery | undefined; -} - -/** - * @public - */ -export interface UpdateMembershipInput { - /** - *

The unique identifier of the membership.

- * @public - */ - membershipIdentifier: string | undefined; - - /** - *

An indicator as to whether query logging has been enabled or disabled for the - * membership.

- * @public - */ - queryLogStatus?: MembershipQueryLogStatus; - - /** - *

The default protected query result configuration as specified by the member who can - * receive results.

- * @public - */ - defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration; -} - -/** - * @public - */ -export interface UpdateMembershipOutput { - /** - *

The membership object.

- * @public - */ - membership: Membership | undefined; -} - -/** - * @public - * @enum - */ -export const TargetProtectedQueryStatus = { - CANCELLED: "CANCELLED", -} as const; - -/** - * @public - */ -export type TargetProtectedQueryStatus = (typeof TargetProtectedQueryStatus)[keyof typeof TargetProtectedQueryStatus]; - -/** - * @public - */ -export interface UpdateProtectedQueryInput { - /** - *

The identifier for a member of a protected query instance.

- * @public - */ - membershipIdentifier: string | undefined; - - /** - *

The identifier for a protected query instance.

- * @public - */ - protectedQueryIdentifier: string | undefined; - - /** - *

The target status of a query. Used to update the execution status of a currently running - * query.

- * @public - */ - targetStatus: TargetProtectedQueryStatus | undefined; + computeConfiguration?: ComputeConfiguration; } /** @@ -8020,6 +8035,7 @@ export const ProtectedQueryFilterSensitiveLog = (obj: ProtectedQuery): any => ({ ...(obj.sqlParameters && { sqlParameters: SENSITIVE_STRING }), ...(obj.resultConfiguration && { resultConfiguration: obj.resultConfiguration }), ...(obj.result && { result: obj.result }), + ...(obj.computeConfiguration && { computeConfiguration: obj.computeConfiguration }), }); /** @@ -8037,12 +8053,5 @@ export const StartProtectedQueryInputFilterSensitiveLog = (obj: StartProtectedQu ...obj, ...(obj.sqlParameters && { sqlParameters: SENSITIVE_STRING }), ...(obj.resultConfiguration && { resultConfiguration: obj.resultConfiguration }), -}); - -/** - * @internal - */ -export const StartProtectedQueryOutputFilterSensitiveLog = (obj: StartProtectedQueryOutput): any => ({ - ...obj, - ...(obj.protectedQuery && { protectedQuery: ProtectedQueryFilterSensitiveLog(obj.protectedQuery) }), + ...(obj.computeConfiguration && { computeConfiguration: obj.computeConfiguration }), }); diff --git a/clients/client-cleanrooms/src/models/models_1.ts b/clients/client-cleanrooms/src/models/models_1.ts index 3e526c5b583c2..651940a3d5bd9 100644 --- a/clients/client-cleanrooms/src/models/models_1.ts +++ b/clients/client-cleanrooms/src/models/models_1.ts @@ -1,5 +1,8 @@ // smithy-typescript generated code import { + Membership, + MembershipProtectedQueryResultConfiguration, + MembershipQueryLogStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, @@ -7,6 +10,90 @@ import { ProtectedQueryFilterSensitiveLog, } from "./models_0"; +/** + * @public + */ +export interface StartProtectedQueryOutput { + /** + *

The protected query.

+ * @public + */ + protectedQuery: ProtectedQuery | undefined; +} + +/** + * @public + */ +export interface UpdateMembershipInput { + /** + *

The unique identifier of the membership.

+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *

An indicator as to whether query logging has been enabled or disabled for the + * membership.

+ * @public + */ + queryLogStatus?: MembershipQueryLogStatus; + + /** + *

The default protected query result configuration as specified by the member who can + * receive results.

+ * @public + */ + defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration; +} + +/** + * @public + */ +export interface UpdateMembershipOutput { + /** + *

The membership object.

+ * @public + */ + membership: Membership | undefined; +} + +/** + * @public + * @enum + */ +export const TargetProtectedQueryStatus = { + CANCELLED: "CANCELLED", +} as const; + +/** + * @public + */ +export type TargetProtectedQueryStatus = (typeof TargetProtectedQueryStatus)[keyof typeof TargetProtectedQueryStatus]; + +/** + * @public + */ +export interface UpdateProtectedQueryInput { + /** + *

The identifier for a member of a protected query instance.

+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *

The identifier for a protected query instance.

+ * @public + */ + protectedQueryIdentifier: string | undefined; + + /** + *

The target status of a query. Used to update the execution status of a currently running + * query.

+ * @public + */ + targetStatus: TargetProtectedQueryStatus | undefined; +} + /** * @public */ @@ -186,9 +273,7 @@ export interface PrivacyBudgetTemplate { autoRefresh: PrivacyBudgetTemplateAutoRefresh | undefined; /** - *

Specifies the - * epsilon - * and noise parameters for the privacy budget template.

+ *

Specifies the epsilon and noise parameters for the privacy budget template.

* @public */ parameters: PrivacyBudgetTemplateParametersOutput | undefined; @@ -266,16 +351,14 @@ export interface ListPrivacyBudgetTemplatesInput { membershipIdentifier: string | undefined; /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; /** - *

The maximum size of the results that is returned per call. Service chooses a default if - * it has not been set. Service may return a nextToken even if the maximum results has not - * been met.

+ *

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the + * `maxResults` value has not been met.

* @public */ maxResults?: number; @@ -346,8 +429,7 @@ export interface PrivacyBudgetTemplateSummary { */ export interface ListPrivacyBudgetTemplatesOutput { /** - *

The token value retrieved from a previous call to access the next page of - * results.

+ *

The pagination token that's used to fetch the next set of results.

* @public */ nextToken?: string; @@ -502,6 +584,14 @@ export interface UntagResourceInput { */ export interface UntagResourceOutput {} +/** + * @internal + */ +export const StartProtectedQueryOutputFilterSensitiveLog = (obj: StartProtectedQueryOutput): any => ({ + ...obj, + ...(obj.protectedQuery && { protectedQuery: ProtectedQueryFilterSensitiveLog(obj.protectedQuery) }), +}); + /** * @internal */ diff --git a/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts b/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts index 3e09b5dc6b79f..34cfb9ad0cc5e 100644 --- a/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts +++ b/clients/client-cleanrooms/src/protocols/Aws_restJson1.ts @@ -13,6 +13,7 @@ import { decorateServiceException as __decorateServiceException, expectBoolean as __expectBoolean, expectInt32 as __expectInt32, + expectLong as __expectLong, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectObject as __expectObject, @@ -312,6 +313,7 @@ import { AnalysisSource, AnalysisTemplate, AnalysisTemplateSummary, + BilledResourceUtilization, Collaboration, CollaborationAnalysisTemplate, CollaborationAnalysisTemplateSummary, @@ -323,6 +325,7 @@ import { CollaborationPrivacyBudgetTemplate, CollaborationPrivacyBudgetTemplateSummary, CollaborationSummary, + ComputeConfiguration, ConfiguredAudienceModelAssociation, ConfiguredAudienceModelAssociationSummary, ConfiguredTable, @@ -374,6 +377,7 @@ import { ProtectedQueryResultConfiguration, ProtectedQueryS3OutputConfiguration, ProtectedQuerySQLParameters, + ProtectedQueryStatistics, ProtectedQuerySummary, QueryComputePaymentConfig, ResourceNotFoundException, @@ -385,6 +389,7 @@ import { TableReference, ThrottlingException, ValidationException, + WorkerComputeConfiguration, } from "../models/models_0"; import { DifferentialPrivacyTemplateParametersInput, @@ -507,6 +512,7 @@ export const se_CreateCollaborationCommand = async ( let body: any; body = JSON.stringify( take(input, { + analyticsEngine: [], creatorDisplayName: [], creatorMemberAbilities: (_) => _json(_), creatorPaymentConfiguration: (_) => _json(_), @@ -1782,6 +1788,7 @@ export const se_StartProtectedQueryCommand = async ( let body: any; body = JSON.stringify( take(input, { + computeConfiguration: (_) => _json(_), resultConfiguration: (_) => _json(_), sqlParameters: (_) => _json(_), type: [], @@ -4023,6 +4030,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_AnalysisTemplateArnList omitted. +// se_ComputeConfiguration omitted. + // se_ConfiguredTableAnalysisRulePolicy omitted. // se_ConfiguredTableAnalysisRulePolicyV1 omitted. @@ -4109,6 +4118,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_TagMap omitted. +// se_WorkerComputeConfiguration omitted. + // de_AggregateColumn omitted. // de_AggregateColumnList omitted. @@ -4240,11 +4251,21 @@ const de_AnalysisTemplateSummaryList = (output: any, context: __SerdeContext): A // de_BatchGetSchemaErrorList omitted. +/** + * deserializeAws_restJson1BilledResourceUtilization + */ +const de_BilledResourceUtilization = (output: any, context: __SerdeContext): BilledResourceUtilization => { + return take(output, { + units: __limitedParseDouble, + }) as any; +}; + /** * deserializeAws_restJson1Collaboration */ const de_Collaboration = (output: any, context: __SerdeContext): Collaboration => { return take(output, { + analyticsEngine: __expectString, arn: __expectString, createTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), creatorAccountId: __expectString, @@ -4545,6 +4566,7 @@ const de_CollaborationPrivacyBudgetTemplateSummaryList = ( */ const de_CollaborationSummary = (output: any, context: __SerdeContext): CollaborationSummary => { return take(output, { + analyticsEngine: __expectString, arn: __expectString, createTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), creatorAccountId: __expectString, @@ -4574,6 +4596,8 @@ const de_CollaborationSummaryList = (output: any, context: __SerdeContext): Coll // de_ColumnList omitted. +// de_ComputeConfiguration omitted. + // de_ConfigurationDetails omitted. /** @@ -5189,6 +5213,7 @@ const de_PrivacyBudgetTemplateSummaryList = (output: any, context: __SerdeContex */ const de_ProtectedQuery = (output: any, context: __SerdeContext): ProtectedQuery => { return take(output, { + computeConfiguration: (_: any) => _json(__expectUnion(_)), createTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), differentialPrivacy: (_: any) => de_DifferentialPrivacyParameters(_, context), error: _json, @@ -5198,7 +5223,7 @@ const de_ProtectedQuery = (output: any, context: __SerdeContext): ProtectedQuery result: _json, resultConfiguration: _json, sqlParameters: _json, - statistics: _json, + statistics: (_: any) => de_ProtectedQueryStatistics(_, context), status: __expectString, }) as any; }; @@ -5225,7 +5250,15 @@ const de_ProtectedQuery = (output: any, context: __SerdeContext): ProtectedQuery // de_ProtectedQuerySQLParameters omitted. -// de_ProtectedQueryStatistics omitted. +/** + * deserializeAws_restJson1ProtectedQueryStatistics + */ +const de_ProtectedQueryStatistics = (output: any, context: __SerdeContext): ProtectedQueryStatistics => { + return take(output, { + billedResourceUtilization: (_: any) => de_BilledResourceUtilization(_, context), + totalDurationInMillis: __expectLong, + }) as any; +}; /** * deserializeAws_restJson1ProtectedQuerySummary @@ -5366,6 +5399,8 @@ const de_SchemaSummaryList = (output: any, context: __SerdeContext): SchemaSumma // de_ValidationExceptionFieldList omitted. +// de_WorkerComputeConfiguration omitted. + /** * deserializeAws_restJson1Document */ diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index 3ae9dc3c74b3e..556271754a40a 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -968,25 +968,25 @@ } }, "com.amazonaws.cleanrooms#AnalysisFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "SQL", - "value": "SQL" + "type": "enum", + "members": { + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" } - ] + } } }, "com.amazonaws.cleanrooms#AnalysisMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "DIRECT_QUERY", - "value": "DIRECT_QUERY" + "type": "enum", + "members": { + "DIRECT_QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUERY" } - ] + } } }, "com.amazonaws.cleanrooms#AnalysisParameter": { @@ -1136,7 +1136,7 @@ "additionalAnalyses": { "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", "traits": { - "smithy.api#documentation": "

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

\n

The\n additionalAnalyses\n parameter is\n currently\n supported for the list analysis rule (AnalysisRuleList) and the custom\n analysis rule (AnalysisRuleCustom).

" + "smithy.api#documentation": "

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

\n

The additionalAnalyses parameter is currently supported for the list\n analysis rule (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).

" } } }, @@ -1528,7 +1528,7 @@ "smithy.api#length": { "max": 200 }, - "smithy.api#pattern": "^(ANY_QUERY|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)$" + "smithy.api#pattern": "^(ANY_QUERY|ANY_JOB|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)$" } }, "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier": { @@ -1775,6 +1775,23 @@ } } }, + "com.amazonaws.cleanrooms#AnalyticsEngine": { + "type": "enum", + "members": { + "SPARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPARK" + } + }, + "CLEAN_ROOMS_SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLEAN_ROOMS_SQL" + } + } + } + }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { "type": "operation", "input": { @@ -2136,6 +2153,21 @@ } } }, + "com.amazonaws.cleanrooms#BilledResourceUtilization": { + "type": "structure", + "members": { + "units": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.

" + } + }, "com.amazonaws.cleanrooms#CleanroomsArn": { "type": "string", "traits": { @@ -2235,6 +2267,12 @@ "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

", "smithy.api#required": {} } + }, + "analyticsEngine": { + "target": "com.amazonaws.cleanrooms#AnalyticsEngine", + "traits": { + "smithy.api#documentation": "

The analytics engine for the collaboration.

" + } } }, "traits": { @@ -2496,7 +2534,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports AWS account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -2574,7 +2612,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports AWS account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -3036,18 +3074,20 @@ } }, "com.amazonaws.cleanrooms#CollaborationQueryLogStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ENABLED", - "value": "ENABLED" - }, - { - "name": "DISABLED", - "value": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.cleanrooms#CollaborationResource": { @@ -3207,6 +3247,12 @@ "traits": { "smithy.api#documentation": "

The ARN of a member in a collaboration.

" } + }, + "analyticsEngine": { + "target": "com.amazonaws.cleanrooms#AnalyticsEngine", + "traits": { + "smithy.api#documentation": "

The analytics engine.

" + } } }, "traits": { @@ -3265,6 +3311,20 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" } }, + "com.amazonaws.cleanrooms#ComputeConfiguration": { + "type": "union", + "members": { + "worker": { + "target": "com.amazonaws.cleanrooms#WorkerComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The worker configuration for the compute environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the compute resources for an analysis with the Spark analytics engine.

" + } + }, "com.amazonaws.cleanrooms#ConfigurationDetails": { "type": "union", "members": { @@ -3849,7 +3909,7 @@ "configuredTableAssociationId": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

\n The\n unique identifier for the configured table association.

", + "smithy.api#documentation": "

The unique identifier for the configured table association.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" } @@ -3857,7 +3917,7 @@ "configuredTableAssociationArn": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", "traits": { - "smithy.api#documentation": "

\n The\n Amazon Resource Name (ARN) of the configured table association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured table association.

", "smithy.api#required": {} } }, @@ -3891,7 +3951,7 @@ } }, "traits": { - "smithy.api#documentation": "

An\n analysis rule for a configured table association. This analysis rule specifies how data\n from the table can be used within its associated\n collaboration.\n In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

" + "smithy.api#documentation": "

An analysis rule for a configured table association. This analysis rule specifies how\n data from the table can be used within its associated collaboration. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleAggregation": { @@ -3906,7 +3966,7 @@ "allowedAdditionalAnalyses": { "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", "traits": { - "smithy.api#documentation": "

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

\n

The\n allowedAdditionalAnalyses\n parameter\n is currently supported for the list analysis rule\n (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).

" + "smithy.api#documentation": "

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

\n

The allowedAdditionalAnalyses parameter is currently supported for the list\n analysis rule (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).

" } } }, @@ -3920,7 +3980,7 @@ "allowedResultReceivers": { "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", "traits": { - "smithy.api#documentation": "

The list of\n collaboration members who are allowed\n to\n receive results of queries run with this configured table.

" + "smithy.api#documentation": "

The list of collaboration members who are allowed to receive results of queries run\n with this configured table.

" } }, "allowedAdditionalAnalyses": { @@ -4541,6 +4601,12 @@ "traits": { "smithy.api#documentation": "

The collaboration creator's payment responsibilities set by the collaboration creator.

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" } + }, + "analyticsEngine": { + "target": "com.amazonaws.cleanrooms#AnalyticsEngine", + "traits": { + "smithy.api#documentation": "

The analytics engine.

" + } } } }, @@ -4912,7 +4978,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": "

The analysis rule for the configured table association.\n In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", + "smithy.api#documentation": "

The analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", "smithy.api#required": {} } } @@ -5831,7 +5897,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete an existing configured table association analysis rule" }, - "smithy.api#documentation": "

Deletes\n an analysis rule for a configured table association.

", + "smithy.api#documentation": "

Deletes an analysis rule for a configured table association.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -5855,7 +5921,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The\n identifier for the configured table association that's related to the analysis rule that you\n want to delete.

", + "smithy.api#documentation": "

The identifier for the configured table association that's related to the analysis rule\n that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -5864,7 +5930,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The\n type of the analysis rule that you want to delete.

", + "smithy.api#documentation": "

The type of the analysis rule that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7341,7 +7407,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to get analysis rules for a configured table association" }, - "smithy.api#documentation": "

\n Retrieves\n the analysis rule for a configured table association.

", + "smithy.api#documentation": "

Retrieves the analysis rule for a configured table association.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -7365,7 +7431,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

\n The\n identifier for the configured table association that's related to the analysis\n rule.

", + "smithy.api#documentation": "

The identifier for the configured table association that's related to the analysis\n rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -7374,7 +7440,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", "traits": { - "smithy.api#documentation": "

\n The\n type of analysis rule that you want to retrieve.

", + "smithy.api#documentation": "

The type of analysis rule that you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7390,7 +7456,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": "

The\n analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", + "smithy.api#documentation": "

The analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", "smithy.api#required": {} } } @@ -8831,14 +8897,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -8850,7 +8916,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "analysisTemplateSummaries": { @@ -8916,14 +8982,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -8935,7 +9001,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "collaborationAnalysisTemplateSummaries": { @@ -9004,14 +9070,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9033,7 +9099,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } }, @@ -9192,14 +9258,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9214,7 +9280,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "collaborationPrivacyBudgetTemplateSummaries": { @@ -9294,14 +9360,14 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -9323,7 +9389,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } }, @@ -9373,14 +9439,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } }, @@ -9399,7 +9465,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "collaborationList": { @@ -9467,14 +9533,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9557,14 +9623,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9583,7 +9649,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } } @@ -9630,14 +9696,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9656,7 +9722,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } } @@ -9901,14 +9967,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -9920,7 +9986,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "memberSummaries": { @@ -9974,14 +10040,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } }, @@ -10000,7 +10066,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "membershipSummaries": { @@ -10068,14 +10134,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -10090,7 +10156,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "privacyBudgetTemplateSummaries": { @@ -10170,14 +10236,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -10199,7 +10265,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } }, @@ -10270,14 +10336,14 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service can return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n `maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -10289,7 +10355,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } }, "protectedQueries": { @@ -10355,21 +10421,21 @@ "schemaType": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.

", + "smithy.api#documentation": "

If present, filter schemas by schema type.

", "smithy.api#httpQuery": "schemaType" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } } @@ -10388,7 +10454,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } } @@ -10469,18 +10535,20 @@ } }, "com.amazonaws.cleanrooms#MemberAbility": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "CAN_QUERY", - "value": "CAN_QUERY" - }, - { - "name": "CAN_RECEIVE_RESULTS", - "value": "CAN_RECEIVE_RESULTS" + "type": "enum", + "members": { + "CAN_QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAN_QUERY" } - ] + }, + "CAN_RECEIVE_RESULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAN_RECEIVE_RESULTS" + } + } } }, "com.amazonaws.cleanrooms#MemberList": { @@ -11121,6 +11189,84 @@ "traits": { "smithy.api#enumValue": "VARBYTE" } + }, + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINARY" + } + }, + "BYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE" + } + }, + "CHARACTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHARACTER" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INT" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + }, + "NUMERIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC" + } + }, + "SHORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHORT" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "TIMESTAMP_LTZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP_LTZ" + } + }, + "TIMESTAMP_NTZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP_NTZ" + } + }, + "TINYINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TINYINT" + } } } }, @@ -11169,6 +11315,9 @@ { "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -11496,7 +11645,7 @@ "parameters": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput", "traits": { - "smithy.api#documentation": "

Specifies the\n epsilon\n and noise parameters for the privacy budget template.

", + "smithy.api#documentation": "

Specifies the epsilon and noise parameters for the privacy budget template.

", "smithy.api#required": {} } } @@ -11795,6 +11944,12 @@ "traits": { "smithy.api#documentation": "

The sensitivity parameters of the differential privacy results of the protected query.

" } + }, + "computeConfiguration": { + "target": "com.amazonaws.cleanrooms#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The compute configuration for the protected query.

" + } } }, "traits": { @@ -11839,7 +11994,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The\n unique identifier for the account.

", + "smithy.api#documentation": "

The unique identifier for the account.

", "smithy.api#required": {} } } @@ -11880,7 +12035,7 @@ "s3": { "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration", "traits": { - "smithy.api#documentation": "

Required configuration for a protected query with an\n s3\n output type.

" + "smithy.api#documentation": "

Required configuration for a protected query with an s3 output type.

" } }, "member": { @@ -11966,6 +12121,12 @@ "traits": { "smithy.api#documentation": "

The S3 prefix to unload the protected query results.

" } + }, + "singleFileOutput": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether files should be output as a single file (TRUE) or output\n as multiple files (FALSE). This parameter is only supported for analyses with\n the Spark analytics engine.

" + } } }, "traits": { @@ -12025,6 +12186,12 @@ "traits": { "smithy.api#documentation": "

The duration of the protected query, from creation until query completion.

" } + }, + "billedResourceUtilization": { + "target": "com.amazonaws.cleanrooms#BilledResourceUtilization", + "traits": { + "smithy.api#documentation": "

The billed resource utilization.

" + } } }, "traits": { @@ -12101,7 +12268,7 @@ "status": { "target": "com.amazonaws.cleanrooms#ProtectedQueryStatus", "traits": { - "smithy.api#documentation": "

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,\n `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

", + "smithy.api#documentation": "

The status of the protected query.

", "smithy.api#required": {} } }, @@ -12439,7 +12606,7 @@ "columns": { "target": "com.amazonaws.cleanrooms#ColumnList", "traits": { - "smithy.api#documentation": "

The columns for the relation this schema represents.

", + "smithy.api#documentation": "

The columns for the relation that this schema represents.

", "smithy.api#required": {} } }, @@ -12453,14 +12620,14 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The analysis rule types associated with the schema. Currently, only one entry is\n present.

", + "smithy.api#documentation": "

The analysis rule types that are associated with the schema. Currently, only one entry is\n present.

", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the schema. The only valid value is currently\n DIRECT_QUERY.

" + "smithy.api#documentation": "

The analysis method for the schema. The only valid value is currently\n DIRECT_QUERY.

" } }, "creatorAccountId": { @@ -12487,7 +12654,7 @@ "collaborationArn": { "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the collaboration that the schema belongs to.

", + "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

", "smithy.api#required": {} } }, @@ -12501,21 +12668,21 @@ "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the schema was created.

", + "smithy.api#documentation": "

The time at which the schema was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the schema was last updated.

", + "smithy.api#documentation": "

The most recent time at which the schema was updated.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "

The type of schema. The only valid value is currently `TABLE`.

", + "smithy.api#documentation": "

The type of schema.

", "smithy.api#required": {} } }, @@ -12787,7 +12954,7 @@ "type": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "

The type of schema object. The only valid schema type is currently `TABLE`.

", + "smithy.api#documentation": "

The type of schema object.

", "smithy.api#required": {} } }, @@ -12981,6 +13148,12 @@ "traits": { "smithy.api#documentation": "

The details needed to write the query results.

" } + }, + "computeConfiguration": { + "target": "com.amazonaws.cleanrooms#ComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The compute configuration for the protected query.

" + } } } }, @@ -13649,7 +13822,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update analysis rules for a configured table association" }, - "smithy.api#documentation": "

\n Updates\n the analysis rule for a configured table association.

", + "smithy.api#documentation": "

Updates the analysis rule for a configured table association.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -13681,7 +13854,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type\n that\n you want to update.

", + "smithy.api#documentation": "

The analysis rule type that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13689,7 +13862,7 @@ "analysisRulePolicy": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", "traits": { - "smithy.api#documentation": "

\n The\n updated analysis rule policy for the configured table association.

", + "smithy.api#documentation": "

The updated analysis rule policy for the configured table association.

", "smithy.api#required": {} } } @@ -13704,7 +13877,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": "

\n The\n updated analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", + "smithy.api#documentation": "

The updated analysis rule for the configured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.

", "smithy.api#required": {} } } @@ -14311,6 +14484,47 @@ } ] } + }, + "com.amazonaws.cleanrooms#WorkerComputeConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#WorkerComputeType", + "traits": { + "smithy.api#documentation": "

The worker compute configuration type.

" + } + }, + "number": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of workers.

", + "smithy.api#range": { + "min": 2, + "max": 400 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the compute resources for workers running an analysis with the\n Clean Rooms SQL analytics engine.

" + } + }, + "com.amazonaws.cleanrooms#WorkerComputeType": { + "type": "enum", + "members": { + "CR1X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.1X" + } + }, + "CR4X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.4X" + } + } + } } } }