@aws-sdk/client-cleanrooms 3.378.0 → 3.381.0

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

@@ -0,0 +1,117 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
+import { UpdateAnalysisTemplateInput, UpdateAnalysisTemplateOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAnalysisTemplateCommand}.
+ */
+export interface UpdateAnalysisTemplateCommandInput extends UpdateAnalysisTemplateInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAnalysisTemplateCommand}.
+ */
+export interface UpdateAnalysisTemplateCommandOutput extends UpdateAnalysisTemplateOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the analysis template metadata.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsClient, UpdateAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
+ * // const { CleanRoomsClient, UpdateAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
+ * const client = new CleanRoomsClient(config);
+ * const input = { // UpdateAnalysisTemplateInput
+ *   membershipIdentifier: "STRING_VALUE", // required
+ *   analysisTemplateIdentifier: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ * };
+ * const command = new UpdateAnalysisTemplateCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAnalysisTemplateOutput
+ * //   analysisTemplate: { // AnalysisTemplate
+ * //     id: "STRING_VALUE", // required
+ * //     arn: "STRING_VALUE", // required
+ * //     collaborationId: "STRING_VALUE", // required
+ * //     collaborationArn: "STRING_VALUE", // required
+ * //     membershipId: "STRING_VALUE", // required
+ * //     membershipArn: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     name: "STRING_VALUE", // required
+ * //     createTime: new Date("TIMESTAMP"), // required
+ * //     updateTime: new Date("TIMESTAMP"), // required
+ * //     schema: { // AnalysisSchema
+ * //       referencedTables: [ // QueryTables
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     format: "STRING_VALUE", // 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
+ * //         defaultValue: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateAnalysisTemplateCommandInput - {@link UpdateAnalysisTemplateCommandInput}
+ * @returns {@link UpdateAnalysisTemplateCommandOutput}
+ * @see {@link UpdateAnalysisTemplateCommandInput} for command's `input` shape.
+ * @see {@link UpdateAnalysisTemplateCommandOutput} for command's `response` shape.
+ * @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Caller does not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CleanRoomsServiceException}
+ * <p>Base exception class for all service exceptions from CleanRooms service.</p>
+ *
+ */
+export declare class UpdateAnalysisTemplateCommand extends $Command<UpdateAnalysisTemplateCommandInput, UpdateAnalysisTemplateCommandOutput, CleanRoomsClientResolvedConfig> {
+    readonly input: UpdateAnalysisTemplateCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateAnalysisTemplateCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAnalysisTemplateCommandInput, UpdateAnalysisTemplateCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -32,7 +32,7 @@ export interface UpdateConfiguredTableAnalysisRuleCommandOutput extends UpdateCo
  * const client = new CleanRoomsClient(config);
  * const input = { // UpdateConfiguredTableAnalysisRuleInput
  *   configuredTableIdentifier: "STRING_VALUE", // required
- *   analysisRuleType: "AGGREGATION" || "LIST", // required
+ *   analysisRuleType: "AGGREGATION" || "LIST" || "CUSTOM", // required
  *   analysisRulePolicy: { // ConfiguredTableAnalysisRulePolicy Union: only one key present
  *     v1: { // ConfiguredTableAnalysisRulePolicyV1 Union: only one key present
  *       list: { // AnalysisRuleList
@@ -76,6 +76,14 @@ export interface UpdateConfiguredTableAnalysisRuleCommandOutput extends UpdateCo
  *           },
  *         ],
  *       },
+ *       custom: { // AnalysisRuleCustom
+ *         allowedAnalyses: [ // AllowedAnalysesList // required
+ *           "STRING_VALUE",
+ *         ],
+ *         allowedAnalysisProviders: [ // AllowedAnalysisProviderList
+ *           "STRING_VALUE",
+ *         ],
+ *       },
  *     },
  *   },
  * };
@@ -128,9 +136,17 @@ export interface UpdateConfiguredTableAnalysisRuleCommandOutput extends UpdateCo
  * //             },
  * //           ],
  * //         },
