feat(client-medical-imaging): SearchImageSets API now supports follow…

…ing enhancements - Additional support for searching on UpdatedAt and SeriesInstanceUID - Support for searching existing filters between dates/times - Support for sorting the search result by Ascending/Descending - Additional parameters returned in the response
aws · Apr 3, 2024 · e1bcde9 · e1bcde9
1 parent 10f0af2
commit e1bcde9
Show file tree

Hide file tree

Showing 9 changed files with 361 additions and 68 deletions.
diff --git a/clients/client-medical-imaging/README.md b/clients/client-medical-imaging/README.md
@@ -6,21 +6,20 @@
 
 AWS SDK for JavaScript MedicalImaging Client for Node.js, Browser and React Native.
 
-<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
-care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
-an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
+<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
+that empowers healthcare providers, life science organizations, and their software partners to store,
+analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
+<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
 <i>AWS HealthImaging Developer Guide</i>
 </a>.</p>
 <note>
 <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
 they take care of request authentication, serialization, and connection management. For more information,
 see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
-<p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
-<i>See Also</i> link at the end of each section that describes an API action or data type.</p>
 </note>
 <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
 provided to actions within this Reference, along with links back to corresponding sections in the
-<i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
+<i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
 <p class="title">
 <b>Data store actions</b>
 </p>
@@ -138,23 +137,17 @@ provided to actions within this Reference, along with links back to correspondin
 <li>
 <p>
 <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
-– See
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
 </li>
 <li>
 <p>
 <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
-– See
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
 </li>
 <li>
 <p>
 <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
-– See
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
-<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
 </li>
 </ul>
 

diff --git a/clients/client-medical-imaging/src/MedicalImaging.ts b/clients/client-medical-imaging/src/MedicalImaging.ts
@@ -366,21 +366,20 @@ export interface MedicalImaging {
 }
 
 /**
- * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
- *             care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
- *             an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
+ * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
+ *             that empowers healthcare providers, life science organizations, and their software partners to store,
+ *             analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
+ *             <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
  *                <i>AWS HealthImaging Developer Guide</i>
  *             </a>.</p>
  *          <note>
  *             <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
  *                     they take care of request authentication, serialization, and connection management. For more information,
  *                     see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
- *             <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
- *                     <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
  *          </note>
  *          <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
  *              provided to actions within this Reference, along with links back to corresponding sections in the
- *              <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
+ *              <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
  *          <p class="title">
  *             <b>Data store actions</b>
  *          </p>
@@ -498,23 +497,17 @@ export interface MedicalImaging {
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
  *             </li>
  *          </ul>
  * @public

diff --git a/clients/client-medical-imaging/src/MedicalImagingClient.ts b/clients/client-medical-imaging/src/MedicalImagingClient.ts
@@ -325,21 +325,20 @@ export type MedicalImagingClientResolvedConfigType = __SmithyResolvedConfigurati
 export interface MedicalImagingClientResolvedConfig extends MedicalImagingClientResolvedConfigType {}
 
 /**
- * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
- *             care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
- *             an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
+ * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
+ *             that empowers healthcare providers, life science organizations, and their software partners to store,
+ *             analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
+ *             <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
  *                <i>AWS HealthImaging Developer Guide</i>
  *             </a>.</p>
  *          <note>
  *             <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
  *                     they take care of request authentication, serialization, and connection management. For more information,
  *                     see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
- *             <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
- *                     <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
  *          </note>
  *          <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
  *              provided to actions within this Reference, along with links back to corresponding sections in the
- *              <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
+ *              <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
  *          <p class="title">
  *             <b>Data store actions</b>
  *          </p>
@@ -457,23 +456,17 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
  *             </li>
  *          </ul>
  * @public

diff --git a/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts b/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts
@@ -28,6 +28,12 @@ export interface GetDICOMImportJobCommandOutput extends GetDICOMImportJobRespons
 
 /**
  * <p>Get the import job properties to learn more about the job or job progress.</p>
+ *          <note>
+ *             <p>The <code>jobStatus</code> refers to the execution of the import job. Therefore, an import job can return a <code>jobStatus</code> as
+ *                <code>COMPLETED</code> even if validation issues are discovered during the import process. If a <code>jobStatus</code> returns
+ *                as <code>COMPLETED</code>, we still recommend you review the output manifests written to S3, as they provide details on the success
+ *                or failure of individual P10 object imports.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts b/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts
@@ -59,7 +59,9 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
  *             DICOMAccessionNumber: "STRING_VALUE",
  *             DICOMStudyId: "STRING_VALUE",
  *             DICOMStudyInstanceUID: "STRING_VALUE",
+ *             DICOMSeriesInstanceUID: "STRING_VALUE",
  *             createdAt: new Date("TIMESTAMP"),
+ *             updatedAt: new Date("TIMESTAMP"),
  *             DICOMStudyDateAndTime: { // DICOMStudyDateAndTime
  *               DICOMStudyDate: "STRING_VALUE", // required
  *               DICOMStudyTime: "STRING_VALUE",
@@ -69,6 +71,10 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
  *         operator: "EQUAL" || "BETWEEN", // required
  *       },
  *     ],
+ *     sort: { // Sort
+ *       sortOrder: "ASC" || "DESC", // required
+ *       sortField: "updatedAt" || "createdAt" || "DICOMStudyDateAndTime", // required
+ *     },
  *   },
  *   maxResults: Number("int"),
  *   nextToken: "STRING_VALUE",
@@ -93,11 +99,19 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
  * //         DICOMNumberOfStudyRelatedSeries: Number("int"),
  * //         DICOMNumberOfStudyRelatedInstances: Number("int"),
  * //         DICOMAccessionNumber: "STRING_VALUE",
+ * //         DICOMSeriesInstanceUID: "STRING_VALUE",
+ * //         DICOMSeriesModality: "STRING_VALUE",
+ * //         DICOMSeriesBodyPart: "STRING_VALUE",
+ * //         DICOMSeriesNumber: Number("int"),
  * //         DICOMStudyDate: "STRING_VALUE",
  * //         DICOMStudyTime: "STRING_VALUE",
  * //       },
  * //     },
  * //   ],
+ * //   sort: { // Sort
+ * //     sortOrder: "ASC" || "DESC", // required
+ * //     sortField: "updatedAt" || "createdAt" || "DICOMStudyDateAndTime", // required
+ * //   },
  * //   nextToken: "STRING_VALUE",
  * // };
  *

diff --git a/clients/client-medical-imaging/src/index.ts b/clients/client-medical-imaging/src/index.ts
@@ -1,21 +1,20 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
- *             care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
- *             an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
+ * <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
+ *             that empowers healthcare providers, life science organizations, and their software partners to store,
+ *             analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
+ *             <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
  *                <i>AWS HealthImaging Developer Guide</i>
  *             </a>.</p>
  *          <note>
  *             <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
  *                     they take care of request authentication, serialization, and connection management. For more information,
  *                     see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
- *             <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
- *                     <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
  *          </note>
  *          <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
  *              provided to actions within this Reference, along with links back to corresponding sections in the
- *              <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
+ *              <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
  *          <p class="title">
  *             <b>Data store actions</b>
  *          </p>
@@ -133,23 +132,17 @@
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
- *                         – See
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
- *                         <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
+ *                         – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
  *             </li>
  *          </ul>
  *