feat(client-medical-imaging): CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter.

Author: awstools

clients/client-medical-imaging/src/auth/httpAuthSchemeProvider.ts

@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: MedicalImagingHttpAuth
       name: "medical-imaging",
       region: authParameters.region,
     },
-    propertiesExtractor: (config: MedicalImagingClientConfig, context) => ({
+    propertiesExtractor: (config: Partial<MedicalImagingClientConfig>, context) => ({
       /**
        * @internal
        */

clients/client-medical-imaging/src/commands/CopyImageSetCommand.ts

@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { MedicalImagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MedicalImagingClient";
-import { CopyImageSetRequest, CopyImageSetResponse } from "../models/models_0";
+import { CopyImageSetRequest, CopyImageSetRequestFilterSensitiveLog, CopyImageSetResponse } from "../models/models_0";
 import { de_CopyImageSetCommand, se_CopyImageSetCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -41,12 +41,16 @@ export interface CopyImageSetCommandOutput extends CopyImageSetResponse, __Metad
  *   copyImageSetInformation: { // CopyImageSetInformation
  *     sourceImageSet: { // CopySourceImageSetInformation
  *       latestVersionId: "STRING_VALUE", // required
+ *       DICOMCopies: { // MetadataCopies
+ *         copiableAttributes: "STRING_VALUE", // required
+ *       },
  *     },
  *     destinationImageSet: { // CopyDestinationImageSet
  *       imageSetId: "STRING_VALUE", // required
  *       latestVersionId: "STRING_VALUE", // required
  *     },
  *   },
+ *   force: true || false,
  * };
  * const command = new CopyImageSetCommand(input);
  * const response = await client.send(command);
@@ -125,7 +129,7 @@ export class CopyImageSetCommand extends $Command
   })
   .s("AHIGatewayService", "CopyImageSet", {})
   .n("MedicalImagingClient", "CopyImageSetCommand")
-  .f(void 0, void 0)
+  .f(CopyImageSetRequestFilterSensitiveLog, void 0)
   .ser(se_CopyImageSetCommand)
   .de(de_CopyImageSetCommand)
   .build() {}

clients/client-medical-imaging/src/commands/GetImageSetCommand.ts

@@ -53,6 +53,9 @@ export interface GetImageSetCommandOutput extends GetImageSetResponse, __Metadat
  * //   deletedAt: new Date("TIMESTAMP"),
  * //   message: "STRING_VALUE",
  * //   imageSetArn: "STRING_VALUE",
+ * //   overrides: { // Overrides
+ * //     forced: true || false,
+ * //   },
  * // };
  *
  * ```

clients/client-medical-imaging/src/commands/ListImageSetVersionsCommand.ts

@@ -54,6 +54,9 @@ export interface ListImageSetVersionsCommandOutput extends ListImageSetVersionsR
  * //       updatedAt: new Date("TIMESTAMP"),
  * //       deletedAt: new Date("TIMESTAMP"),
  * //       message: "STRING_VALUE",
+ * //       overrides: { // Overrides
+ * //         forced: true || false,
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

clients/client-medical-imaging/src/commands/UpdateImageSetMetadataCommand.ts

@@ -43,11 +43,13 @@ export interface UpdateImageSetMetadataCommandOutput extends UpdateImageSetMetad
  *   datastoreId: "STRING_VALUE", // required
  *   imageSetId: "STRING_VALUE", // required
  *   latestVersionId: "STRING_VALUE", // required
+ *   force: true || false,
  *   updateImageSetMetadataUpdates: { // MetadataUpdates Union: only one key present
  *     DICOMUpdates: { // DICOMUpdates
  *       removableAttributes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *       updatableAttributes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *     },
+ *     revertToVersionId: "STRING_VALUE",
  *   },
  * };
  * const command = new UpdateImageSetMetadataCommand(input);

clients/client-medical-imaging/src/models/models_0.ts

@@ -63,6 +63,19 @@ export interface CopyDestinationImageSet {
   latestVersionId: string | undefined;
 }
 
+/**
+ * <p>Contains copiable <code>Attributes</code> structure and wraps information related to specific copy use cases.
+ *             For example, when copying subsets.</p>
+ * @public
+ */
+export interface MetadataCopies {
+  /**
+   * <p>The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.</p>
+   * @public
+   */
+  copiableAttributes: string | undefined;
+}
+
 /**
  * <p>Copy source image set information.</p>
  * @public
@@ -73,6 +86,13 @@ export interface CopySourceImageSetInformation {
    * @public
    */
   latestVersionId: string | undefined;
+
+  /**
+   * <p>Contains <code>MetadataCopies</code> structure and wraps information related to specific copy use cases.
+   *             For example, when copying subsets.</p>
+   * @public
+   */
+  DICOMCopies?: MetadataCopies;
 }
 
 /**
@@ -114,6 +134,13 @@ export interface CopyImageSetRequest {
    * @public
    */
   copyImageSetInformation: CopyImageSetInformation | undefined;
+
+  /**
+   * <p>Setting this flag will force the <code>CopyImageSet</code> operation, even if Patient, Study, or Series level
+   *             metadata are mismatched across the <code>sourceImageSet</code> and <code>destinationImageSet</code>.</p>
+   * @public
+   */
+  force?: boolean;
 }
 
 /**
@@ -847,6 +874,20 @@ export interface GetImageSetRequest {
   versionId?: string;
 }
 
+/**
+ * <p>Specifies the overrides used in image set modification calls to <code>CopyImageSet</code> and
+ *                 <code>UpdateImageSetMetadata</code>.</p>
+ * @public
+ */
+export interface Overrides {
+  /**
+   * <p>Setting this flag will force the <code>CopyImageSet</code> and <code>UpdateImageSetMetadata</code>
+   *             operations, even if Patient, Study, or Series level metadata are mismatched.</p>
+   * @public
+   */
+  forced?: boolean;
+}
+
 /**
  * @public
  */
@@ -910,6 +951,14 @@ export interface GetImageSetResponse {
    * @public
    */
   imageSetArn?: string;
+
+  /**
+   * <p>This object contains the details of any overrides used while creating a specific image set version.
+   *             If an image set was copied or updated using the <code>force</code> flag, this object will contain the
+   *             <code>forced</code> flag.</p>
+   * @public
+   */
+  overrides?: Overrides;
 }
 
 /**
@@ -1139,6 +1188,14 @@ export interface ImageSetProperties {
    * @public
    */
   message?: string;
+
+  /**
+   * <p>Contains details on overrides used when creating the returned version of an image set.
+   *             For example, if <code>forced</code> exists, the <code>forced</code> flag was used when
+   *             creating the image set.</p>
+   * @public
+   */
+  overrides?: Overrides;
 }
 
 /**
@@ -1817,7 +1874,10 @@ export interface DICOMUpdates {
  * <p>Contains DICOMUpdates.</p>
  * @public
  */
-export type MetadataUpdates = MetadataUpdates.DICOMUpdatesMember | MetadataUpdates.$UnknownMember;
+export type MetadataUpdates =
+  | MetadataUpdates.DICOMUpdatesMember
+  | MetadataUpdates.RevertToVersionIdMember
+  | MetadataUpdates.$UnknownMember;
 
 /**
  * @public
@@ -1829,6 +1889,21 @@ export namespace MetadataUpdates {
    */
   export interface DICOMUpdatesMember {
     DICOMUpdates: DICOMUpdates;
+    revertToVersionId?: never;
+    $unknown?: never;
+  }
+
+  /**
+   * <p>Specifies the previous image set version ID to revert the current image set back to.</p>
+   *          <note>
+   *             <p>You must provide either <code>revertToVersionId</code> or <code>DICOMUpdates</code> in your request. A
+   *                 <code>ValidationException</code> error is thrown if both parameters are provided at the same time.</p>
+   *          </note>
+   * @public
+   */
+  export interface RevertToVersionIdMember {
+    DICOMUpdates?: never;
+    revertToVersionId: string;
     $unknown?: never;
   }
 
@@ -1837,16 +1912,19 @@ export namespace MetadataUpdates {
    */
   export interface $UnknownMember {
     DICOMUpdates?: never;
+    revertToVersionId?: never;
     $unknown: [string, any];
   }
 
   export interface Visitor<T> {
     DICOMUpdates: (value: DICOMUpdates) => T;
+    revertToVersionId: (value: string) => T;
     _: (name: string, value: any) => T;
   }
 
   export const visit = <T>(value: MetadataUpdates, visitor: Visitor<T>): T => {
     if (value.DICOMUpdates !== undefined) return visitor.DICOMUpdates(value.DICOMUpdates);
+    if (value.revertToVersionId !== undefined) return visitor.revertToVersionId(value.revertToVersionId);
     return visitor._(value.$unknown[0], value.$unknown[1]);
   };
 }
@@ -1873,6 +1951,22 @@ export interface UpdateImageSetMetadataRequest {
    */
   latestVersionId: string | undefined;
 
+  /**
+   * <p>Setting this flag will force the <code>UpdateImageSetMetadata</code> operation for the following attributes:</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>Tag.StudyInstanceUID</code>, <code>Tag.SeriesInstanceUID</code>, <code>Tag.SOPInstanceUID</code>, and <code>Tag.StudyID</code>
+   *                </p>
+   *             </li>
+   *             <li>
+   *                <p>Adding, removing, or updating private tags for an individual SOP Instance</p>
+   *             </li>
+   *          </ul>
+   * @public
+   */
+  force?: boolean;
+
   /**
    * <p>Update image set metadata updates.</p>
    * @public
@@ -1933,6 +2027,40 @@ export interface UpdateImageSetMetadataResponse {
   message?: string;
 }
 
+/**
+ * @internal
+ */
+export const MetadataCopiesFilterSensitiveLog = (obj: MetadataCopies): any => ({
+  ...obj,
+  ...(obj.copiableAttributes && { copiableAttributes: SENSITIVE_STRING }),
+});
+
+/**
+ * @internal
+ */
+export const CopySourceImageSetInformationFilterSensitiveLog = (obj: CopySourceImageSetInformation): any => ({
+  ...obj,
+  ...(obj.DICOMCopies && { DICOMCopies: MetadataCopiesFilterSensitiveLog(obj.DICOMCopies) }),
+});
+
+/**
+ * @internal
+ */
+export const CopyImageSetInformationFilterSensitiveLog = (obj: CopyImageSetInformation): any => ({
+  ...obj,
+  ...(obj.sourceImageSet && { sourceImageSet: CopySourceImageSetInformationFilterSensitiveLog(obj.sourceImageSet) }),
+});
+
+/**
+ * @internal
+ */
+export const CopyImageSetRequestFilterSensitiveLog = (obj: CopyImageSetRequest): any => ({
+  ...obj,
+  ...(obj.copyImageSetInformation && {
+    copyImageSetInformation: CopyImageSetInformationFilterSensitiveLog(obj.copyImageSetInformation),
+  }),
+});
+
 /**
  * @internal
  */
@@ -2051,6 +2179,7 @@ export const DICOMUpdatesFilterSensitiveLog = (obj: DICOMUpdates): any => ({
  */
 export const MetadataUpdatesFilterSensitiveLog = (obj: MetadataUpdates): any => {
   if (obj.DICOMUpdates !== undefined) return { DICOMUpdates: DICOMUpdatesFilterSensitiveLog(obj.DICOMUpdates) };
+  if (obj.revertToVersionId !== undefined) return { revertToVersionId: obj.revertToVersionId };
   if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
 };
 

clients/client-medical-imaging/src/protocols/Aws_restJson1.ts

@@ -85,6 +85,7 @@ import {
   ImageSetProperties,
   ImageSetsMetadataSummary,
   InternalServerException,
+  MetadataCopies,
   MetadataUpdates,
   ResourceNotFoundException,
   SearchByAttributeValue,
@@ -110,6 +111,9 @@ export const se_CopyImageSetCommand = async (
   b.bp("/datastore/{datastoreId}/imageSet/{sourceImageSetId}/copyImageSet");
   b.p("datastoreId", () => input.datastoreId!, "{datastoreId}", false);
   b.p("sourceImageSetId", () => input.sourceImageSetId!, "{sourceImageSetId}", false);
+  const query: any = map({
+    [_f]: [() => input.force !== void 0, () => input[_f]!.toString()],
+  });
   let body: any;
   if (input.copyImageSetInformation !== undefined) {
     body = _json(input.copyImageSetInformation);
@@ -126,7 +130,7 @@ export const se_CopyImageSetCommand = async (
     }
   }
   b.hn(resolvedHostname);
-  b.m("POST").h(headers).b(body);
+  b.m("POST").h(headers).q(query).b(body);
   return b.build();
 };
 
@@ -531,6 +535,7 @@ export const se_UpdateImageSetMetadataCommand = async (
   b.p("imageSetId", () => input.imageSetId!, "{imageSetId}", false);
   const query: any = map({
     [_lV]: [, __expectNonNull(input[_lVI]!, `latestVersionId`)],
+    [_f]: [() => input.force !== void 0, () => input[_f]!.toString()],
   });
   let body: any;
   if (input.updateImageSetMetadataUpdates !== undefined) {
@@ -728,6 +733,7 @@ export const de_GetImageSetCommand = async (
     imageSetState: __expectString,
     imageSetWorkflowStatus: __expectString,
     message: __expectString,
+    overrides: _json,
     updatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     versionId: __expectString,
   });
@@ -1145,12 +1151,15 @@ const se_DICOMUpdates = (input: DICOMUpdates, context: __SerdeContext): any => {
 
 // se_ImageFrameInformation omitted.
 
+// se_MetadataCopies omitted.
+
 /**
  * serializeAws_restJson1MetadataUpdates
  */
 const se_MetadataUpdates = (input: MetadataUpdates, context: __SerdeContext): any => {
   return MetadataUpdates.visit(input, {
     DICOMUpdates: (value) => ({ DICOMUpdates: se_DICOMUpdates(value, context) }),
+    revertToVersionId: (value) => ({ revertToVersionId: value }),
     _: (name, value) => ({ name: value } as any),
   });
 };
@@ -1351,6 +1360,7 @@ const de_ImageSetProperties = (output: any, context: __SerdeContext): ImageSetPr
     imageSetId: __expectString,
     imageSetState: __expectString,
     message: __expectString,
+    overrides: _json,
     updatedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     versionId: __expectString,
   }) as any;
@@ -1393,6 +1403,8 @@ const de_ImageSetsMetadataSummary = (output: any, context: __SerdeContext): Imag
   }) as any;
 };
 
+// de_Overrides omitted.
+
 // de_Sort omitted.
 
 // de_TagMap omitted.
@@ -1421,6 +1433,7 @@ const _cT = "contentType";
 const _ce = "content-encoding";
 const _ct = "content-type";
 const _dS = "datastoreStatus";
+const _f = "force";
 const _jS = "jobStatus";
 const _lV = "latestVersion";
 const _lVI = "latestVersionId";