@aws-sdk/client-cleanroomsml 3.616.0 → 3.618.0

package/dist-cjs/index.js

@@ -23,6 +23,7 @@ var src_exports = {};
 __export(src_exports, {
   AccessDeniedException: () => AccessDeniedException,
   AudienceExportJobStatus: () => AudienceExportJobStatus,
+  AudienceGenerationJobDataSourceFilterSensitiveLog: () => AudienceGenerationJobDataSourceFilterSensitiveLog,
   AudienceGenerationJobStatus: () => AudienceGenerationJobStatus,
   AudienceModelStatus: () => AudienceModelStatus,
   AudienceSizeType: () => AudienceSizeType,
@@ -42,6 +43,7 @@ __export(src_exports, {
   DeleteConfiguredAudienceModelPolicyCommand: () => DeleteConfiguredAudienceModelPolicyCommand,
   DeleteTrainingDatasetCommand: () => DeleteTrainingDatasetCommand,
   GetAudienceGenerationJobCommand: () => GetAudienceGenerationJobCommand,
+  GetAudienceGenerationJobResponseFilterSensitiveLog: () => GetAudienceGenerationJobResponseFilterSensitiveLog,
   GetAudienceModelCommand: () => GetAudienceModelCommand,
   GetConfiguredAudienceModelCommand: () => GetConfiguredAudienceModelCommand,
   GetConfiguredAudienceModelPolicyCommand: () => GetConfiguredAudienceModelPolicyCommand,
@@ -53,12 +55,14 @@ __export(src_exports, {
   ListTagsForResourceCommand: () => ListTagsForResourceCommand,
   ListTrainingDatasetsCommand: () => ListTrainingDatasetsCommand,
   PolicyExistenceCondition: () => PolicyExistenceCondition,
+  ProtectedQuerySQLParametersFilterSensitiveLog: () => ProtectedQuerySQLParametersFilterSensitiveLog,
   PutConfiguredAudienceModelPolicyCommand: () => PutConfiguredAudienceModelPolicyCommand,
   ResourceNotFoundException: () => ResourceNotFoundException,
   ServiceQuotaExceededException: () => ServiceQuotaExceededException,
   SharedAudienceMetrics: () => SharedAudienceMetrics,
   StartAudienceExportJobCommand: () => StartAudienceExportJobCommand,
   StartAudienceGenerationJobCommand: () => StartAudienceGenerationJobCommand,
+  StartAudienceGenerationJobRequestFilterSensitiveLog: () => StartAudienceGenerationJobRequestFilterSensitiveLog,
   TagOnCreatePolicy: () => TagOnCreatePolicy,
   TagResourceCommand: () => TagResourceCommand,
   TrainingDatasetStatus: () => TrainingDatasetStatus,
@@ -245,6 +249,7 @@ __name(_CleanRoomsMLServiceException, "CleanRoomsMLServiceException");
 var CleanRoomsMLServiceException = _CleanRoomsMLServiceException;
 
 // src/models/models_0.ts
+
 var _AccessDeniedException = class _AccessDeniedException extends CleanRoomsMLServiceException {
   /**
    * @internal
@@ -386,6 +391,21 @@ var DatasetType = {
 var TrainingDatasetStatus = {
   ACTIVE: "ACTIVE"
 };
+var ProtectedQuerySQLParametersFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj
+}), "ProtectedQuerySQLParametersFilterSensitiveLog");
+var AudienceGenerationJobDataSourceFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.sqlParameters && { sqlParameters: import_smithy_client.SENSITIVE_STRING }
+}), "AudienceGenerationJobDataSourceFilterSensitiveLog");
+var GetAudienceGenerationJobResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.seedAudience && { seedAudience: AudienceGenerationJobDataSourceFilterSensitiveLog(obj.seedAudience) }
+}), "GetAudienceGenerationJobResponseFilterSensitiveLog");
+var StartAudienceGenerationJobRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.seedAudience && { seedAudience: AudienceGenerationJobDataSourceFilterSensitiveLog(obj.seedAudience) }
+}), "StartAudienceGenerationJobRequestFilterSensitiveLog");
 
 // src/protocols/Aws_restJson1.ts
 var se_CreateAudienceModelCommand = /* @__PURE__ */ __name(async (input, context) => {
@@ -831,6 +851,7 @@ var de_GetAudienceGenerationJobCommand = /* @__PURE__ */ __name(async (output, c
     includeSeedInOutput: import_smithy_client.expectBoolean,
     metrics: (_) => de_AudienceQualityMetrics(_, context),
     name: import_smithy_client.expectString,
+    protectedQueryIdentifier: import_smithy_client.expectString,
     seedAudience: import_smithy_client._json,
     startedBy: import_smithy_client.expectString,
     status: import_smithy_client.expectString,
@@ -1445,7 +1466,7 @@ var _GetAudienceGenerationJobCommand = class _GetAudienceGenerationJobCommand ex
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("AWSStarkControlService", "GetAudienceGenerationJob", {}).n("CleanRoomsMLClient", "GetAudienceGenerationJobCommand").f(void 0, void 0).ser(se_GetAudienceGenerationJobCommand).de(de_GetAudienceGenerationJobCommand).build() {
+}).s("AWSStarkControlService", "GetAudienceGenerationJob", {}).n("CleanRoomsMLClient", "GetAudienceGenerationJobCommand").f(void 0, GetAudienceGenerationJobResponseFilterSensitiveLog).ser(se_GetAudienceGenerationJobCommand).de(de_GetAudienceGenerationJobCommand).build() {
 };
 __name(_GetAudienceGenerationJobCommand, "GetAudienceGenerationJobCommand");
 var GetAudienceGenerationJobCommand = _GetAudienceGenerationJobCommand;
@@ -1653,7 +1674,7 @@ var _StartAudienceGenerationJobCommand = class _StartAudienceGenerationJobComman
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("AWSStarkControlService", "StartAudienceGenerationJob", {}).n("CleanRoomsMLClient", "StartAudienceGenerationJobCommand").f(void 0, void 0).ser(se_StartAudienceGenerationJobCommand).de(de_StartAudienceGenerationJobCommand).build() {
+}).s("AWSStarkControlService", "StartAudienceGenerationJob", {}).n("CleanRoomsMLClient", "StartAudienceGenerationJobCommand").f(StartAudienceGenerationJobRequestFilterSensitiveLog, void 0).ser(se_StartAudienceGenerationJobCommand).de(de_StartAudienceGenerationJobCommand).build() {
 };
 __name(_StartAudienceGenerationJobCommand, "StartAudienceGenerationJobCommand");
 var StartAudienceGenerationJobCommand = _StartAudienceGenerationJobCommand;
@@ -1812,6 +1833,10 @@ var paginateListTrainingDatasets = (0, import_core.createPaginator)(CleanRoomsML
   PolicyExistenceCondition,
   ColumnType,
   DatasetType,
-  TrainingDatasetStatus
+  TrainingDatasetStatus,
+  ProtectedQuerySQLParametersFilterSensitiveLog,
+  AudienceGenerationJobDataSourceFilterSensitiveLog,
+  GetAudienceGenerationJobResponseFilterSensitiveLog,
+  StartAudienceGenerationJobRequestFilterSensitiveLog
 });
 

package/dist-es/commands/GetAudienceGenerationJobCommand.js

@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
+import { GetAudienceGenerationJobResponseFilterSensitiveLog, } from "../models/models_0";
 import { de_GetAudienceGenerationJobCommand, se_GetAudienceGenerationJobCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class GetAudienceGenerationJobCommand extends $Command
@@ -17,7 +18,7 @@ export class GetAudienceGenerationJobCommand extends $Command
 })
     .s("AWSStarkControlService", "GetAudienceGenerationJob", {})
     .n("CleanRoomsMLClient", "GetAudienceGenerationJobCommand")
-    .f(void 0, void 0)
+    .f(void 0, GetAudienceGenerationJobResponseFilterSensitiveLog)
     .ser(se_GetAudienceGenerationJobCommand)
     .de(de_GetAudienceGenerationJobCommand)
     .build() {

package/dist-es/commands/StartAudienceGenerationJobCommand.js

@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
+import { StartAudienceGenerationJobRequestFilterSensitiveLog, } from "../models/models_0";
 import { de_StartAudienceGenerationJobCommand, se_StartAudienceGenerationJobCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class StartAudienceGenerationJobCommand extends $Command
@@ -17,7 +18,7 @@ export class StartAudienceGenerationJobCommand extends $Command
 })
     .s("AWSStarkControlService", "StartAudienceGenerationJob", {})
     .n("CleanRoomsMLClient", "StartAudienceGenerationJobCommand")
-    .f(void 0, void 0)
+    .f(StartAudienceGenerationJobRequestFilterSensitiveLog, void 0)
     .ser(se_StartAudienceGenerationJobCommand)
     .de(de_StartAudienceGenerationJobCommand)
     .build() {

package/dist-es/models/models_0.js

@@ -1,3 +1,4 @@
+import { SENSITIVE_STRING } from "@smithy/smithy-client";
 import { CleanRoomsMLServiceException as __BaseException } from "./CleanRoomsMLServiceException";
 export class AccessDeniedException extends __BaseException {
     constructor(opts) {
@@ -115,3 +116,18 @@ export const DatasetType = {
 export const TrainingDatasetStatus = {
     ACTIVE: "ACTIVE",
 };
+export const ProtectedQuerySQLParametersFilterSensitiveLog = (obj) => ({
+    ...obj,
+});
+export const AudienceGenerationJobDataSourceFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.sqlParameters && { sqlParameters: SENSITIVE_STRING }),
+});
+export const GetAudienceGenerationJobResponseFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.seedAudience && { seedAudience: AudienceGenerationJobDataSourceFilterSensitiveLog(obj.seedAudience) }),
+});
+export const StartAudienceGenerationJobRequestFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.seedAudience && { seedAudience: AudienceGenerationJobDataSourceFilterSensitiveLog(obj.seedAudience) }),
+});

package/dist-es/protocols/Aws_restJson1.js

@@ -430,6 +430,7 @@ export const de_GetAudienceGenerationJobCommand = async (output, context) => {
         includeSeedInOutput: __expectBoolean,
         metrics: (_) => de_AudienceQualityMetrics(_, context),
         name: __expectString,
+        protectedQueryIdentifier: __expectString,
         seedAudience: _json,
         startedBy: __expectString,
         status: __expectString,

package/dist-types/commands/GetAudienceGenerationJobCommand.d.ts

@@ -56,6 +56,13 @@ declare const GetAudienceGenerationJobCommand_base: {
  * //       s3Uri: "STRING_VALUE", // required
  * //     },
  * //     roleArn: "STRING_VALUE", // required
+ * //     sqlParameters: { // ProtectedQuerySQLParameters
+ * //       queryString: "STRING_VALUE",
+ * //       analysisTemplateArn: "STRING_VALUE",
+ * //       parameters: { // ParameterMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
  * //   },
  * //   includeSeedInOutput: true || false,
  * //   collaborationId: "STRING_VALUE",
@@ -75,6 +82,7 @@ declare const GetAudienceGenerationJobCommand_base: {
  * //   tags: { // TagMap
  * //     "<keys>": "STRING_VALUE",
  * //   },
+ * //   protectedQueryIdentifier: "STRING_VALUE",
  * // };
  *
  * ```

package/dist-types/commands/StartAudienceGenerationJobCommand.d.ts

@@ -42,6 +42,13 @@ declare const StartAudienceGenerationJobCommand_base: {
  *       s3Uri: "STRING_VALUE", // required
  *     },
  *     roleArn: "STRING_VALUE", // required
+ *     sqlParameters: { // ProtectedQuerySQLParameters
+ *       queryString: "STRING_VALUE",
+ *       analysisTemplateArn: "STRING_VALUE",
+ *       parameters: { // ParameterMap
+ *         "<keys>": "STRING_VALUE",
+ *       },
+ *     },
  *   },
  *   includeSeedInOutput: true || false,
  *   collaborationId: "STRING_VALUE",

package/dist-types/models/models_0.d.ts

@@ -306,6 +306,28 @@ export interface AudienceQualityMetrics {
      */
     recallMetric?: number;
 }
+/**
+ * <p>The parameters for the SQL type Protected Query.</p>
+ * @public
+ */
+export interface ProtectedQuerySQLParameters {
+    /**
+     * <p>The query string to be submitted.</p>
+     * @public
+     */
+    queryString?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) associated with the analysis template within a
+     *          collaboration.</p>
+     * @public
+     */
+    analysisTemplateArn?: string;
+    /**
+     * <p>The protected query SQL parameters.</p>
+     * @public
+     */
+    parameters?: Record<string, string>;
+}
 /**
  * <p>Defines the Amazon S3 bucket where the seed audience for the generating audience is stored.</p>
  * @public
@@ -324,12 +346,17 @@ export interface AudienceGenerationJobDataSource {
      *          </p>
      * @public
      */
-    dataSource: S3ConfigMap | undefined;
+    dataSource?: S3ConfigMap;
     /**
-     * <p>The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.</p>
+     * <p>The ARN of the IAM role that can read the Amazon S3 bucket where the seed audience is stored.</p>
      * @public
      */
     roleArn: string | undefined;
+    /**
+     * <p>The protected SQL query parameters.</p>
+     * @public
+     */
+    sqlParameters?: ProtectedQuerySQLParameters;
 }
 /**
  * @public
@@ -422,6 +449,11 @@ export interface GetAudienceGenerationJobResponse {
      * @public
      */
     tags?: Record<string, string>;
+    /**
+     * <p>The unique identifier of the protected query for this audience generation job.</p>
+     * @public
+     */
+    protectedQueryIdentifier?: string;
 }
 /**
  * @public
@@ -836,7 +868,8 @@ export interface ListAudienceModelsResponse {
     audienceModels: AudienceModelSummary[] | undefined;
 }
 /**
- * <p>Configure the list of audience output sizes that can be created. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
+ * <p>Returns the relevance scores at these audience sizes when used in the <a>GetAudienceGenerationJob</a> for a specified audience generation job and configured audience model.</p>
+ *          <p>Specifies the list of allowed <code>audienceSize</code> values when used in the <a>StartAudienceExportJob</a> for an audience generation job. You can use the <code>ABSOLUTE</code>
  *             <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
  *             <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
  * @public
@@ -1703,3 +1736,19 @@ export interface UntagResourceRequest {
  */
 export interface UntagResourceResponse {
 }
+/**
+ * @internal
+ */
+export declare const ProtectedQuerySQLParametersFilterSensitiveLog: (obj: ProtectedQuerySQLParameters) => any;
+/**
+ * @internal
+ */
+export declare const AudienceGenerationJobDataSourceFilterSensitiveLog: (obj: AudienceGenerationJobDataSource) => any;
+/**
+ * @internal
+ */
+export declare const GetAudienceGenerationJobResponseFilterSensitiveLog: (obj: GetAudienceGenerationJobResponse) => any;
+/**
+ * @internal
+ */
+export declare const StartAudienceGenerationJobRequestFilterSensitiveLog: (obj: StartAudienceGenerationJobRequest) => any;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -101,9 +101,15 @@ export interface AudienceQualityMetrics {
   relevanceMetrics: RelevanceMetric[] | undefined;
   recallMetric?: number;
 }
+export interface ProtectedQuerySQLParameters {
+  queryString?: string;
+  analysisTemplateArn?: string;
+  parameters?: Record<string, string>;
+}
 export interface AudienceGenerationJobDataSource {
-  dataSource: S3ConfigMap | undefined;
+  dataSource?: S3ConfigMap;
   roleArn: string | undefined;
+  sqlParameters?: ProtectedQuerySQLParameters;
 }
 export declare const AudienceGenerationJobStatus: {
   readonly ACTIVE: "ACTIVE";
@@ -131,6 +137,7 @@ export interface GetAudienceGenerationJobResponse {
   metrics?: AudienceQualityMetrics;
   startedBy?: string;
   tags?: Record<string, string>;
+  protectedQueryIdentifier?: string;
 }
 export interface ListAudienceGenerationJobsRequest {
   nextToken?: string;
@@ -438,3 +445,15 @@ export interface UntagResourceRequest {
   tagKeys: string[] | undefined;
 }
 export interface UntagResourceResponse {}
+export declare const ProtectedQuerySQLParametersFilterSensitiveLog: (
+  obj: ProtectedQuerySQLParameters
+) => any;
+export declare const AudienceGenerationJobDataSourceFilterSensitiveLog: (
+  obj: AudienceGenerationJobDataSource
+) => any;
+export declare const GetAudienceGenerationJobResponseFilterSensitiveLog: (
+  obj: GetAudienceGenerationJobResponse
+) => any;
+export declare const StartAudienceGenerationJobRequestFilterSensitiveLog: (
+  obj: StartAudienceGenerationJobRequest
+) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cleanroomsml",
   "description": "AWS SDK for JavaScript Cleanroomsml Client for Node.js, Browser and React Native",
-  "version": "3.616.0",
+  "version": "3.618.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-cleanroomsml",