@aws-sdk/client-cleanrooms 3.750.0 → 3.770.0

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

@@ -0,0 +1,133 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
+import { UpdateProtectedJobInput, UpdateProtectedJobOutput } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateProtectedJobCommand}.
+ */
+export interface UpdateProtectedJobCommandInput extends UpdateProtectedJobInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateProtectedJobCommand}.
+ */
+export interface UpdateProtectedJobCommandOutput extends UpdateProtectedJobOutput, __MetadataBearer {
+}
+declare const UpdateProtectedJobCommand_base: {
+    new (input: UpdateProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateProtectedJobCommandInput, UpdateProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateProtectedJobCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateProtectedJobCommandInput, UpdateProtectedJobCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the processing of a currently running job.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CleanRoomsClient, UpdateProtectedJobCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
+ * // const { CleanRoomsClient, UpdateProtectedJobCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
+ * const client = new CleanRoomsClient(config);
+ * const input = { // UpdateProtectedJobInput
+ *   membershipIdentifier: "STRING_VALUE", // required
+ *   protectedJobIdentifier: "STRING_VALUE", // required
+ *   targetStatus: "CANCELLED", // required
+ * };
+ * const command = new UpdateProtectedJobCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateProtectedJobOutput
+ * //   protectedJob: { // ProtectedJob
+ * //     id: "STRING_VALUE", // required
+ * //     membershipId: "STRING_VALUE", // required
+ * //     membershipArn: "STRING_VALUE", // required
+ * //     createTime: new Date("TIMESTAMP"), // required
+ * //     jobParameters: { // ProtectedJobParameters
+ * //       analysisTemplateArn: "STRING_VALUE",
+ * //     },
+ * //     status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS", // required
+ * //     resultConfiguration: { // ProtectedJobResultConfigurationOutput
+ * //       outputConfiguration: { // ProtectedJobOutputConfigurationOutput Union: only one key present
+ * //         s3: { // ProtectedJobS3OutputConfigurationOutput
+ * //           bucket: "STRING_VALUE", // required
+ * //           keyPrefix: "STRING_VALUE",
+ * //         },
+ * //         member: { // ProtectedJobMemberOutputConfigurationOutput
+ * //           accountId: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //     },
+ * //     statistics: { // ProtectedJobStatistics
+ * //       totalDurationInMillis: Number("long"),
+ * //       billedResourceUtilization: { // BilledJobResourceUtilization
+ * //         units: Number("double"), // required
+ * //       },
+ * //     },
+ * //     result: { // ProtectedJobResult
+ * //       output: { // ProtectedJobOutput Union: only one key present
+ * //         s3: { // ProtectedJobS3Output
+ * //           location: "STRING_VALUE", // required
+ * //         },
+ * //         memberList: [ // ProtectedJobMemberOutputList
+ * //           { // ProtectedJobSingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //     error: { // ProtectedJobError
+ * //       message: "STRING_VALUE", // required
+ * //       code: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateProtectedJobCommandInput - {@link UpdateProtectedJobCommandInput}
+ * @returns {@link UpdateProtectedJobCommandOutput}
+ * @see {@link UpdateProtectedJobCommandInput} for command's `input` shape.
+ * @see {@link UpdateProtectedJobCommandOutput} 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 ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</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>
+ *
+ * @public
+ */
+export declare class UpdateProtectedJobCommand extends UpdateProtectedJobCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateProtectedJobInput;
+            output: UpdateProtectedJobOutput;
+        };
+        sdk: {
+            input: UpdateProtectedJobCommandInput;
+            output: UpdateProtectedJobCommandOutput;
+        };
+    };
+}

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

@@ -39,6 +39,7 @@ export * from "./GetIdMappingTableCommand";
 export * from "./GetIdNamespaceAssociationCommand";
 export * from "./GetMembershipCommand";
 export * from "./GetPrivacyBudgetTemplateCommand";
+export * from "./GetProtectedJobCommand";
 export * from "./GetProtectedQueryCommand";
 export * from "./GetSchemaAnalysisRuleCommand";
 export * from "./GetSchemaCommand";
@@ -58,11 +59,13 @@ export * from "./ListMembersCommand";
 export * from "./ListMembershipsCommand";
 export * from "./ListPrivacyBudgetTemplatesCommand";
 export * from "./ListPrivacyBudgetsCommand";
+export * from "./ListProtectedJobsCommand";
 export * from "./ListProtectedQueriesCommand";
 export * from "./ListSchemasCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PopulateIdMappingTableCommand";
 export * from "./PreviewPrivacyImpactCommand";
+export * from "./StartProtectedJobCommand";
 export * from "./StartProtectedQueryCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
@@ -77,4 +80,5 @@ export * from "./UpdateIdMappingTableCommand";
 export * from "./UpdateIdNamespaceAssociationCommand";
 export * from "./UpdateMembershipCommand";
 export * from "./UpdatePrivacyBudgetTemplateCommand";
+export * from "./UpdateProtectedJobCommand";
 export * from "./UpdateProtectedQueryCommand";

package/dist-types/index.d.ts

@@ -2,7 +2,7 @@
  * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
  *          <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
  *          their data together in a secure collaboration workspace. In the collaboration, members who
- *          can query and receive results can get insights into the collective datasets without either
+ *          can run queries and jobs and receive results can get insights into the collective datasets without either
  *          party getting access to the other party's raw data.</p>
  *          <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
  *             <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>