@aws-sdk/client-medical-imaging 3.835.0 → 3.840.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -144
- package/dist-cjs/index.js +9 -1
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +7 -1
- package/dist-types/MedicalImaging.d.ts +1 -144
- package/dist-types/MedicalImagingClient.d.ts +1 -144
- package/dist-types/commands/CopyImageSetCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDatastoreCommand.d.ts +1 -4
- package/dist-types/commands/GetDICOMImportJobCommand.d.ts +1 -7
- package/dist-types/commands/GetImageSetCommand.d.ts +1 -0
- package/dist-types/commands/ListImageSetVersionsCommand.d.ts +1 -0
- package/dist-types/commands/SearchImageSetsCommand.d.ts +3 -9
- package/dist-types/commands/StartDICOMImportJobCommand.d.ts +1 -3
- package/dist-types/index.d.ts +1 -144
- package/dist-types/models/models_0.d.ts +60 -41
- package/dist-types/ts3.4/models/models_0.d.ts +27 -0
- package/package.json +18 -18
|
@@ -27,15 +27,7 @@ declare const SearchImageSetsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Search image sets based on defined input attributes.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>
|
|
33
|
-
* <code>SearchImageSets</code> accepts a single search query parameter and returns a paginated
|
|
34
|
-
* response of all image sets that have the matching criteria. All date range queries must be input
|
|
35
|
-
* as <code>(lowerBound, upperBound)</code>.</p>
|
|
36
|
-
* <p>By default, <code>SearchImageSets</code> uses the <code>updatedAt</code> field for sorting
|
|
37
|
-
* in descending order from newest to oldest.</p>
|
|
38
|
-
* </note>
|
|
30
|
+
* <p>Search image sets based on defined input attributes.</p> <note> <p> <code>SearchImageSets</code> accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as <code>(lowerBound, upperBound)</code>.</p> <p>By default, <code>SearchImageSets</code> uses the <code>updatedAt</code> field for sorting in descending order from newest to oldest.</p> </note>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -60,6 +52,7 @@ declare const SearchImageSetsCommand_base: {
|
|
|
60
52
|
* DICOMStudyDate: "STRING_VALUE", // required
|
|
61
53
|
* DICOMStudyTime: "STRING_VALUE",
|
|
62
54
|
* },
|
|
55
|
+
* isPrimary: true || false,
|
|
63
56
|
* },
|
|
64
57
|
* ],
|
|
65
58
|
* operator: "EQUAL" || "BETWEEN", // required
|
|
@@ -100,6 +93,7 @@ declare const SearchImageSetsCommand_base: {
|
|
|
100
93
|
* // DICOMStudyDate: "STRING_VALUE",
|
|
101
94
|
* // DICOMStudyTime: "STRING_VALUE",
|
|
102
95
|
* // },
|
|
96
|
+
* // isPrimary: true || false,
|
|
103
97
|
* // },
|
|
104
98
|
* // ],
|
|
105
99
|
* // sort: { // Sort
|
|
@@ -27,9 +27,7 @@ declare const StartDICOMImportJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Start importing bulk data into an <code>ACTIVE</code> data store. The import job imports DICOM P10 files
|
|
31
|
-
* found in the S3 prefix specified by the <code>inputS3Uri</code> parameter. The import job stores
|
|
32
|
-
* processing results in the file specified by the <code>outputS3Uri</code> parameter.</p>
|
|
30
|
+
* <p>Start importing bulk data into an <code>ACTIVE</code> data store. The import job imports DICOM P10 files found in the S3 prefix specified by the <code>inputS3Uri</code> parameter. The import job stores processing results in the file specified by the <code>outputS3Uri</code> parameter.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,148 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>This is the <i>AWS HealthImaging API Reference</i>.
|
|
3
|
-
* that empowers healthcare providers, life science organizations, and their software partners to store,
|
|
4
|
-
* analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the
|
|
5
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">
|
|
6
|
-
* <i>AWS HealthImaging Developer Guide</i>
|
|
7
|
-
* </a>.</p>
|
|
8
|
-
* <note>
|
|
9
|
-
* <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as
|
|
10
|
-
* they take care of request authentication, serialization, and connection management. For more information,
|
|
11
|
-
* see <a href="http://aws.amazon.com/developer/tools">Tools to build on AWS</a>.</p>
|
|
12
|
-
* </note>
|
|
13
|
-
* <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are
|
|
14
|
-
* provided to actions within this Reference, along with links back to corresponding sections in the
|
|
15
|
-
* <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p>
|
|
16
|
-
* <p class="title">
|
|
17
|
-
* <b>Data store actions</b>
|
|
18
|
-
* </p>
|
|
19
|
-
* <ul>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html">CreateDatastore</a>
|
|
23
|
-
* – See
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html">Creating a data store</a>.</p>
|
|
25
|
-
* </li>
|
|
26
|
-
* <li>
|
|
27
|
-
* <p>
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html">GetDatastore</a>
|
|
29
|
-
* – See
|
|
30
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html">Getting data store properties</a>.</p>
|
|
31
|
-
* </li>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html">ListDatastores</a>
|
|
35
|
-
* – See
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html">Listing data stores</a>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>
|
|
40
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html">DeleteDatastore</a>
|
|
41
|
-
* – See
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html">Deleting a data store</a>.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* </ul>
|
|
45
|
-
* <p class="title">
|
|
46
|
-
* <b>Import job actions</b>
|
|
47
|
-
* </p>
|
|
48
|
-
* <ul>
|
|
49
|
-
* <li>
|
|
50
|
-
* <p>
|
|
51
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_StartDICOMImportJob.html">StartDICOMImportJob</a>
|
|
52
|
-
* – See
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html">Starting an import job</a>.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>
|
|
57
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDICOMImportJob.html">GetDICOMImportJob</a>
|
|
58
|
-
* – See
|
|
59
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html">Getting import job properties</a>.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>
|
|
63
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDICOMImportJobs.html">ListDICOMImportJobs</a>
|
|
64
|
-
* – See
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html">Listing import jobs</a>.</p>
|
|
66
|
-
* </li>
|
|
67
|
-
* </ul>
|
|
68
|
-
* <p class="title">
|
|
69
|
-
* <b>Image set access actions</b>
|
|
70
|
-
* </p>
|
|
71
|
-
* <ul>
|
|
72
|
-
* <li>
|
|
73
|
-
* <p>
|
|
74
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_SearchImageSets.html">SearchImageSets</a>
|
|
75
|
-
* – See
|
|
76
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html">Searching image sets</a>.</p>
|
|
77
|
-
* </li>
|
|
78
|
-
* <li>
|
|
79
|
-
* <p>
|
|
80
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSet.html">GetImageSet</a>
|
|
81
|
-
* – See
|
|
82
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html">Getting image set properties</a>.</p>
|
|
83
|
-
* </li>
|
|
84
|
-
* <li>
|
|
85
|
-
* <p>
|
|
86
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSetMetadata.html">GetImageSetMetadata</a>
|
|
87
|
-
* – See
|
|
88
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html">Getting image set metadata</a>.</p>
|
|
89
|
-
* </li>
|
|
90
|
-
* <li>
|
|
91
|
-
* <p>
|
|
92
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageFrame.html">GetImageFrame</a>
|
|
93
|
-
* – See
|
|
94
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html">Getting image set pixel data</a>.</p>
|
|
95
|
-
* </li>
|
|
96
|
-
* </ul>
|
|
97
|
-
* <p class="title">
|
|
98
|
-
* <b>Image set modification actions</b>
|
|
99
|
-
* </p>
|
|
100
|
-
* <ul>
|
|
101
|
-
* <li>
|
|
102
|
-
* <p>
|
|
103
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListImageSetVersions.html">ListImageSetVersions</a>
|
|
104
|
-
* – See
|
|
105
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html">Listing image set versions</a>.</p>
|
|
106
|
-
* </li>
|
|
107
|
-
* <li>
|
|
108
|
-
* <p>
|
|
109
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UpdateImageSetMetadata.html">UpdateImageSetMetadata</a>
|
|
110
|
-
* – See
|
|
111
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html">Updating image set metadata</a>.</p>
|
|
112
|
-
* </li>
|
|
113
|
-
* <li>
|
|
114
|
-
* <p>
|
|
115
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CopyImageSet.html">CopyImageSet</a>
|
|
116
|
-
* – See
|
|
117
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html">Copying an image set</a>.</p>
|
|
118
|
-
* </li>
|
|
119
|
-
* <li>
|
|
120
|
-
* <p>
|
|
121
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteImageSet.html">DeleteImageSet</a>
|
|
122
|
-
* – See
|
|
123
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html">Deleting an image set</a>.</p>
|
|
124
|
-
* </li>
|
|
125
|
-
* </ul>
|
|
126
|
-
* <p class="title">
|
|
127
|
-
* <b>Tagging actions</b>
|
|
128
|
-
* </p>
|
|
129
|
-
* <ul>
|
|
130
|
-
* <li>
|
|
131
|
-
* <p>
|
|
132
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html">TagResource</a>
|
|
133
|
-
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html">Tagging a resource</a>.</p>
|
|
134
|
-
* </li>
|
|
135
|
-
* <li>
|
|
136
|
-
* <p>
|
|
137
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
|
|
138
|
-
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html">Listing tags for a resource</a>.</p>
|
|
139
|
-
* </li>
|
|
140
|
-
* <li>
|
|
141
|
-
* <p>
|
|
142
|
-
* <a href="https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html">UntagResource</a>
|
|
143
|
-
* – See <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html">Untagging a resource</a>.</p>
|
|
144
|
-
* </li>
|
|
145
|
-
* </ul>
|
|
2
|
+
* <p>This is the <i>AWS HealthImaging API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html">What is AWS HealthImaging?</a> in the <i>AWS HealthImaging Developer Guide</i>.</p>
|
|
146
3
|
*
|
|
147
4
|
* @packageDocumentation
|
|
148
5
|
*/
|
|
@@ -42,8 +42,7 @@ export interface CopyDestinationImageSet {
|
|
|
42
42
|
latestVersionId: string | undefined;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* <p>Contains copiable <code>Attributes</code> structure and wraps information related to specific copy use cases.
|
|
46
|
-
* For example, when copying subsets.</p>
|
|
45
|
+
* <p>Contains copiable <code>Attributes</code> structure and wraps information related to specific copy use cases. For example, when copying subsets.</p>
|
|
47
46
|
* @public
|
|
48
47
|
*/
|
|
49
48
|
export interface MetadataCopies {
|
|
@@ -64,8 +63,7 @@ export interface CopySourceImageSetInformation {
|
|
|
64
63
|
*/
|
|
65
64
|
latestVersionId: string | undefined;
|
|
66
65
|
/**
|
|
67
|
-
* <p>Contains <code>MetadataCopies</code> structure and wraps information related to specific copy use cases.
|
|
68
|
-
* For example, when copying subsets.</p>
|
|
66
|
+
* <p>Contains <code>MetadataCopies</code> structure and wraps information related to specific copy use cases. For example, when copying subsets.</p>
|
|
69
67
|
* @public
|
|
70
68
|
*/
|
|
71
69
|
DICOMCopies?: MetadataCopies | undefined;
|
|
@@ -106,11 +104,15 @@ export interface CopyImageSetRequest {
|
|
|
106
104
|
*/
|
|
107
105
|
copyImageSetInformation: CopyImageSetInformation | undefined;
|
|
108
106
|
/**
|
|
109
|
-
* <p>
|
|
110
|
-
* metadata are mismatched across the <code>sourceImageSet</code> and <code>destinationImageSet</code>.</p>
|
|
107
|
+
* <p>Providing this parameter will force completion of the <code>CopyImageSet</code> operation, even if there are inconsistent Patient, Study, and/or Series level metadata elements between the <code>sourceImageSet</code> and <code>destinationImageSet</code>.</p>
|
|
111
108
|
* @public
|
|
112
109
|
*/
|
|
113
110
|
force?: boolean | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* <p>Providing this parameter will configure the <code>CopyImageSet</code> operation to promote the given image set to the primary DICOM hierarchy. If successful, a new primary image set ID will be returned as the destination image set.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
promoteToPrimary?: boolean | undefined;
|
|
114
116
|
}
|
|
115
117
|
/**
|
|
116
118
|
* @public
|
|
@@ -695,8 +697,7 @@ export interface GetImageFrameResponse {
|
|
|
695
697
|
*/
|
|
696
698
|
imageFrameBlob: StreamingBlobTypes | undefined;
|
|
697
699
|
/**
|
|
698
|
-
* <p>The format in which the image frame information is returned to the customer. Default is
|
|
699
|
-
* <code>application/octet-stream</code>.</p>
|
|
700
|
+
* <p>The format in which the image frame information is returned to the customer. Default is <code>application/octet-stream</code>.</p> <note> <ul> <li> <p>If the stored transfer syntax is <code>1.2.840.10008.1.2.1</code>, the returned <code>contentType</code> is <code>application/octet-stream</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is <code>1.2.840.10008.1.2.4.50</code>, the returned <code>contentType</code> is <code>image/jpeg</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is <code>1.2.840.10008.1.2.4.91</code>, the returned <code>contentType</code> is <code>image/j2c</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is MPEG2, <code>1.2.840.10008.1.2.4.100</code>, <code>1.2.840.10008.1.2.4.100.1</code>, <code>1.2.840.10008.1.2.4.101</code>, or <code>1.2.840.10008.1.2.4.101.1</code>, the returned <code>contentType</code> is <code>video/mpeg</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is MPEG-4 AVC/H.264, UID <code>1.2.840.10008.1.2.4.102</code>, <code>1.2.840.10008.1.2.4.102.1</code>, <code>1.2.840.10008.1.2.4.103</code>, <code>1.2.840.10008.1.2.4.103.1</code>, <code>1.2.840.10008.1.2.4.104</code>, <code>1.2.840.10008.1.2.4.104.1</code>, <code>1.2.840.10008.1.2.4.105</code>, <code>1.2.840.10008.1.2.4.105.1</code>, <code>1.2.840.10008.1.2.4.106</code>, or <code>1.2.840.10008.1.2.4.106.1</code>, the returned <code>contentType</code> is <code>video/mp4</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is HEVC/H.265, UID <code>1.2.840.10008.1.2.4.107</code> or <code>1.2.840.10008.1.2.4.108</code>, the returned <code>contentType</code> is <code>video/H256</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is <code>1.2.840.10008.1.2.4.202</code> or if the stored transfer syntax is <i>missing</i>, the returned <code>contentType</code> is <code>image/jph</code>.</p> </li> </ul> <ul> <li> <p>If the stored transfer syntax is <code>1.2.840.10008.1.2.4.203</code>, the returned contentType is <code>image/jphc</code>.</p> </li> </ul> </note>
|
|
700
701
|
* @public
|
|
701
702
|
*/
|
|
702
703
|
contentType?: string | undefined;
|
|
@@ -722,14 +723,12 @@ export interface GetImageSetRequest {
|
|
|
722
723
|
versionId?: string | undefined;
|
|
723
724
|
}
|
|
724
725
|
/**
|
|
725
|
-
* <p>Specifies the overrides used in image set modification calls to <code>CopyImageSet</code> and
|
|
726
|
-
* <code>UpdateImageSetMetadata</code>.</p>
|
|
726
|
+
* <p>Specifies the overrides used in image set modification calls to <code>CopyImageSet</code> and <code>UpdateImageSetMetadata</code>.</p>
|
|
727
727
|
* @public
|
|
728
728
|
*/
|
|
729
729
|
export interface Overrides {
|
|
730
730
|
/**
|
|
731
|
-
* <p>
|
|
732
|
-
* operations, even if Patient, Study, or Series level metadata are mismatched.</p>
|
|
731
|
+
* <p>Providing this parameter will force completion of the <code>CopyImageSet</code> and <code>UpdateImageSetMetadata</code> actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels.</p>
|
|
733
732
|
* @public
|
|
734
733
|
*/
|
|
735
734
|
forced?: boolean | undefined;
|
|
@@ -789,12 +788,15 @@ export interface GetImageSetResponse {
|
|
|
789
788
|
*/
|
|
790
789
|
imageSetArn?: string | undefined;
|
|
791
790
|
/**
|
|
792
|
-
* <p>This object contains the details of any overrides used while creating a specific image set version.
|
|
793
|
-
* If an image set was copied or updated using the <code>force</code> flag, this object will contain the
|
|
794
|
-
* <code>forced</code> flag.</p>
|
|
791
|
+
* <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>
|
|
795
792
|
* @public
|
|
796
793
|
*/
|
|
797
794
|
overrides?: Overrides | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The flag to determine whether the image set is primary or not.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
isPrimary?: boolean | undefined;
|
|
798
800
|
}
|
|
799
801
|
/**
|
|
800
802
|
* @public
|
|
@@ -993,12 +995,15 @@ export interface ImageSetProperties {
|
|
|
993
995
|
*/
|
|
994
996
|
message?: string | undefined;
|
|
995
997
|
/**
|
|
996
|
-
* <p>Contains details on overrides used when creating the returned version of an image set.
|
|
997
|
-
* For example, if <code>forced</code> exists, the <code>forced</code> flag was used when
|
|
998
|
-
* creating the image set.</p>
|
|
998
|
+
* <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>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
overrides?: Overrides | undefined;
|
|
1002
|
+
/**
|
|
1003
|
+
* <p>The flag to determine whether the image set is primary or not.</p>
|
|
1004
|
+
* @public
|
|
1005
|
+
*/
|
|
1006
|
+
isPrimary?: boolean | undefined;
|
|
1002
1007
|
}
|
|
1003
1008
|
/**
|
|
1004
1009
|
* @public
|
|
@@ -1067,7 +1072,7 @@ export interface DICOMStudyDateAndTime {
|
|
|
1067
1072
|
* <p>The search input attribute value.</p>
|
|
1068
1073
|
* @public
|
|
1069
1074
|
*/
|
|
1070
|
-
export type SearchByAttributeValue = SearchByAttributeValue.DICOMAccessionNumberMember | SearchByAttributeValue.DICOMPatientIdMember | SearchByAttributeValue.DICOMSeriesInstanceUIDMember | SearchByAttributeValue.DICOMStudyDateAndTimeMember | SearchByAttributeValue.DICOMStudyIdMember | SearchByAttributeValue.DICOMStudyInstanceUIDMember | SearchByAttributeValue.CreatedAtMember | SearchByAttributeValue.UpdatedAtMember | SearchByAttributeValue.$UnknownMember;
|
|
1075
|
+
export type SearchByAttributeValue = SearchByAttributeValue.DICOMAccessionNumberMember | SearchByAttributeValue.DICOMPatientIdMember | SearchByAttributeValue.DICOMSeriesInstanceUIDMember | SearchByAttributeValue.DICOMStudyDateAndTimeMember | SearchByAttributeValue.DICOMStudyIdMember | SearchByAttributeValue.DICOMStudyInstanceUIDMember | SearchByAttributeValue.CreatedAtMember | SearchByAttributeValue.IsPrimaryMember | SearchByAttributeValue.UpdatedAtMember | SearchByAttributeValue.$UnknownMember;
|
|
1071
1076
|
/**
|
|
1072
1077
|
* @public
|
|
1073
1078
|
*/
|
|
@@ -1085,6 +1090,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1085
1090
|
createdAt?: never;
|
|
1086
1091
|
updatedAt?: never;
|
|
1087
1092
|
DICOMStudyDateAndTime?: never;
|
|
1093
|
+
isPrimary?: never;
|
|
1088
1094
|
$unknown?: never;
|
|
1089
1095
|
}
|
|
1090
1096
|
/**
|
|
@@ -1100,6 +1106,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1100
1106
|
createdAt?: never;
|
|
1101
1107
|
updatedAt?: never;
|
|
1102
1108
|
DICOMStudyDateAndTime?: never;
|
|
1109
|
+
isPrimary?: never;
|
|
1103
1110
|
$unknown?: never;
|
|
1104
1111
|
}
|
|
1105
1112
|
/**
|
|
@@ -1115,6 +1122,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1115
1122
|
createdAt?: never;
|
|
1116
1123
|
updatedAt?: never;
|
|
1117
1124
|
DICOMStudyDateAndTime?: never;
|
|
1125
|
+
isPrimary?: never;
|
|
1118
1126
|
$unknown?: never;
|
|
1119
1127
|
}
|
|
1120
1128
|
/**
|
|
@@ -1130,6 +1138,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1130
1138
|
createdAt?: never;
|
|
1131
1139
|
updatedAt?: never;
|
|
1132
1140
|
DICOMStudyDateAndTime?: never;
|
|
1141
|
+
isPrimary?: never;
|
|
1133
1142
|
$unknown?: never;
|
|
1134
1143
|
}
|
|
1135
1144
|
/**
|
|
@@ -1145,6 +1154,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1145
1154
|
createdAt?: never;
|
|
1146
1155
|
updatedAt?: never;
|
|
1147
1156
|
DICOMStudyDateAndTime?: never;
|
|
1157
|
+
isPrimary?: never;
|
|
1148
1158
|
$unknown?: never;
|
|
1149
1159
|
}
|
|
1150
1160
|
/**
|
|
@@ -1160,6 +1170,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1160
1170
|
createdAt: Date;
|
|
1161
1171
|
updatedAt?: never;
|
|
1162
1172
|
DICOMStudyDateAndTime?: never;
|
|
1173
|
+
isPrimary?: never;
|
|
1163
1174
|
$unknown?: never;
|
|
1164
1175
|
}
|
|
1165
1176
|
/**
|
|
@@ -1175,6 +1186,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1175
1186
|
createdAt?: never;
|
|
1176
1187
|
updatedAt: Date;
|
|
1177
1188
|
DICOMStudyDateAndTime?: never;
|
|
1189
|
+
isPrimary?: never;
|
|
1178
1190
|
$unknown?: never;
|
|
1179
1191
|
}
|
|
1180
1192
|
/**
|
|
@@ -1190,6 +1202,23 @@ export declare namespace SearchByAttributeValue {
|
|
|
1190
1202
|
createdAt?: never;
|
|
1191
1203
|
updatedAt?: never;
|
|
1192
1204
|
DICOMStudyDateAndTime: DICOMStudyDateAndTime;
|
|
1205
|
+
isPrimary?: never;
|
|
1206
|
+
$unknown?: never;
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>The primary image set flag provided for search.</p>
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
interface IsPrimaryMember {
|
|
1213
|
+
DICOMPatientId?: never;
|
|
1214
|
+
DICOMAccessionNumber?: never;
|
|
1215
|
+
DICOMStudyId?: never;
|
|
1216
|
+
DICOMStudyInstanceUID?: never;
|
|
1217
|
+
DICOMSeriesInstanceUID?: never;
|
|
1218
|
+
createdAt?: never;
|
|
1219
|
+
updatedAt?: never;
|
|
1220
|
+
DICOMStudyDateAndTime?: never;
|
|
1221
|
+
isPrimary: boolean;
|
|
1193
1222
|
$unknown?: never;
|
|
1194
1223
|
}
|
|
1195
1224
|
/**
|
|
@@ -1204,6 +1233,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1204
1233
|
createdAt?: never;
|
|
1205
1234
|
updatedAt?: never;
|
|
1206
1235
|
DICOMStudyDateAndTime?: never;
|
|
1236
|
+
isPrimary?: never;
|
|
1207
1237
|
$unknown: [string, any];
|
|
1208
1238
|
}
|
|
1209
1239
|
interface Visitor<T> {
|
|
@@ -1215,6 +1245,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
1215
1245
|
createdAt: (value: Date) => T;
|
|
1216
1246
|
updatedAt: (value: Date) => T;
|
|
1217
1247
|
DICOMStudyDateAndTime: (value: DICOMStudyDateAndTime) => T;
|
|
1248
|
+
isPrimary: (value: boolean) => T;
|
|
1218
1249
|
_: (name: string, value: any) => T;
|
|
1219
1250
|
}
|
|
1220
1251
|
const visit: <T>(value: SearchByAttributeValue, visitor: Visitor<T>) => T;
|
|
@@ -1312,15 +1343,13 @@ export interface SearchImageSetsRequest {
|
|
|
1312
1343
|
*/
|
|
1313
1344
|
maxResults?: number | undefined;
|
|
1314
1345
|
/**
|
|
1315
|
-
* <p>The token used for pagination of results returned in the response. Use the token returned from the previous
|
|
1316
|
-
* request to continue results where the previous request ended.</p>
|
|
1346
|
+
* <p>The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.</p>
|
|
1317
1347
|
* @public
|
|
1318
1348
|
*/
|
|
1319
1349
|
nextToken?: string | undefined;
|
|
1320
1350
|
}
|
|
1321
1351
|
/**
|
|
1322
|
-
* <p>The DICOM attributes returned as a part of a response. Each image set has these properties
|
|
1323
|
-
* as part of a search result.</p>
|
|
1352
|
+
* <p>The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.</p>
|
|
1324
1353
|
* @public
|
|
1325
1354
|
*/
|
|
1326
1355
|
export interface DICOMTags {
|
|
@@ -1421,8 +1450,7 @@ export interface ImageSetsMetadataSummary {
|
|
|
1421
1450
|
*/
|
|
1422
1451
|
version?: number | undefined;
|
|
1423
1452
|
/**
|
|
1424
|
-
* <p>The time an image set is created. Sample creation
|
|
1425
|
-
* date is provided in <code>1985-04-12T23:20:50.52Z</code> format.</p>
|
|
1453
|
+
* <p>The time an image set is created. Sample creation date is provided in <code>1985-04-12T23:20:50.52Z</code> format.</p>
|
|
1426
1454
|
* @public
|
|
1427
1455
|
*/
|
|
1428
1456
|
createdAt?: Date | undefined;
|
|
@@ -1436,6 +1464,11 @@ export interface ImageSetsMetadataSummary {
|
|
|
1436
1464
|
* @public
|
|
1437
1465
|
*/
|
|
1438
1466
|
DICOMTags?: DICOMTags | undefined;
|
|
1467
|
+
/**
|
|
1468
|
+
* <p>The flag to determine whether the image set is primary or not.</p>
|
|
1469
|
+
* @public
|
|
1470
|
+
*/
|
|
1471
|
+
isPrimary?: boolean | undefined;
|
|
1439
1472
|
}
|
|
1440
1473
|
/**
|
|
1441
1474
|
* @public
|
|
@@ -1597,11 +1630,7 @@ export declare namespace MetadataUpdates {
|
|
|
1597
1630
|
$unknown?: never;
|
|
1598
1631
|
}
|
|
1599
1632
|
/**
|
|
1600
|
-
* <p>Specifies the previous image set version ID to revert the current image set back to.</p>
|
|
1601
|
-
* <note>
|
|
1602
|
-
* <p>You must provide either <code>revertToVersionId</code> or <code>DICOMUpdates</code> in your request. A
|
|
1603
|
-
* <code>ValidationException</code> error is thrown if both parameters are provided at the same time.</p>
|
|
1604
|
-
* </note>
|
|
1633
|
+
* <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>
|
|
1605
1634
|
* @public
|
|
1606
1635
|
*/
|
|
1607
1636
|
interface RevertToVersionIdMember {
|
|
@@ -1644,17 +1673,7 @@ export interface UpdateImageSetMetadataRequest {
|
|
|
1644
1673
|
*/
|
|
1645
1674
|
latestVersionId: string | undefined;
|
|
1646
1675
|
/**
|
|
1647
|
-
* <p>Setting this flag will force the <code>UpdateImageSetMetadata</code> operation for the following attributes:</p>
|
|
1648
|
-
* <ul>
|
|
1649
|
-
* <li>
|
|
1650
|
-
* <p>
|
|
1651
|
-
* <code>Tag.StudyInstanceUID</code>, <code>Tag.SeriesInstanceUID</code>, <code>Tag.SOPInstanceUID</code>, and <code>Tag.StudyID</code>
|
|
1652
|
-
* </p>
|
|
1653
|
-
* </li>
|
|
1654
|
-
* <li>
|
|
1655
|
-
* <p>Adding, removing, or updating private tags for an individual SOP Instance</p>
|
|
1656
|
-
* </li>
|
|
1657
|
-
* </ul>
|
|
1676
|
+
* <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>
|
|
1658
1677
|
* @public
|
|
1659
1678
|
*/
|
|
1660
1679
|
force?: boolean | undefined;
|
|
@@ -33,6 +33,7 @@ export interface CopyImageSetRequest {
|
|
|
33
33
|
sourceImageSetId: string | undefined;
|
|
34
34
|
copyImageSetInformation: CopyImageSetInformation | undefined;
|
|
35
35
|
force?: boolean | undefined;
|
|
36
|
+
promoteToPrimary?: boolean | undefined;
|
|
36
37
|
}
|
|
37
38
|
export declare const ImageSetState: {
|
|
38
39
|
readonly ACTIVE: "ACTIVE";
|
|
@@ -238,6 +239,7 @@ export interface GetImageSetResponse {
|
|
|
238
239
|
message?: string | undefined;
|
|
239
240
|
imageSetArn?: string | undefined;
|
|
240
241
|
overrides?: Overrides | undefined;
|
|
242
|
+
isPrimary?: boolean | undefined;
|
|
241
243
|
}
|
|
242
244
|
export interface GetImageSetMetadataRequest {
|
|
243
245
|
datastoreId: string | undefined;
|
|
@@ -285,6 +287,7 @@ export interface ImageSetProperties {
|
|
|
285
287
|
deletedAt?: Date | undefined;
|
|
286
288
|
message?: string | undefined;
|
|
287
289
|
overrides?: Overrides | undefined;
|
|
290
|
+
isPrimary?: boolean | undefined;
|
|
288
291
|
}
|
|
289
292
|
export interface ListImageSetVersionsResponse {
|
|
290
293
|
imageSetPropertiesList: ImageSetProperties[] | undefined;
|
|
@@ -313,6 +316,7 @@ export type SearchByAttributeValue =
|
|
|
313
316
|
| SearchByAttributeValue.DICOMStudyIdMember
|
|
314
317
|
| SearchByAttributeValue.DICOMStudyInstanceUIDMember
|
|
315
318
|
| SearchByAttributeValue.CreatedAtMember
|
|
319
|
+
| SearchByAttributeValue.IsPrimaryMember
|
|
316
320
|
| SearchByAttributeValue.UpdatedAtMember
|
|
317
321
|
| SearchByAttributeValue.$UnknownMember;
|
|
318
322
|
export declare namespace SearchByAttributeValue {
|
|
@@ -325,6 +329,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
325
329
|
createdAt?: never;
|
|
326
330
|
updatedAt?: never;
|
|
327
331
|
DICOMStudyDateAndTime?: never;
|
|
332
|
+
isPrimary?: never;
|
|
328
333
|
$unknown?: never;
|
|
329
334
|
}
|
|
330
335
|
interface DICOMAccessionNumberMember {
|
|
@@ -336,6 +341,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
336
341
|
createdAt?: never;
|
|
337
342
|
updatedAt?: never;
|
|
338
343
|
DICOMStudyDateAndTime?: never;
|
|
344
|
+
isPrimary?: never;
|
|
339
345
|
$unknown?: never;
|
|
340
346
|
}
|
|
341
347
|
interface DICOMStudyIdMember {
|
|
@@ -347,6 +353,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
347
353
|
createdAt?: never;
|
|
348
354
|
updatedAt?: never;
|
|
349
355
|
DICOMStudyDateAndTime?: never;
|
|
356
|
+
isPrimary?: never;
|
|
350
357
|
$unknown?: never;
|
|
351
358
|
}
|
|
352
359
|
interface DICOMStudyInstanceUIDMember {
|
|
@@ -358,6 +365,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
358
365
|
createdAt?: never;
|
|
359
366
|
updatedAt?: never;
|
|
360
367
|
DICOMStudyDateAndTime?: never;
|
|
368
|
+
isPrimary?: never;
|
|
361
369
|
$unknown?: never;
|
|
362
370
|
}
|
|
363
371
|
interface DICOMSeriesInstanceUIDMember {
|
|
@@ -369,6 +377,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
369
377
|
createdAt?: never;
|
|
370
378
|
updatedAt?: never;
|
|
371
379
|
DICOMStudyDateAndTime?: never;
|
|
380
|
+
isPrimary?: never;
|
|
372
381
|
$unknown?: never;
|
|
373
382
|
}
|
|
374
383
|
interface CreatedAtMember {
|
|
@@ -380,6 +389,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
380
389
|
createdAt: Date;
|
|
381
390
|
updatedAt?: never;
|
|
382
391
|
DICOMStudyDateAndTime?: never;
|
|
392
|
+
isPrimary?: never;
|
|
383
393
|
$unknown?: never;
|
|
384
394
|
}
|
|
385
395
|
interface UpdatedAtMember {
|
|
@@ -391,6 +401,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
391
401
|
createdAt?: never;
|
|
392
402
|
updatedAt: Date;
|
|
393
403
|
DICOMStudyDateAndTime?: never;
|
|
404
|
+
isPrimary?: never;
|
|
394
405
|
$unknown?: never;
|
|
395
406
|
}
|
|
396
407
|
interface DICOMStudyDateAndTimeMember {
|
|
@@ -402,6 +413,19 @@ export declare namespace SearchByAttributeValue {
|
|
|
402
413
|
createdAt?: never;
|
|
403
414
|
updatedAt?: never;
|
|
404
415
|
DICOMStudyDateAndTime: DICOMStudyDateAndTime;
|
|
416
|
+
isPrimary?: never;
|
|
417
|
+
$unknown?: never;
|
|
418
|
+
}
|
|
419
|
+
interface IsPrimaryMember {
|
|
420
|
+
DICOMPatientId?: never;
|
|
421
|
+
DICOMAccessionNumber?: never;
|
|
422
|
+
DICOMStudyId?: never;
|
|
423
|
+
DICOMStudyInstanceUID?: never;
|
|
424
|
+
DICOMSeriesInstanceUID?: never;
|
|
425
|
+
createdAt?: never;
|
|
426
|
+
updatedAt?: never;
|
|
427
|
+
DICOMStudyDateAndTime?: never;
|
|
428
|
+
isPrimary: boolean;
|
|
405
429
|
$unknown?: never;
|
|
406
430
|
}
|
|
407
431
|
interface $UnknownMember {
|
|
@@ -413,6 +437,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
413
437
|
createdAt?: never;
|
|
414
438
|
updatedAt?: never;
|
|
415
439
|
DICOMStudyDateAndTime?: never;
|
|
440
|
+
isPrimary?: never;
|
|
416
441
|
$unknown: [string, any];
|
|
417
442
|
}
|
|
418
443
|
interface Visitor<T> {
|
|
@@ -424,6 +449,7 @@ export declare namespace SearchByAttributeValue {
|
|
|
424
449
|
createdAt: (value: Date) => T;
|
|
425
450
|
updatedAt: (value: Date) => T;
|
|
426
451
|
DICOMStudyDateAndTime: (value: DICOMStudyDateAndTime) => T;
|
|
452
|
+
isPrimary: (value: boolean) => T;
|
|
427
453
|
_: (name: string, value: any) => T;
|
|
428
454
|
}
|
|
429
455
|
const visit: <T>(value: SearchByAttributeValue, visitor: Visitor<T>) => T;
|
|
@@ -481,6 +507,7 @@ export interface ImageSetsMetadataSummary {
|
|
|
481
507
|
createdAt?: Date | undefined;
|
|
482
508
|
updatedAt?: Date | undefined;
|
|
483
509
|
DICOMTags?: DICOMTags | undefined;
|
|
510
|
+
isPrimary?: boolean | undefined;
|
|
484
511
|
}
|
|
485
512
|
export interface SearchImageSetsResponse {
|
|
486
513
|
imageSetsMetadataSummaries: ImageSetsMetadataSummary[] | undefined;
|