Skip to content

Commit e1bcde9

Browse files
author
awstools
committed
feat(client-medical-imaging): SearchImageSets API now supports following 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
1 parent 10f0af2 commit e1bcde9

File tree

9 files changed

+361
-68
lines changed

9 files changed

+361
-68
lines changed

Diff for: ‎clients/client-medical-imaging/README.md

+8-15
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,20 @@
66

77
AWS SDK for JavaScript MedicalImaging Client for Node.js, Browser and React Native.
88

9-
<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
10-
care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
11-
an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
9+
<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
10+
that empowers healthcare providers, life science organizations, and their software partners to store,
11+
analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
12+
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
1213
<i>AWS HealthImaging Developer Guide</i>
1314
</a>.</p>
1415
<note>
1516
<p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
1617
they take care of request authentication, serialization, and connection management. For more information,
1718
see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
18-
<p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
19-
<i>See Also</i> link at the end of each section that describes an API action or data type.</p>
2019
</note>
2120
<p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
2221
provided to actions within this Reference, along with links back to corresponding sections in the
23-
<i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
22+
<i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
2423
<p class="title">
2524
<b>Data store actions</b>
2625
</p>
@@ -138,23 +137,17 @@ provided to actions within this Reference, along with links back to correspondin
138137
<li>
139138
<p>
140139
<a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
141-
– See
142-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
143-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
140+
– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
144141
</li>
145142
<li>
146143
<p>
147144
<a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
148-
– See
149-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
150-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
145+
– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
151146
</li>
152147
<li>
153148
<p>
154149
<a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
155-
– See
156-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
157-
<a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
150+
– See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
158151
</li>
159152
</ul>
160153

Diff for: ‎clients/client-medical-imaging/src/MedicalImaging.ts

+8-15
Original file line numberDiff line numberDiff line change
@@ -366,21 +366,20 @@ export interface MedicalImaging {
366366
}
367367

