@aws-sdk/client-medical-imaging 3.379.1 → 3.382.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.
@@ -31,10 +31,12 @@ export declare class ConflictException extends __BaseException {
31
31
  */
32
32
  export interface CopyDestinationImageSet {
33
33
  /**
34
+ * @public
34
35
  * <p>The image set identifier for the destination image set.</p>
35
36
  */
36
37
  imageSetId: string | undefined;
37
38
  /**
39
+ * @public
38
40
  * <p>The latest version identifier for the destination image set.</p>
39
41
  */
40
42
  latestVersionId: string | undefined;
@@ -45,6 +47,7 @@ export interface CopyDestinationImageSet {
45
47
  */
46
48
  export interface CopySourceImageSetInformation {
47
49
  /**
50
+ * @public
48
51
  * <p>The latest version identifier for the source image set.</p>
49
52
  */
50
53
  latestVersionId: string | undefined;
@@ -55,10 +58,12 @@ export interface CopySourceImageSetInformation {
55
58
  */
56
59
  export interface CopyImageSetInformation {
57
60
  /**
61
+ * @public
58
62
  * <p>The source image set.</p>
59
63
  */
60
64
  sourceImageSet: CopySourceImageSetInformation | undefined;
61
65
  /**
66
+ * @public
62
67
  * <p>The destination image set.</p>
63
68
  */
64
69
  destinationImageSet?: CopyDestinationImageSet;
@@ -68,14 +73,17 @@ export interface CopyImageSetInformation {
68
73
  */
69
74
  export interface CopyImageSetRequest {
70
75
  /**
76
+ * @public
71
77
  * <p>The data store identifier.</p>
72
78
  */
73
79
  datastoreId: string | undefined;
74
80
  /**
81
+ * @public
75
82
  * <p>The source image set identifier.</p>
76
83
  */
77
84
  sourceImageSetId: string | undefined;
78
85
  /**
86
+ * @public
79
87
  * <p>Copy image set information.</p>
80
88
  */
81
89
  copyImageSetInformation: CopyImageSetInformation | undefined;
@@ -119,30 +127,37 @@ export type ImageSetWorkflowStatus = (typeof ImageSetWorkflowStatus)[keyof typeo
119
127
  */
120
128
  export interface CopyDestinationImageSetProperties {
121
129
  /**
130
+ * @public
122
131
  * <p>The image set identifier of the copied image set properties.</p>
123
132
  */
124
133
  imageSetId: string | undefined;
125
134
  /**
135
+ * @public
126
136
  * <p>The latest version identifier for the destination image set properties.</p>
127
137
  */
128
138
  latestVersionId: string | undefined;
129
139
  /**
140
+ * @public
130
141
  * <p>The image set state of the destination image set properties.</p>
131
142
  */
132
143
  imageSetState?: ImageSetState | string;
133
144
  /**
145
+ * @public
134
146
  * <p>The image set workflow status of the destination image set properties.</p>
135
147
  */
136
148
  imageSetWorkflowStatus?: ImageSetWorkflowStatus | string;
137
149
  /**
150
+ * @public
138
151
  * <p>The timestamp when the destination image set properties were created.</p>
139
152
  */
140
153
  createdAt?: Date;
141
154
  /**
155
+ * @public
142
156
  * <p>The timestamp when the destination image set properties were last updated.</p>
143
157
  */
144
158
  updatedAt?: Date;
145
159
  /**
160
+ * @public
146
161
  * <p>The Amazon Resource Name (ARN) assigned to the destination image set.</p>
147
162
  */
148
163
  imageSetArn?: string;
@@ -153,30 +168,37 @@ export interface CopyDestinationImageSetProperties {
153
168
  */
154
169
  export interface CopySourceImageSetProperties {
155
170
  /**
171
+ * @public
156
172
  * <p>The image set identifier for the copied source image set.</p>
157
173
  */
158
174
  imageSetId: string | undefined;
159
175
  /**
176
+ * @public
160
177
  * <p>The latest version identifier for the copied source image set.</p>
161
178
  */
162
179
  latestVersionId: string | undefined;
163
180
  /**
181
+ * @public
164
182
  * <p>The image set state of the copied source image set.</p>
165
183
  */
166
184
  imageSetState?: ImageSetState | string;
167
185
  /**
186
+ * @public
168
187
  * <p>The workflow status of the copied source image set.</p>
169
188
  */
170
189
  imageSetWorkflowStatus?: ImageSetWorkflowStatus | string;
171
190
  /**
191
+ * @public
172
192
  * <p>The timestamp when the source image set properties were created.</p>
173
193
  */
174
194
  createdAt?: Date;
175
195
  /**
196
+ * @public
176
197
  * <p>The timestamp when the source image set properties were updated.</p>
177
198
  */
178
199
  updatedAt?: Date;
179
200
  /**
201
+ * @public
180
202
  * <p>The Amazon Resource Name (ARN) assigned to the source image set.</p>
181
203
  */
182
204
  imageSetArn?: string;
@@ -186,14 +208,17 @@ export interface CopySourceImageSetProperties {
186
208
  */
187
209
  export interface CopyImageSetResponse {
188
210
  /**
211
+ * @public
189
212
  * <p>The data store identifier.</p>
190
213
  */
191
214
  datastoreId: string | undefined;
192
215
  /**
216
+ * @public
193
217
  * <p>The properties of the source image set.</p>
194
218
  */
195
219
  sourceImageSetProperties: CopySourceImageSetProperties | undefined;
196
220
  /**
221
+ * @public
197
222
  * <p>The properties of the destination image set.</p>
198
223
  */
199
224
  destinationImageSetProperties: CopyDestinationImageSetProperties | undefined;
@@ -263,18 +288,22 @@ export declare class ValidationException extends __BaseException {
263
288
  */
264
289
  export interface CreateDatastoreRequest {
265
290
  /**
291
+ * @public
266
292
  * <p>The data store name.</p>
267
293
  */
268
294
  datastoreName?: string;
269
295
  /**
296
+ * @public
270
297
  * <p>A unique identifier for API idempotency.</p>
271
298
  */
272
299
  clientToken?: string;
273
300
  /**
301
+ * @public
274
302
  * <p>The tags provided when creating a data store.</p>
275
303
  */
276
304
  tags?: Record<string, string>;
277
305
  /**
306
+ * @public
278
307
  * <p>The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.</p>
279
308
  */
280
309
  kmsKeyArn?: string;
@@ -299,10 +328,12 @@ export type DatastoreStatus = (typeof DatastoreStatus)[keyof typeof DatastoreSta
299
328
  */
300
329
  export interface CreateDatastoreResponse {
301
330
  /**
331
+ * @public
302
332
  * <p>The data store identifier.</p>
303
333
  */
304
334
  datastoreId: string | undefined;
305
335
  /**
336
+ * @public
306
337
  * <p>The data store status.</p>
307
338
  */
308
339
  datastoreStatus: DatastoreStatus | string | undefined;
@@ -312,6 +343,7 @@ export interface CreateDatastoreResponse {
312
343
  */
313
344
  export interface DeleteDatastoreRequest {
314
345
  /**
346
+ * @public
315
347
  * <p>The data store identifier.</p>
316
348
  */
317
349
  datastoreId: string | undefined;
@@ -321,10 +353,12 @@ export interface DeleteDatastoreRequest {
321
353
  */
322
354
  export interface DeleteDatastoreResponse {
323
355
  /**
356
+ * @public
324
357
  * <p>The data store identifier.</p>
325
358
  */
326
359
  datastoreId: string | undefined;
327
360
  /**
361
+ * @public
328
362
  * <p>The data store status.</p>
329
363
  */
330
364
  datastoreStatus: DatastoreStatus | string | undefined;
@@ -334,6 +368,7 @@ export interface DeleteDatastoreResponse {
334
368
  */
335
369
  export interface GetDatastoreRequest {
336
370
  /**
371
+ * @public
337
372
  * <p>The data store identifier.</p>
338
373
  */
339
374
  datastoreId: string | undefined;
@@ -344,30 +379,37 @@ export interface GetDatastoreRequest {
344
379
  */
345
380
  export interface DatastoreProperties {
346
381
  /**
382
+ * @public
347
383
  * <p>The data store identifier.</p>
348
384
  */
349
385
  datastoreId: string | undefined;
350
386
  /**
387
+ * @public
351
388
  * <p>The data store name.</p>
352
389
  */
353
390
  datastoreName: string | undefined;
354
391
  /**
392
+ * @public
355
393
  * <p>The data store status.</p>
356
394
  */
357
395
  datastoreStatus: DatastoreStatus | string | undefined;
358
396
  /**
397
+ * @public
359
398
  * <p>The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.</p>
360
399
  */
361
400
  kmsKeyArn?: string;
362
401
  /**
402
+ * @public
363
403
  * <p>The Amazon Resource Name (ARN) for the data store.</p>
364
404
  */
365
405
  datastoreArn?: string;
366
406
  /**
407
+ * @public
367
408
  * <p>The timestamp when the data store was created.</p>
368
409
  */
369
410
  createdAt?: Date;
370
411
  /**
412
+ * @public
371
413
  * <p>The timestamp when the data store was last updated.</p>
372
414
  */
373
415
  updatedAt?: Date;
@@ -377,6 +419,7 @@ export interface DatastoreProperties {
377
419
  */
378
420
  export interface GetDatastoreResponse {
379
421
  /**
422
+ * @public
380
423
  * <p>The data store properties.</p>
381
424
  */
382
425
  datastoreProperties: DatastoreProperties | undefined;
@@ -386,14 +429,17 @@ export interface GetDatastoreResponse {
386
429
  */
387
430
  export interface ListDatastoresRequest {
388
431
  /**
432
+ * @public
389
433
  * <p>The data store status.</p>
390
434
  */
391
435
  datastoreStatus?: DatastoreStatus | string;
392
436
  /**
437
+ * @public
393
438
  * <p>The pagination token used to request the list of data stores on the next page.</p>
394
439
  */
395
440
  nextToken?: string;
396
441
  /**
442
+ * @public
397
443
  * <p>Valid Range: Minimum value of 1. Maximum value of 50.</p>
398
444
  */
399
445
  maxResults?: number;
@@ -404,26 +450,32 @@ export interface ListDatastoresRequest {
404
450
  */
405
451
  export interface DatastoreSummary {
406
452
  /**
453
+ * @public
407
454
  * <p>The data store identifier.</p>
408
455
  */
409
456
  datastoreId: string | undefined;
410
457
  /**
458
+ * @public
411
459
  * <p>The data store name.</p>
412
460
  */
413
461
  datastoreName: string | undefined;
414
462
  /**
463
+ * @public
415
464
  * <p>The data store status.</p>
416
465
  */
417
466
  datastoreStatus: DatastoreStatus | string | undefined;
418
467
  /**
468
+ * @public
419
469
  * <p>The Amazon Resource Name (ARN) for the data store.</p>
420
470
  */
421
471
  datastoreArn?: string;
422
472
  /**
473
+ * @public
423
474
  * <p>The timestamp when the data store was created.</p>
424
475
  */
425
476
  createdAt?: Date;
426
477
  /**
478
+ * @public
427
479
  * <p>The timestamp when the data store was last updated.</p>
428
480
  */
429
481
  updatedAt?: Date;
@@ -433,10 +485,12 @@ export interface DatastoreSummary {
433
485
  */
434
486
  export interface ListDatastoresResponse {
435
487
  /**
488
+ * @public
436
489
  * <p>The list of summaries of data stores.</p>
437
490
  */
438
491
  datastoreSummaries?: DatastoreSummary[];
439
492
  /**
493
+ * @public
440
494
  * <p>The pagination token used to retrieve the list of data stores on the next page.</p>
441
495
  */
442
496
  nextToken?: string;
@@ -446,10 +500,12 @@ export interface ListDatastoresResponse {
446
500
  */
447
501
  export interface DeleteImageSetRequest {
448
502
  /**
503
+ * @public
449
504
  * <p>The data store identifier.</p>
450
505
  */
451
506
  datastoreId: string | undefined;
452
507
  /**
508
+ * @public
453
509
  * <p>The image set identifier.</p>
454
510
  */
455
511
  imageSetId: string | undefined;
@@ -459,18 +515,22 @@ export interface DeleteImageSetRequest {
459
515
  */
460
516
  export interface DeleteImageSetResponse {
461
517
  /**
518
+ * @public
462
519
  * <p>The data store identifier.</p>
463
520
  */
464
521
  datastoreId: string | undefined;
465
522
  /**
523
+ * @public
466
524
  * <p>The image set identifier.</p>
467
525
  */
468
526
  imageSetId: string | undefined;
469
527
  /**
528
+ * @public
470
529
  * <p>The image set state.</p>
471
530
  */
472
531
  imageSetState: ImageSetState | string | undefined;
473
532
  /**
533
+ * @public
474
534
  * <p>The image set workflow status.</p>
475
535
  */
476
536
  imageSetWorkflowStatus: ImageSetWorkflowStatus | string | undefined;
@@ -480,10 +540,12 @@ export interface DeleteImageSetResponse {
480
540
  */
481
541
  export interface GetDICOMImportJobRequest {
482
542
  /**
543
+ * @public
483
544
  * <p>The data store identifier.</p>
484
545
  */
485
546
  datastoreId: string | undefined;
486
547
  /**
548
+ * @public
487
549
  * <p>The import job identifier.</p>
488
550
  */
489
551
  jobId: string | undefined;
@@ -508,42 +570,52 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
508
570
  */
509
571
  export interface DICOMImportJobProperties {
510
572
  /**
573
+ * @public
511
574
  * <p>The import job identifier.</p>
512
575
  */
513
576
  jobId: string | undefined;
514
577
  /**
578
+ * @public
515
579
  * <p>The import job name.</p>
516
580
  */
517
581
  jobName: string | undefined;
518
582
  /**
583
+ * @public
519
584
  * <p>The filters for listing import jobs based on status.</p>
520
585
  */
521
586
  jobStatus: JobStatus | string | undefined;
522
587
  /**
588
+ * @public
523
589
  * <p>The data store identifier.</p>
524
590
  */
525
591
  datastoreId: string | undefined;
526
592
  /**
593
+ * @public
527
594
  * <p>The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.</p>
528
595
  */
529
596
  dataAccessRoleArn: string | undefined;
530
597
  /**
598
+ * @public
531
599
  * <p>The timestamp for when the import job was ended.</p>
532
600
  */
533
601
  endedAt?: Date;
534
602
  /**
603
+ * @public
535
604
  * <p>The timestamp for when the import job was submitted.</p>
536
605
  */
537
606
  submittedAt?: Date;
538
607
  /**
608
+ * @public
539
609
  * <p>The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.</p>
540
610
  */
541
611
  inputS3Uri: string | undefined;
542
612
  /**
613
+ * @public
543
614
  * <p>The output prefix of the S3 bucket to upload the results of the DICOM import job.</p>
544
615
  */
545
616
  outputS3Uri: string | undefined;
546
617
  /**
618
+ * @public
547
619
  * <p>The error message thrown if an import job fails.</p>
548
620
  */
549
621
  message?: string;
@@ -553,6 +625,7 @@ export interface DICOMImportJobProperties {
553
625
  */
554
626
  export interface GetDICOMImportJobResponse {
555
627
  /**
628
+ * @public
556
629
  * <p>The properties of the import job.</p>
557
630
  */
558
631
  jobProperties: DICOMImportJobProperties | undefined;
@@ -563,6 +636,7 @@ export interface GetDICOMImportJobResponse {
563
636
  */
564
637
  export interface ImageFrameInformation {
565
638
  /**
639
+ * @public
566
640
  * <p>The image frame (pixel data) identifier.</p>
567
641
  */
568
642
  imageFrameId: string | undefined;
@@ -572,14 +646,17 @@ export interface ImageFrameInformation {
572
646
  */
573
647
  export interface GetImageFrameRequest {
574
648
  /**
649
+ * @public
575
650
  * <p>The data store identifier.</p>
576
651
  */
577
652
  datastoreId: string | undefined;
578
653
  /**
654
+ * @public
579
655
  * <p>The image set identifier.</p>
580
656
  */
581
657
  imageSetId: string | undefined;
582
658
  /**
659
+ * @public
583
660
  * <p>Information about the image frame (pixel data) identifier.</p>
584
661
  */
585
662
  imageFrameInformation: ImageFrameInformation | undefined;
@@ -589,10 +666,12 @@ export interface GetImageFrameRequest {
589
666
  */
590
667
  export interface GetImageFrameResponse {
591
668
  /**
669
+ * @public
592
670
  * <p>The blob containing the aggregated image frame information.</p>
593
671
  */
594
672
  imageFrameBlob: StreamingBlobTypes | undefined;
595
673
  /**
674
+ * @public
596
675
  * <p>The format in which the image frame information is returned to the customer. Default is
597
676
  * <code>application/octet-stream</code>.</p>
598
677
  */
@@ -603,14 +682,17 @@ export interface GetImageFrameResponse {
603
682
  */
604
683
  export interface GetImageSetRequest {
605
684
  /**
685
+ * @public
606
686
  * <p>The data store identifier.</p>
607
687
  */
608
688
  datastoreId: string | undefined;
609
689
  /**
690
+ * @public
610
691
  * <p>The image set identifier.</p>
611
692
  */
612
693
  imageSetId: string | undefined;
613
694
  /**
695
+ * @public
614
696
  * <p>The image set version identifier.</p>
615
697
  */
616
698
  versionId?: string;
@@ -620,42 +702,52 @@ export interface GetImageSetRequest {
620
702
  */
621
703
  export interface GetImageSetResponse {
622
704
  /**
705
+ * @public
623
706
  * <p>The data store identifier.</p>
624
707
  */
625
708
  datastoreId: string | undefined;
626
709
  /**
710
+ * @public
627
711
  * <p>The image set identifier.</p>
628
712
  */
629
713
  imageSetId: string | undefined;
630
714
  /**
715
+ * @public
631
716
  * <p>The image set version identifier.</p>
632
717
  */
633
718
  versionId: string | undefined;
634
719
  /**
720
+ * @public
635
721
  * <p>The image set state.</p>
636
722
  */
637
723
  imageSetState: ImageSetState | string | undefined;
638
724
  /**
725
+ * @public
639
726
  * <p>The image set workflow status.</p>
640
727
  */
641
728
  imageSetWorkflowStatus?: ImageSetWorkflowStatus | string;
642
729
  /**
730
+ * @public
643
731
  * <p>The timestamp when image set properties were created.</p>
644
732
  */
645
733
  createdAt?: Date;
646
734
  /**
735
+ * @public
647
736
  * <p>The timestamp when image set properties were updated.</p>
648
737
  */
649
738
  updatedAt?: Date;
650
739
  /**
740
+ * @public
651
741
  * <p>The timestamp when the image set properties were deleted.</p>
652
742
  */
653
743
  deletedAt?: Date;
654
744
  /**
745
+ * @public
655
746
  * <p>The error message thrown if an image set action fails.</p>
656
747
  */
657
748
  message?: string;
658
749
  /**
750
+ * @public
659
751
  * <p>The Amazon Resource Name (ARN) assigned to the image set.</p>
660
752
  */
661
753
  imageSetArn?: string;
@@ -665,14 +757,17 @@ export interface GetImageSetResponse {
665
757
  */
666
758
  export interface GetImageSetMetadataRequest {
667
759
  /**
760
+ * @public
668
761
  * <p>The data store identifier.</p>
669
762
  */
670
763
  datastoreId: string | undefined;
671
764
  /**
765
+ * @public
672
766
  * <p>The image set identifier.</p>
673
767
  */
674
768
  imageSetId: string | undefined;
675
769
  /**
770
+ * @public
676
771
  * <p>The image set version identifier.</p>
677
772
  */
678
773
  versionId?: string;
@@ -682,14 +777,17 @@ export interface GetImageSetMetadataRequest {
682
777
  */
683
778
  export interface GetImageSetMetadataResponse {
684
779
  /**
780
+ * @public
685
781
  * <p>The blob containing the aggregated metadata information for the image set.</p>
686
782
  */
687
783
  imageSetMetadataBlob: StreamingBlobTypes | undefined;
688
784
  /**
785
+ * @public
689
786
  * <p>The format in which the study metadata is returned to the customer. Default is <code>text/plain</code>.</p>
690
787
  */
691
788
  contentType?: string;
692
789
  /**
790
+ * @public
693
791
  * <p>The compression format in which image set metadata attributes are returned.</p>
694
792
  */
695
793
  contentEncoding?: string;
@@ -699,18 +797,22 @@ export interface GetImageSetMetadataResponse {
699
797
  */
700
798
  export interface ListDICOMImportJobsRequest {
701
799
  /**
800
+ * @public
702
801
  * <p>The data store identifier.</p>
703
802
  */
704
803
  datastoreId: string | undefined;
705
804
  /**
805
+ * @public
706
806
  * <p>The filters for listing import jobs based on status.</p>
707
807
  */
708
808
  jobStatus?: JobStatus | string;
709
809
  /**
810
+ * @public
710
811
  * <p>The pagination token used to request the list of import jobs on the next page.</p>
711
812
  */
712
813
  nextToken?: string;
713
814
  /**
815
+ * @public
714
816
  * <p>The max results count. The upper bound is determined by load testing.</p>
715
817
  */
716
818
  maxResults?: number;
@@ -721,34 +823,42 @@ export interface ListDICOMImportJobsRequest {
721
823
  */
722
824
  export interface DICOMImportJobSummary {
723
825
  /**
826
+ * @public
724
827
  * <p>The import job identifier.</p>
725
828
  */
726
829
  jobId: string | undefined;
727
830
  /**
831
+ * @public
728
832
  * <p>The import job name.</p>
729
833
  */
730
834
  jobName: string | undefined;
731
835
  /**
836
+ * @public
732
837
  * <p>The filters for listing import jobs based on status.</p>
733
838
  */
734
839
  jobStatus: JobStatus | string | undefined;
735
840
  /**
841
+ * @public
736
842
  * <p>The data store identifier.</p>
737
843
  */
738
844
  datastoreId: string | undefined;
739
845
  /**
846
+ * @public
740
847
  * <p>The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.</p>
741
848
  */
742
849
  dataAccessRoleArn?: string;
743
850
  /**
851
+ * @public
744
852
  * <p>The timestamp when an import job ended.</p>
745
853
  */
746
854
  endedAt?: Date;
747
855
  /**
856
+ * @public
748
857
  * <p>The timestamp when an import job was submitted.</p>
749
858
  */
750
859
  submittedAt?: Date;
751
860
  /**
861
+ * @public
752
862
  * <p>The error message thrown if an import job fails.</p>
753
863
  */
754
864
  message?: string;
@@ -758,10 +868,12 @@ export interface DICOMImportJobSummary {
758
868
  */
759
869
  export interface ListDICOMImportJobsResponse {
760
870
  /**
871
+ * @public
761
872
  * <p>A list of job summaries.</p>
762
873
  */
763
874
  jobSummaries: DICOMImportJobSummary[] | undefined;
764
875
  /**
876
+ * @public
765
877
  * <p>The pagination token used to retrieve the list of import jobs on the next page.</p>
766
878
  */
767
879
  nextToken?: string;
@@ -771,18 +883,22 @@ export interface ListDICOMImportJobsResponse {
771
883
  */
772
884
  export interface ListImageSetVersionsRequest {
773
885
  /**
886
+ * @public
774
887
  * <p>The data store identifier.</p>
775
888
  */
776
889
  datastoreId: string | undefined;
777
890
  /**
891
+ * @public
778
892
  * <p>The image set identifier.</p>
779
893
  */
780
894
  imageSetId: string | undefined;
781
895
  /**
896
+ * @public
782
897
  * <p>The pagination token used to request the list of image set versions on the next page.</p>
783
898
  */
784
899
  nextToken?: string;
785
900
  /**
901
+ * @public
786
902
  * <p>The max results count.</p>
787
903
  */
788
904
  maxResults?: number;
@@ -793,34 +909,42 @@ export interface ListImageSetVersionsRequest {
793
909
  */
794
910
  export interface ImageSetProperties {
795
911
  /**
912
+ * @public
796
913
  * <p>The image set identifier.</p>
797
914
  */
798
915
  imageSetId: string | undefined;
799
916
  /**
917
+ * @public
800
918
  * <p>The image set version identifier.</p>
801
919
  */
802
920
  versionId: string | undefined;
803
921
  /**
922
+ * @public
804
923
  * <p>The image set state.</p>
805
924
  */
806
925
  imageSetState: ImageSetState | string | undefined;
807
926
  /**
927
+ * @public
808
928
  * <p>The image set workflow status.</p>
809
929
  */
810
930
  ImageSetWorkflowStatus?: ImageSetWorkflowStatus | string;
811
931
  /**
932
+ * @public
812
933
  * <p>The timestamp when the image set properties were created.</p>
813
934
  */
814
935
  createdAt?: Date;
815
936
  /**
937
+ * @public
816
938
  * <p>The timestamp when the image set properties were updated.</p>
817
939
  */
818
940
  updatedAt?: Date;
819
941
  /**
942
+ * @public
820
943
  * <p>The timestamp when the image set properties were deleted.</p>
821
944
  */
822
945
  deletedAt?: Date;
823
946
  /**
947
+ * @public
824
948
  * <p>The error message thrown if an image set action fails.</p>
825
949
  */
826
950
  message?: string;
@@ -830,10 +954,12 @@ export interface ImageSetProperties {
830
954
  */
831
955
  export interface ListImageSetVersionsResponse {
832
956
  /**
957
+ * @public
833
958
  * <p>Lists all properties associated with an image set.</p>
834
959
  */
835
960
  imageSetPropertiesList: ImageSetProperties[] | undefined;
836
961
  /**
962
+ * @public
837
963
  * <p>The pagination token used to retrieve the list of image set versions on the next page.</p>
838
964
  */
839
965
  nextToken?: string;
@@ -843,6 +969,7 @@ export interface ListImageSetVersionsResponse {
843
969
  */
844
970
  export interface ListTagsForResourceRequest {
845
971
  /**
972
+ * @public
846
973
  * <p>The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.</p>
847
974
  */
848
975
  resourceArn: string | undefined;
@@ -852,6 +979,7 @@ export interface ListTagsForResourceRequest {
852
979
  */
853
980
  export interface ListTagsForResourceResponse {
854
981
  /**
982
+ * @public
855
983
  * <p>A list of all tags associated with a medical imaging resource.</p>
856
984
  */
857
985
  tags: Record<string, string> | undefined;
@@ -874,10 +1002,12 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
874
1002
  */
875
1003
  export interface DICOMStudyDateAndTime {
876
1004
  /**
1005
+ * @public
877
1006
  * <p>The DICOM study date provided in <code>yyMMdd</code> format.</p>
878
1007
  */
879
1008
  DICOMStudyDate: string | undefined;
880
1009
  /**
1010
+ * @public
881
1011
  * <p>The DICOM study time provided in <code>HHmmss.FFFFFF</code> format.</p>
882
1012
  */
883
1013
  DICOMStudyTime?: string;
@@ -892,6 +1022,7 @@ export type SearchByAttributeValue = SearchByAttributeValue.DICOMAccessionNumber
892
1022
  */
893
1023
  export declare namespace SearchByAttributeValue {
894
1024
  /**
1025
+ * @public
895
1026
  * <p>The patient ID input for search.</p>
896
1027
  */
897
1028
  interface DICOMPatientIdMember {
@@ -904,6 +1035,7 @@ export declare namespace SearchByAttributeValue {
904
1035
  $unknown?: never;
905
1036
  }
906
1037
  /**
1038
+ * @public
907
1039
  * <p>The DICOM accession number for search.</p>
908
1040
  */
909
1041
  interface DICOMAccessionNumberMember {
@@ -916,6 +1048,7 @@ export declare namespace SearchByAttributeValue {
916
1048
  $unknown?: never;
917
1049
  }
918
1050
  /**
1051
+ * @public
919
1052
  * <p>The DICOM study ID for search.</p>
920
1053
  */
921
1054
  interface DICOMStudyIdMember {
@@ -928,6 +1061,7 @@ export declare namespace SearchByAttributeValue {
928
1061
  $unknown?: never;
929
1062
  }
930
1063
  /**
1064
+ * @public
931
1065
  * <p>The DICOM study instance UID for search.</p>
932
1066
  */
933
1067
  interface DICOMStudyInstanceUIDMember {
@@ -940,6 +1074,7 @@ export declare namespace SearchByAttributeValue {
940
1074
  $unknown?: never;
941
1075
  }
942
1076
  /**
1077
+ * @public
943
1078
  * <p>The created at time of the image set provided for search.</p>
944
1079
  */
945
1080
  interface CreatedAtMember {
@@ -952,6 +1087,7 @@ export declare namespace SearchByAttributeValue {
952
1087
  $unknown?: never;
953
1088
  }
954
1089
  /**
1090
+ * @public
955
1091
  * <p>The aggregated structure containing DICOM study date and study time for search.</p>
956
1092
  */
957
1093
  interface DICOMStudyDateAndTimeMember {
@@ -963,6 +1099,9 @@ export declare namespace SearchByAttributeValue {
963
1099
  DICOMStudyDateAndTime: DICOMStudyDateAndTime;
964
1100
  $unknown?: never;
965
1101
  }
1102
+ /**
1103
+ * @public
1104
+ */
966
1105
  interface $UnknownMember {
967
1106
  DICOMPatientId?: never;
968
1107
  DICOMAccessionNumber?: never;
@@ -989,10 +1128,12 @@ export declare namespace SearchByAttributeValue {
989
1128
  */
990
1129
  export interface SearchFilter {
991
1130
  /**
1131
+ * @public
992
1132
  * <p>The search filter values.</p>
993
1133
  */
994
1134
  values: SearchByAttributeValue[] | undefined;
995
1135
  /**
1136
+ * @public
996
1137
  * <p>The search filter operator for <code>imageSetDateTime</code>.</p>
997
1138
  */
998
1139
  operator: Operator | string | undefined;
@@ -1003,6 +1144,7 @@ export interface SearchFilter {
1003
1144
  */
1004
1145
  export interface SearchCriteria {
1005
1146
  /**
1147
+ * @public
1006
1148
  * <p>The filters for the search criteria.</p>
1007
1149
  */
1008
1150
  filters?: SearchFilter[];
@@ -1012,18 +1154,22 @@ export interface SearchCriteria {
1012
1154
  */
1013
1155
  export interface SearchImageSetsRequest {
1014
1156
  /**
1157
+ * @public
1015
1158
  * <p>The identifier of the data store where the image sets reside.</p>
1016
1159
  */
1017
1160
  datastoreId: string | undefined;
1018
1161
  /**
1162
+ * @public
1019
1163
  * <p>The search criteria that filters by applying a maximum of 1 item to <code>SearchByAttribute</code>.</p>
1020
1164
  */
1021
1165
  searchCriteria?: SearchCriteria;
1022
1166
  /**
1167
+ * @public
1023
1168
  * <p>The maximum number of results that can be returned in a search.</p>
1024
1169
  */
1025
1170
  maxResults?: number;
1026
1171
  /**
1172
+ * @public
1027
1173
  * <p>The token used for pagination of results returned in the response. Use the token returned from the previous
1028
1174
  * request to continue results where the previous request ended.</p>
1029
1175
  */
@@ -1036,50 +1182,62 @@ export interface SearchImageSetsRequest {
1036
1182
  */
1037
1183
  export interface DICOMTags {
1038
1184
  /**
1185
+ * @public
1039
1186
  * <p>The unique identifier for a patient in a DICOM Study.</p>
1040
1187
  */
1041
1188
  DICOMPatientId?: string;
1042
1189
  /**
1190
+ * @public
1043
1191
  * <p>The patient name.</p>
1044
1192
  */
1045
1193
  DICOMPatientName?: string;
1046
1194
  /**
1195
+ * @public
1047
1196
  * <p>The patient birth date.</p>
1048
1197
  */
1049
1198
  DICOMPatientBirthDate?: string;
1050
1199
  /**
1200
+ * @public
1051
1201
  * <p>The patient sex.</p>
1052
1202
  */
1053
1203
  DICOMPatientSex?: string;
1054
1204
  /**
1205
+ * @public
1055
1206
  * <p>The DICOM provided identifier for studyInstanceUid.&gt;</p>
1056
1207
  */
1057
1208
  DICOMStudyInstanceUID?: string;
1058
1209
  /**
1210
+ * @public
1059
1211
  * <p>The DICOM provided studyId.</p>
1060
1212
  */
1061
1213
  DICOMStudyId?: string;
1062
1214
  /**
1215
+ * @public
1063
1216
  * <p>The description of the study.</p>
1064
1217
  */
1065
1218
  DICOMStudyDescription?: string;
1066
1219
  /**
1220
+ * @public
1067
1221
  * <p>The total number of series in the DICOM study.</p>
1068
1222
  */
1069
1223
  DICOMNumberOfStudyRelatedSeries?: number;
1070
1224
  /**
1225
+ * @public
1071
1226
  * <p>The total number of instances in the DICOM study.</p>
1072
1227
  */
1073
1228
  DICOMNumberOfStudyRelatedInstances?: number;
1074
1229
  /**
1230
+ * @public
1075
1231
  * <p>The accession number for the DICOM study.</p>
1076
1232
  */
1077
1233
  DICOMAccessionNumber?: string;
1078
1234
  /**
1235
+ * @public
1079
1236
  * <p>The study date.</p>
1080
1237
  */
1081
1238
  DICOMStudyDate?: string;
1082
1239
  /**
1240
+ * @public
1083
1241
  * <p>The study time.</p>
1084
1242
  */
1085
1243
  DICOMStudyTime?: string;
@@ -1090,23 +1248,28 @@ export interface DICOMTags {
1090
1248
  */
1091
1249
  export interface ImageSetsMetadataSummary {
1092
1250
  /**
1251
+ * @public
1093
1252
  * <p>The image set identifier.</p>
1094
1253
  */
1095
1254
  imageSetId: string | undefined;
1096
1255
  /**
1256
+ * @public
1097
1257
  * <p>The image set version.</p>
1098
1258
  */
1099
1259
  version?: number;
1100
1260
  /**
1261
+ * @public
1101
1262
  * <p>The time an image set is created in AWS HealthImaging. Sample creation
1102
1263
  * date is provided in <code>1985-04-12T23:20:50.52Z</code> format.</p>
1103
1264
  */
1104
1265
  createdAt?: Date;
1105
1266
  /**
1267
+ * @public
1106
1268
  * <p>The time when an image was last updated in AWS HealthImaging.</p>
1107
1269
  */
1108
1270
  updatedAt?: Date;
1109
1271
  /**
1272
+ * @public
1110
1273
  * <p>The DICOM tags associated with the image set.</p>
1111
1274
  */
1112
1275
  DICOMTags?: DICOMTags;
@@ -1116,10 +1279,12 @@ export interface ImageSetsMetadataSummary {
1116
1279
  */
1117
1280
  export interface SearchImageSetsResponse {
1118
1281
  /**
1282
+ * @public
1119
1283
  * <p>The model containing the image set results.</p>
1120
1284
  */
1121
1285
  imageSetsMetadataSummaries: ImageSetsMetadataSummary[] | undefined;
1122
1286
  /**
1287
+ * @public
1123
1288
  * <p>The token for pagination results.</p>
1124
1289
  */
1125
1290
  nextToken?: string;
@@ -1129,26 +1294,32 @@ export interface SearchImageSetsResponse {
1129
1294
  */
1130
1295
  export interface StartDICOMImportJobRequest {
1131
1296
  /**
1297
+ * @public
1132
1298
  * <p>The import job name.</p>
1133
1299
  */
1134
1300
  jobName?: string;
1135
1301
  /**
1302
+ * @public
1136
1303
  * <p>The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.</p>
1137
1304
  */
1138
1305
  dataAccessRoleArn: string | undefined;
1139
1306
  /**
1307
+ * @public
1140
1308
  * <p>A unique identifier for API idempotency.</p>
1141
1309
  */
1142
1310
  clientToken?: string;
1143
1311
  /**
1312
+ * @public
1144
1313
  * <p>The data store identifier.</p>
1145
1314
  */
1146
1315
  datastoreId: string | undefined;
1147
1316
  /**
1317
+ * @public
1148
1318
  * <p>The input prefix path for the S3 bucket that contains the DICOM files to be imported.</p>
1149
1319
  */
1150
1320
  inputS3Uri: string | undefined;
1151
1321
  /**
1322
+ * @public
1152
1323
  * <p>The output prefix of the S3 bucket to upload the results of the DICOM import job.</p>
1153
1324
  */
1154
1325
  outputS3Uri: string | undefined;
@@ -1158,18 +1329,22 @@ export interface StartDICOMImportJobRequest {
1158
1329
  */
1159
1330
  export interface StartDICOMImportJobResponse {
1160
1331
  /**
1332
+ * @public
1161
1333
  * <p>The data store identifier.</p>
1162
1334
  */
1163
1335
  datastoreId: string | undefined;
1164
1336
  /**
1337
+ * @public
1165
1338
  * <p>The import job identifier.</p>
1166
1339
  */
1167
1340
  jobId: string | undefined;
1168
1341
  /**
1342
+ * @public
1169
1343
  * <p>The import job status.</p>
1170
1344
  */
1171
1345
  jobStatus: JobStatus | string | undefined;
1172
1346
  /**
1347
+ * @public
1173
1348
  * <p>The timestamp when the import job was submitted.</p>
1174
1349
  */
1175
1350
  submittedAt: Date | undefined;
@@ -1179,10 +1354,12 @@ export interface StartDICOMImportJobResponse {
1179
1354
  */
1180
1355
  export interface TagResourceRequest {
1181
1356
  /**
1357
+ * @public
1182
1358
  * <p>The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.</p>
1183
1359
  */
1184
1360
  resourceArn: string | undefined;
1185
1361
  /**
1362
+ * @public
1186
1363
  * <p>The user-specified key and value tag pairs added to a medical imaging resource.</p>
1187
1364
  */
1188
1365
  tags: Record<string, string> | undefined;
@@ -1197,10 +1374,12 @@ export interface TagResourceResponse {
1197
1374
  */
1198
1375
  export interface UntagResourceRequest {
1199
1376
  /**
1377
+ * @public
1200
1378
  * <p>The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.</p>
1201
1379
  */
1202
1380
  resourceArn: string | undefined;
1203
1381
  /**
1382
+ * @public
1204
1383
  * <p>The keys for the tags to be removed from the medical imaging resource.</p>
1205
1384
  */
1206
1385
  tagKeys: string[] | undefined;
@@ -1216,10 +1395,12 @@ export interface UntagResourceResponse {
1216
1395
  */
1217
1396
  export interface DICOMUpdates {
1218
1397
  /**
1398
+ * @public
1219
1399
  * <p>The DICOM tags to be removed from <code>ImageSetMetadata</code>.</p>
1220
1400
  */
1221
1401
  removableAttributes?: Uint8Array;
1222
1402
  /**
1403
+ * @public
1223
1404
  * <p>The DICOM tags that need to be updated in <code>ImageSetMetadata</code>.</p>
1224
1405
  */
1225
1406
  updatableAttributes?: Uint8Array;
@@ -1234,12 +1415,16 @@ export type MetadataUpdates = MetadataUpdates.DICOMUpdatesMember | MetadataUpdat
1234
1415
  */
1235
1416
  export declare namespace MetadataUpdates {
1236
1417
  /**
1418
+ * @public
1237
1419
  * <p>The object containing <code>removableAttributes</code> and <code>updatableAttributes</code>.</p>
1238
1420
  */
1239
1421
  interface DICOMUpdatesMember {
1240
1422
  DICOMUpdates: DICOMUpdates;
1241
1423
  $unknown?: never;
1242
1424
  }
1425
+ /**
1426
+ * @public
1427
+ */
1243
1428
  interface $UnknownMember {
1244
1429
  DICOMUpdates?: never;
1245
1430
  $unknown: [string, any];
@@ -1255,18 +1440,22 @@ export declare namespace MetadataUpdates {
1255
1440
  */
1256
1441
  export interface UpdateImageSetMetadataRequest {
1257
1442
  /**
1443
+ * @public
1258
1444
  * <p>The data store identifier.</p>
1259
1445
  */
1260
1446
  datastoreId: string | undefined;
1261
1447
  /**
1448
+ * @public
1262
1449
  * <p>The image set identifier.</p>
1263
1450
  */
1264
1451
  imageSetId: string | undefined;
1265
1452
  /**
1453
+ * @public
1266
1454
  * <p>The latest image set version identifier.</p>
1267
1455
  */
1268
1456
  latestVersionId: string | undefined;
1269
1457
  /**
1458
+ * @public
1270
1459
  * <p>Update image set metadata updates.</p>
1271
1460
  */
1272
1461
  updateImageSetMetadataUpdates: MetadataUpdates | undefined;
@@ -1276,34 +1465,42 @@ export interface UpdateImageSetMetadataRequest {
1276
1465
  */
1277
1466
  export interface UpdateImageSetMetadataResponse {
1278
1467
  /**
1468
+ * @public
1279
1469
  * <p>The data store identifier.</p>
1280
1470
  */
1281
1471
  datastoreId: string | undefined;
1282
1472
  /**
1473
+ * @public
1283
1474
  * <p>The image set identifier.</p>
1284
1475
  */
1285
1476
  imageSetId: string | undefined;
1286
1477
  /**
1478
+ * @public
1287
1479
  * <p>The latest image set version identifier.</p>
1288
1480
  */
1289
1481
  latestVersionId: string | undefined;
1290
1482
  /**
1483
+ * @public
1291
1484
  * <p>The image set state.</p>
1292
1485
  */
1293
1486
  imageSetState: ImageSetState | string | undefined;
1294
1487
  /**
1488
+ * @public
1295
1489
  * <p>The image set workflow status.</p>
1296
1490
  */
1297
1491
  imageSetWorkflowStatus?: ImageSetWorkflowStatus | string;
1298
1492
  /**
1493
+ * @public
1299
1494
  * <p>The timestamp when image set metadata was created.</p>
1300
1495
  */
1301
1496
  createdAt?: Date;
1302
1497
  /**
1498
+ * @public
1303
1499
  * <p>The timestamp when image set metadata was updated.</p>
1304
1500
  */
1305
1501
  updatedAt?: Date;
1306
1502
  /**
1503
+ * @public
1307
1504
  * <p>The error message thrown if an update image set metadata action fails.</p>
1308
1505
  */
1309
1506
  message?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-medical-imaging",
3
3
  "description": "AWS SDK for JavaScript Medical Imaging Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",