+ * //         custom: { // AnalysisRuleCustom
+ * //           allowedAnalyses: [ // AllowedAnalysesList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           allowedAnalysisProviders: [ // AllowedAnalysisProviderList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
  * //       },
  * //     },
- * //     type: "AGGREGATION" || "LIST", // required
+ * //     type: "AGGREGATION" || "LIST" || "CUSTOM", // required
  * //     createTime: new Date("TIMESTAMP"), // required
  * //     updateTime: new Date("TIMESTAMP"), // required
  * //   },

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

@@ -52,7 +52,7 @@ export interface UpdateConfiguredTableCommandOutput extends UpdateConfiguredTabl
  * //     createTime: new Date("TIMESTAMP"), // required
  * //     updateTime: new Date("TIMESTAMP"), // required
  * //     analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
- * //       "AGGREGATION" || "LIST",
+ * //       "AGGREGATION" || "LIST" || "CUSTOM",
  * //     ],
  * //     analysisMethod: "STRING_VALUE", // required
  * //     allowedColumns: [ // AllowedColumnList // required

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

@@ -45,6 +45,10 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO
  * //     createTime: new Date("TIMESTAMP"), // required
  * //     sqlParameters: { // ProtectedQuerySQLParameters
  * //       queryString: "STRING_VALUE",
+ * //       analysisTemplateArn: "STRING_VALUE",
+ * //       parameters: { // ParameterMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
  * //     },
  * //     status: "STRING_VALUE", // required
  * //     resultConfiguration: { // ProtectedQueryResultConfiguration

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

@@ -1,15 +1,20 @@
+export * from "./BatchGetCollaborationAnalysisTemplateCommand";
 export * from "./BatchGetSchemaCommand";
+export * from "./CreateAnalysisTemplateCommand";
 export * from "./CreateCollaborationCommand";
 export * from "./CreateConfiguredTableAnalysisRuleCommand";
 export * from "./CreateConfiguredTableAssociationCommand";
 export * from "./CreateConfiguredTableCommand";
 export * from "./CreateMembershipCommand";
+export * from "./DeleteAnalysisTemplateCommand";
 export * from "./DeleteCollaborationCommand";
 export * from "./DeleteConfiguredTableAnalysisRuleCommand";
 export * from "./DeleteConfiguredTableAssociationCommand";
 export * from "./DeleteConfiguredTableCommand";
 export * from "./DeleteMemberCommand";
 export * from "./DeleteMembershipCommand";
+export * from "./GetAnalysisTemplateCommand";
+export * from "./GetCollaborationAnalysisTemplateCommand";
 export * from "./GetCollaborationCommand";
 export * from "./GetConfiguredTableAnalysisRuleCommand";
 export * from "./GetConfiguredTableAssociationCommand";
@@ -18,6 +23,8 @@ export * from "./GetMembershipCommand";
 export * from "./GetProtectedQueryCommand";
 export * from "./GetSchemaAnalysisRuleCommand";
 export * from "./GetSchemaCommand";
+export * from "./ListAnalysisTemplatesCommand";
+export * from "./ListCollaborationAnalysisTemplatesCommand";
 export * from "./ListCollaborationsCommand";
 export * from "./ListConfiguredTableAssociationsCommand";
 export * from "./ListConfiguredTablesCommand";
@@ -29,6 +36,7 @@ export * from "./ListTagsForResourceCommand";
 export * from "./StartProtectedQueryCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateAnalysisTemplateCommand";
 export * from "./UpdateCollaborationCommand";
 export * from "./UpdateConfiguredTableAnalysisRuleCommand";
 export * from "./UpdateConfiguredTableAssociationCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -1,4 +1,7 @@
 import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
 export interface ClientInputEndpointParameters {
     region?: string | Provider<string>;
     useDualstackEndpoint?: boolean | Provider<boolean>;

package/dist-types/index.d.ts

@@ -11,6 +11,7 @@
  */
 export * from "./CleanRoomsClient";
 export * from "./CleanRooms";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";