368368
/**
369-
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
370-
* care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
371-
* an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
369+
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
370+
* that empowers healthcare providers, life science organizations, and their software partners to store,
371+
* analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
372+
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
372373
* <i>AWS HealthImaging Developer Guide</i>
373374
* </a>.</p>
374375
* <note>
375376
* <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
376377
* they take care of request authentication, serialization, and connection management. For more information,
377378
* see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
378-
* <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
379-
* <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
380379
* </note>
381380
* <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
382381
* provided to actions within this Reference, along with links back to corresponding sections in the
383-
* <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
382+
* <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
384383
* <p class="title">
385384
* <b>Data store actions</b>
386385
* </p>
@@ -498,23 +497,17 @@ export interface MedicalImaging {
498497
* <li>
499498
* <p>
500499
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
501-
* – See
502-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
503-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
500+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
504501
* </li>
505502
* <li>
506503
* <p>
507504
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
508-
* – See
509-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
510-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
505+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
511506
* </li>
512507
* <li>
513508
* <p>
514509
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
515-
* – See
516-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
517-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
510+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
518511
* </li>
519512
* </ul>
520513
* @public

Diff for: ‎clients/client-medical-imaging/src/MedicalImagingClient.ts

+8-15
Original file line numberDiff line numberDiff line change
@@ -325,21 +325,20 @@ export type MedicalImagingClientResolvedConfigType = __SmithyResolvedConfigurati
325325
export interface MedicalImagingClientResolvedConfig extends MedicalImagingClientResolvedConfigType {}
326326

327327
/**
328-
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
329-
* care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
330-
* an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
328+
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
329+
* that empowers healthcare providers, life science organizations, and their software partners to store,
330+
* analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
331+
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
331332
* <i>AWS HealthImaging Developer Guide</i>
332333
* </a>.</p>
333334
* <note>
334335
* <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
335336
* they take care of request authentication, serialization, and connection management. For more information,
336337
* see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
337-
* <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
338-
* <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
339338
* </note>
340339
* <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
341340
* provided to actions within this Reference, along with links back to corresponding sections in the
342-
* <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
341+
* <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
343342
* <p class="title">
344343
* <b>Data store actions</b>
345344
* </p>
@@ -457,23 +456,17 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient
457456
* <li>
458457
* <p>
459458
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
460-
* – See
461-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
462-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
459+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
463460
* </li>
464461
* <li>
465462
* <p>
466463
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
467-
* – See
468-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
469-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
464+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
470465
* </li>
471466
* <li>
472467
* <p>
473468
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
474-
* – See
475-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
476-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
469+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
477470
* </li>
478471
* </ul>
479472
* @public

Diff for: ‎clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ export interface GetDICOMImportJobCommandOutput extends GetDICOMImportJobRespons
2828

2929
/**
3030
* <p>Get the import job properties to learn more about the job or job progress.</p>
31+
* <note>
32+
* <p>The <code>jobStatus</code> refers to the execution of the import job. Therefore, an import job can return a <code>jobStatus</code> as
33+
* <code>COMPLETED</code> even if validation issues are discovered during the import process. If a <code>jobStatus</code> returns
34+
* as <code>COMPLETED</code>, we still recommend you review the output manifests written to S3, as they provide details on the success
35+
* or failure of individual P10 object imports.</p>
36+
* </note>
3137
* @example
3238
* Use a bare-bones client and the command you need to make an API call.
3339
* ```javascript

Diff for: ‎clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts

+14
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
5959
* DICOMAccessionNumber: "STRING_VALUE",
6060
* DICOMStudyId: "STRING_VALUE",
6161
* DICOMStudyInstanceUID: "STRING_VALUE",
62+
* DICOMSeriesInstanceUID: "STRING_VALUE",
6263
* createdAt: new Date("TIMESTAMP"),
64+
* updatedAt: new Date("TIMESTAMP"),
6365
* DICOMStudyDateAndTime: { // DICOMStudyDateAndTime
6466
* DICOMStudyDate: "STRING_VALUE", // required
6567
* DICOMStudyTime: "STRING_VALUE",
@@ -69,6 +71,10 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
6971
* operator: "EQUAL" || "BETWEEN", // required
7072
* },
7173
* ],
74+
* sort: { // Sort
75+
* sortOrder: "ASC" || "DESC", // required
76+
* sortField: "updatedAt" || "createdAt" || "DICOMStudyDateAndTime", // required
77+
* },
7278
* },
7379
* maxResults: Number("int"),
7480
* nextToken: "STRING_VALUE",
@@ -93,11 +99,19 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _
9399
* // DICOMNumberOfStudyRelatedSeries: Number("int"),
94100
* // DICOMNumberOfStudyRelatedInstances: Number("int"),
95101
* // DICOMAccessionNumber: "STRING_VALUE",
102+
* // DICOMSeriesInstanceUID: "STRING_VALUE",
103+
* // DICOMSeriesModality: "STRING_VALUE",
104+
* // DICOMSeriesBodyPart: "STRING_VALUE",
105+
* // DICOMSeriesNumber: Number("int"),
96106
* // DICOMStudyDate: "STRING_VALUE",
97107
* // DICOMStudyTime: "STRING_VALUE",
98108
* // },
99109
* // },
100110
* // ],
111+
* // sort: { // Sort
112+
* // sortOrder: "ASC" || "DESC", // required
113+
* // sortField: "updatedAt" || "createdAt" || "DICOMStudyDateAndTime", // required
114+
* // },
101115
* // nextToken: "STRING_VALUE",
102116
* // };
103117
*

Diff for: ‎clients/client-medical-imaging/src/index.ts

+8-15
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health
5-
* care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For
6-
* an introduction to the service, see the <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
4+
* <p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service
5+
* that empowers healthcare providers, life science organizations, and their software partners to store,
6+
* analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
7+
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
78
* <i>AWS HealthImaging Developer Guide</i>
89
* </a>.</p>
910
* <note>
1011
* <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
1112
* they take care of request authentication, serialization, and connection management. For more information,
1213
* see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
13-
* <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the
14-
* <i>See Also</i> link at the end of each section that describes an API action or data type.</p>
1514
* </note>
1615
* <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
1716
* provided to actions within this Reference, along with links back to corresponding sections in the
18-
* <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p>
17+
* <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
1918
* <p class="title">
2019
* <b>Data store actions</b>
2120
* </p>
@@ -133,23 +132,17 @@
133132
* <li>
134133
* <p>
135134
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
136-
* – See
137-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
138-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
135+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
139136
* </li>
140137
* <li>
141138
* <p>
142139
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
143-
* – See
144-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
145-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
140+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
146141
* </li>
147142
* <li>
148143
* <p>
149144
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
150-
* – See
151-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html">Tagging a data store</a> and
152-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html">Tagging an image set</a>.</p>
145+
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
153146
* </li>
154147
* </ul>
155148
*

0 commit comments

Comments
 (0)