aws-sdk-medicalimaging 1.0.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.
@@ -0,0 +1,1542 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::MedicalImaging
11
+ module Types
12
+
13
+ # The user does not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Updating or deleting a resource can cause an inconsistent state.
27
+ #
28
+ # @!attribute [rw] message
29
+ # @return [String]
30
+ #
31
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ConflictException AWS API Documentation
32
+ #
33
+ class ConflictException < Struct.new(
34
+ :message)
35
+ SENSITIVE = []
36
+ include Aws::Structure
37
+ end
38
+
39
+ # Copy the destination image set.
40
+ #
41
+ # @!attribute [rw] image_set_id
42
+ # The image set identifier for the destination image set.
43
+ # @return [String]
44
+ #
45
+ # @!attribute [rw] latest_version_id
46
+ # The latest version identifier for the destination image set.
47
+ # @return [String]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyDestinationImageSet AWS API Documentation
50
+ #
51
+ class CopyDestinationImageSet < Struct.new(
52
+ :image_set_id,
53
+ :latest_version_id)
54
+ SENSITIVE = []
55
+ include Aws::Structure
56
+ end
57
+
58
+ # Copy the image set properties of the destination image set.
59
+ #
60
+ # @!attribute [rw] image_set_id
61
+ # The image set identifier of the copied image set properties.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] latest_version_id
65
+ # The latest version identifier for the destination image set
66
+ # properties.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] image_set_state
70
+ # The image set state of the destination image set properties.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] image_set_workflow_status
74
+ # The image set workflow status of the destination image set
75
+ # properties.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] created_at
79
+ # The timestamp when the destination image set properties were
80
+ # created.
81
+ # @return [Time]
82
+ #
83
+ # @!attribute [rw] updated_at
84
+ # The timestamp when the destination image set properties were last
85
+ # updated.
86
+ # @return [Time]
87
+ #
88
+ # @!attribute [rw] image_set_arn
89
+ # The Amazon Resource Name (ARN) assigned to the destination image
90
+ # set.
91
+ # @return [String]
92
+ #
93
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyDestinationImageSetProperties AWS API Documentation
94
+ #
95
+ class CopyDestinationImageSetProperties < Struct.new(
96
+ :image_set_id,
97
+ :latest_version_id,
98
+ :image_set_state,
99
+ :image_set_workflow_status,
100
+ :created_at,
101
+ :updated_at,
102
+ :image_set_arn)
103
+ SENSITIVE = []
104
+ include Aws::Structure
105
+ end
106
+
107
+ # Copy image set information.
108
+ #
109
+ # @!attribute [rw] source_image_set
110
+ # The source image set.
111
+ # @return [Types::CopySourceImageSetInformation]
112
+ #
113
+ # @!attribute [rw] destination_image_set
114
+ # The destination image set.
115
+ # @return [Types::CopyDestinationImageSet]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyImageSetInformation AWS API Documentation
118
+ #
119
+ class CopyImageSetInformation < Struct.new(
120
+ :source_image_set,
121
+ :destination_image_set)
122
+ SENSITIVE = []
123
+ include Aws::Structure
124
+ end
125
+
126
+ # @!attribute [rw] datastore_id
127
+ # The data store identifier.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] source_image_set_id
131
+ # The source image set identifier.
132
+ # @return [String]
133
+ #
134
+ # @!attribute [rw] copy_image_set_information
135
+ # Copy image set information.
136
+ # @return [Types::CopyImageSetInformation]
137
+ #
138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyImageSetRequest AWS API Documentation
139
+ #
140
+ class CopyImageSetRequest < Struct.new(
141
+ :datastore_id,
142
+ :source_image_set_id,
143
+ :copy_image_set_information)
144
+ SENSITIVE = []
145
+ include Aws::Structure
146
+ end
147
+
148
+ # @!attribute [rw] datastore_id
149
+ # The data store identifier.
150
+ # @return [String]
151
+ #
152
+ # @!attribute [rw] source_image_set_properties
153
+ # The properties of the source image set.
154
+ # @return [Types::CopySourceImageSetProperties]
155
+ #
156
+ # @!attribute [rw] destination_image_set_properties
157
+ # The properties of the destination image set.
158
+ # @return [Types::CopyDestinationImageSetProperties]
159
+ #
160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyImageSetResponse AWS API Documentation
161
+ #
162
+ class CopyImageSetResponse < Struct.new(
163
+ :datastore_id,
164
+ :source_image_set_properties,
165
+ :destination_image_set_properties)
166
+ SENSITIVE = []
167
+ include Aws::Structure
168
+ end
169
+
170
+ # Copy source image set information.
171
+ #
172
+ # @!attribute [rw] latest_version_id
173
+ # The latest version identifier for the source image set.
174
+ # @return [String]
175
+ #
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopySourceImageSetInformation AWS API Documentation
177
+ #
178
+ class CopySourceImageSetInformation < Struct.new(
179
+ :latest_version_id)
180
+ SENSITIVE = []
181
+ include Aws::Structure
182
+ end
183
+
184
+ # Copy source image set properties.
185
+ #
186
+ # @!attribute [rw] image_set_id
187
+ # The image set identifier for the copied source image set.
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] latest_version_id
191
+ # The latest version identifier for the copied source image set.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] image_set_state
195
+ # The image set state of the copied source image set.
196
+ # @return [String]
197
+ #
198
+ # @!attribute [rw] image_set_workflow_status
199
+ # The workflow status of the copied source image set.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] created_at
203
+ # The timestamp when the source image set properties were created.
204
+ # @return [Time]
205
+ #
206
+ # @!attribute [rw] updated_at
207
+ # The timestamp when the source image set properties were updated.
208
+ # @return [Time]
209
+ #
210
+ # @!attribute [rw] image_set_arn
211
+ # The Amazon Resource Name (ARN) assigned to the source image set.
212
+ # @return [String]
213
+ #
214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopySourceImageSetProperties AWS API Documentation
215
+ #
216
+ class CopySourceImageSetProperties < Struct.new(
217
+ :image_set_id,
218
+ :latest_version_id,
219
+ :image_set_state,
220
+ :image_set_workflow_status,
221
+ :created_at,
222
+ :updated_at,
223
+ :image_set_arn)
224
+ SENSITIVE = []
225
+ include Aws::Structure
226
+ end
227
+
228
+ # @!attribute [rw] datastore_name
229
+ # The data store name.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] client_token
233
+ # A unique identifier for API idempotency.
234
+ #
235
+ # **A suitable default value is auto-generated.** You should normally
236
+ # not need to pass this option.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] tags
240
+ # The tags provided when creating a data store.
241
+ # @return [Hash<String,String>]
242
+ #
243
+ # @!attribute [rw] kms_key_arn
244
+ # The Amazon Resource Name (ARN) assigned to the AWS Key Management
245
+ # Service (AWS KMS) key for accessing encrypted data.
246
+ # @return [String]
247
+ #
248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CreateDatastoreRequest AWS API Documentation
249
+ #
250
+ class CreateDatastoreRequest < Struct.new(
251
+ :datastore_name,
252
+ :client_token,
253
+ :tags,
254
+ :kms_key_arn)
255
+ SENSITIVE = []
256
+ include Aws::Structure
257
+ end
258
+
259
+ # @!attribute [rw] datastore_id
260
+ # The data store identifier.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] datastore_status
264
+ # The data store status.
265
+ # @return [String]
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CreateDatastoreResponse AWS API Documentation
268
+ #
269
+ class CreateDatastoreResponse < Struct.new(
270
+ :datastore_id,
271
+ :datastore_status)
272
+ SENSITIVE = []
273
+ include Aws::Structure
274
+ end
275
+
276
+ # Properties of the import job.
277
+ #
278
+ # @!attribute [rw] job_id
279
+ # The import job identifier.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] job_name
283
+ # The import job name.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] job_status
287
+ # The filters for listing import jobs based on status.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] datastore_id
291
+ # The data store identifier.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] data_access_role_arn
295
+ # The Amazon Resource Name (ARN) that grants permissions to access
296
+ # medical imaging resources.
297
+ # @return [String]
298
+ #
299
+ # @!attribute [rw] ended_at
300
+ # The timestamp for when the import job was ended.
301
+ # @return [Time]
302
+ #
303
+ # @!attribute [rw] submitted_at
304
+ # The timestamp for when the import job was submitted.
305
+ # @return [Time]
306
+ #
307
+ # @!attribute [rw] input_s3_uri
308
+ # The input prefix path for the S3 bucket that contains the DICOM P10
309
+ # files to be imported.
310
+ # @return [String]
311
+ #
312
+ # @!attribute [rw] output_s3_uri
313
+ # The output prefix of the S3 bucket to upload the results of the
314
+ # DICOM import job.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] message
318
+ # The error message thrown if an import job fails.
319
+ # @return [String]
320
+ #
321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DICOMImportJobProperties AWS API Documentation
322
+ #
323
+ class DICOMImportJobProperties < Struct.new(
324
+ :job_id,
325
+ :job_name,
326
+ :job_status,
327
+ :datastore_id,
328
+ :data_access_role_arn,
329
+ :ended_at,
330
+ :submitted_at,
331
+ :input_s3_uri,
332
+ :output_s3_uri,
333
+ :message)
334
+ SENSITIVE = []
335
+ include Aws::Structure
336
+ end
337
+
338
+ # Summary of import job.
339
+ #
340
+ # @!attribute [rw] job_id
341
+ # The import job identifier.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] job_name
345
+ # The import job name.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] job_status
349
+ # The filters for listing import jobs based on status.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] datastore_id
353
+ # The data store identifier.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] data_access_role_arn
357
+ # The Amazon Resource Name (ARN) that grants permissions to access
358
+ # medical imaging resources.
359
+ # @return [String]
360
+ #
361
+ # @!attribute [rw] ended_at
362
+ # The timestamp when an import job ended.
363
+ # @return [Time]
364
+ #
365
+ # @!attribute [rw] submitted_at
366
+ # The timestamp when an import job was submitted.
367
+ # @return [Time]
368
+ #
369
+ # @!attribute [rw] message
370
+ # The error message thrown if an import job fails.
371
+ # @return [String]
372
+ #
373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DICOMImportJobSummary AWS API Documentation
374
+ #
375
+ class DICOMImportJobSummary < Struct.new(
376
+ :job_id,
377
+ :job_name,
378
+ :job_status,
379
+ :datastore_id,
380
+ :data_access_role_arn,
381
+ :ended_at,
382
+ :submitted_at,
383
+ :message)
384
+ SENSITIVE = []
385
+ include Aws::Structure
386
+ end
387
+
388
+ # The aggregated structure to store DICOM study date and study time for
389
+ # search capabilities.
390
+ #
391
+ # @!attribute [rw] dicom_study_date
392
+ # The DICOM study date provided in `yyMMdd` format.
393
+ # @return [String]
394
+ #
395
+ # @!attribute [rw] dicom_study_time
396
+ # The DICOM study time provided in `HHmmss.FFFFFF` format.
397
+ # @return [String]
398
+ #
399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DICOMStudyDateAndTime AWS API Documentation
400
+ #
401
+ class DICOMStudyDateAndTime < Struct.new(
402
+ :dicom_study_date,
403
+ :dicom_study_time)
404
+ SENSITIVE = [:dicom_study_date, :dicom_study_time]
405
+ include Aws::Structure
406
+ end
407
+
408
+ # The DICOM attributes returned as a part of a response. Each image set
409
+ # has these properties as part of a search result.
410
+ #
411
+ # @!attribute [rw] dicom_patient_id
412
+ # The unique identifier for a patient in a DICOM Study.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] dicom_patient_name
416
+ # The patient name.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] dicom_patient_birth_date
420
+ # The patient birth date.
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] dicom_patient_sex
424
+ # The patient sex.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] dicom_study_instance_uid
428
+ # The DICOM provided identifier for studyInstanceUid.&gt;
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] dicom_study_id
432
+ # The DICOM provided studyId.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] dicom_study_description
436
+ # The description of the study.
437
+ # @return [String]
438
+ #
439
+ # @!attribute [rw] dicom_number_of_study_related_series
440
+ # The total number of series in the DICOM study.
441
+ # @return [Integer]
442
+ #
443
+ # @!attribute [rw] dicom_number_of_study_related_instances
444
+ # The total number of instances in the DICOM study.
445
+ # @return [Integer]
446
+ #
447
+ # @!attribute [rw] dicom_accession_number
448
+ # The accession number for the DICOM study.
449
+ # @return [String]
450
+ #
451
+ # @!attribute [rw] dicom_study_date
452
+ # The study date.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] dicom_study_time
456
+ # The study time.
457
+ # @return [String]
458
+ #
459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DICOMTags AWS API Documentation
460
+ #
461
+ class DICOMTags < Struct.new(
462
+ :dicom_patient_id,
463
+ :dicom_patient_name,
464
+ :dicom_patient_birth_date,
465
+ :dicom_patient_sex,
466
+ :dicom_study_instance_uid,
467
+ :dicom_study_id,
468
+ :dicom_study_description,
469
+ :dicom_number_of_study_related_series,
470
+ :dicom_number_of_study_related_instances,
471
+ :dicom_accession_number,
472
+ :dicom_study_date,
473
+ :dicom_study_time)
474
+ SENSITIVE = [:dicom_patient_id, :dicom_patient_name, :dicom_patient_birth_date, :dicom_patient_sex, :dicom_study_instance_uid, :dicom_study_id, :dicom_study_description, :dicom_accession_number, :dicom_study_date, :dicom_study_time]
475
+ include Aws::Structure
476
+ end
477
+
478
+ # The object containing `removableAttributes` and `updatableAttributes`.
479
+ #
480
+ # @!attribute [rw] removable_attributes
481
+ # The DICOM tags to be removed from `ImageSetMetadata`.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] updatable_attributes
485
+ # The DICOM tags that need to be updated in `ImageSetMetadata`.
486
+ # @return [String]
487
+ #
488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DICOMUpdates AWS API Documentation
489
+ #
490
+ class DICOMUpdates < Struct.new(
491
+ :removable_attributes,
492
+ :updatable_attributes)
493
+ SENSITIVE = [:removable_attributes, :updatable_attributes]
494
+ include Aws::Structure
495
+ end
496
+
497
+ # The properties associated with the data store.
498
+ #
499
+ # @!attribute [rw] datastore_id
500
+ # The data store identifier.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] datastore_name
504
+ # The data store name.
505
+ # @return [String]
506
+ #
507
+ # @!attribute [rw] datastore_status
508
+ # The data store status.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] kms_key_arn
512
+ # The Amazon Resource Name (ARN) assigned to the AWS Key Management
513
+ # Service (AWS KMS) key for accessing encrypted data.
514
+ # @return [String]
515
+ #
516
+ # @!attribute [rw] datastore_arn
517
+ # The Amazon Resource Name (ARN) for the data store.
518
+ # @return [String]
519
+ #
520
+ # @!attribute [rw] created_at
521
+ # The timestamp when the data store was created.
522
+ # @return [Time]
523
+ #
524
+ # @!attribute [rw] updated_at
525
+ # The timestamp when the data store was last updated.
526
+ # @return [Time]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DatastoreProperties AWS API Documentation
529
+ #
530
+ class DatastoreProperties < Struct.new(
531
+ :datastore_id,
532
+ :datastore_name,
533
+ :datastore_status,
534
+ :kms_key_arn,
535
+ :datastore_arn,
536
+ :created_at,
537
+ :updated_at)
538
+ SENSITIVE = []
539
+ include Aws::Structure
540
+ end
541
+
542
+ # List of summaries of data stores.
543
+ #
544
+ # @!attribute [rw] datastore_id
545
+ # The data store identifier.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] datastore_name
549
+ # The data store name.
550
+ # @return [String]
551
+ #
552
+ # @!attribute [rw] datastore_status
553
+ # The data store status.
554
+ # @return [String]
555
+ #
556
+ # @!attribute [rw] datastore_arn
557
+ # The Amazon Resource Name (ARN) for the data store.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] created_at
561
+ # The timestamp when the data store was created.
562
+ # @return [Time]
563
+ #
564
+ # @!attribute [rw] updated_at
565
+ # The timestamp when the data store was last updated.
566
+ # @return [Time]
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DatastoreSummary AWS API Documentation
569
+ #
570
+ class DatastoreSummary < Struct.new(
571
+ :datastore_id,
572
+ :datastore_name,
573
+ :datastore_status,
574
+ :datastore_arn,
575
+ :created_at,
576
+ :updated_at)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # @!attribute [rw] datastore_id
582
+ # The data store identifier.
583
+ # @return [String]
584
+ #
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DeleteDatastoreRequest AWS API Documentation
586
+ #
587
+ class DeleteDatastoreRequest < Struct.new(
588
+ :datastore_id)
589
+ SENSITIVE = []
590
+ include Aws::Structure
591
+ end
592
+
593
+ # @!attribute [rw] datastore_id
594
+ # The data store identifier.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] datastore_status
598
+ # The data store status.
599
+ # @return [String]
600
+ #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DeleteDatastoreResponse AWS API Documentation
602
+ #
603
+ class DeleteDatastoreResponse < Struct.new(
604
+ :datastore_id,
605
+ :datastore_status)
606
+ SENSITIVE = []
607
+ include Aws::Structure
608
+ end
609
+
610
+ # @!attribute [rw] datastore_id
611
+ # The data store identifier.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] image_set_id
615
+ # The image set identifier.
616
+ # @return [String]
617
+ #
618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DeleteImageSetRequest AWS API Documentation
619
+ #
620
+ class DeleteImageSetRequest < Struct.new(
621
+ :datastore_id,
622
+ :image_set_id)
623
+ SENSITIVE = []
624
+ include Aws::Structure
625
+ end
626
+
627
+ # @!attribute [rw] datastore_id
628
+ # The data store identifier.
629
+ # @return [String]
630
+ #
631
+ # @!attribute [rw] image_set_id
632
+ # The image set identifier.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] image_set_state
636
+ # The image set state.
637
+ # @return [String]
638
+ #
639
+ # @!attribute [rw] image_set_workflow_status
640
+ # The image set workflow status.
641
+ # @return [String]
642
+ #
643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/DeleteImageSetResponse AWS API Documentation
644
+ #
645
+ class DeleteImageSetResponse < Struct.new(
646
+ :datastore_id,
647
+ :image_set_id,
648
+ :image_set_state,
649
+ :image_set_workflow_status)
650
+ SENSITIVE = []
651
+ include Aws::Structure
652
+ end
653
+
654
+ # @!attribute [rw] datastore_id
655
+ # The data store identifier.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] job_id
659
+ # The import job identifier.
660
+ # @return [String]
661
+ #
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetDICOMImportJobRequest AWS API Documentation
663
+ #
664
+ class GetDICOMImportJobRequest < Struct.new(
665
+ :datastore_id,
666
+ :job_id)
667
+ SENSITIVE = []
668
+ include Aws::Structure
669
+ end
670
+
671
+ # @!attribute [rw] job_properties
672
+ # The properties of the import job.
673
+ # @return [Types::DICOMImportJobProperties]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetDICOMImportJobResponse AWS API Documentation
676
+ #
677
+ class GetDICOMImportJobResponse < Struct.new(
678
+ :job_properties)
679
+ SENSITIVE = []
680
+ include Aws::Structure
681
+ end
682
+
683
+ # @!attribute [rw] datastore_id
684
+ # The data store identifier.
685
+ # @return [String]
686
+ #
687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetDatastoreRequest AWS API Documentation
688
+ #
689
+ class GetDatastoreRequest < Struct.new(
690
+ :datastore_id)
691
+ SENSITIVE = []
692
+ include Aws::Structure
693
+ end
694
+
695
+ # @!attribute [rw] datastore_properties
696
+ # The data store properties.
697
+ # @return [Types::DatastoreProperties]
698
+ #
699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetDatastoreResponse AWS API Documentation
700
+ #
701
+ class GetDatastoreResponse < Struct.new(
702
+ :datastore_properties)
703
+ SENSITIVE = []
704
+ include Aws::Structure
705
+ end
706
+
707
+ # @!attribute [rw] datastore_id
708
+ # The data store identifier.
709
+ # @return [String]
710
+ #
711
+ # @!attribute [rw] image_set_id
712
+ # The image set identifier.
713
+ # @return [String]
714
+ #
715
+ # @!attribute [rw] image_frame_information
716
+ # Information about the image frame (pixel data) identifier.
717
+ # @return [Types::ImageFrameInformation]
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageFrameRequest AWS API Documentation
720
+ #
721
+ class GetImageFrameRequest < Struct.new(
722
+ :datastore_id,
723
+ :image_set_id,
724
+ :image_frame_information)
725
+ SENSITIVE = []
726
+ include Aws::Structure
727
+ end
728
+
729
+ # @!attribute [rw] image_frame_blob
730
+ # The blob containing the aggregated image frame information.
731
+ # @return [IO]
732
+ #
733
+ # @!attribute [rw] content_type
734
+ # The format in which the image frame information is returned to the
735
+ # customer. Default is `application/octet-stream`.
736
+ # @return [String]
737
+ #
738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageFrameResponse AWS API Documentation
739
+ #
740
+ class GetImageFrameResponse < Struct.new(
741
+ :image_frame_blob,
742
+ :content_type)
743
+ SENSITIVE = []
744
+ include Aws::Structure
745
+ end
746
+
747
+ # @!attribute [rw] datastore_id
748
+ # The data store identifier.
749
+ # @return [String]
750
+ #
751
+ # @!attribute [rw] image_set_id
752
+ # The image set identifier.
753
+ # @return [String]
754
+ #
755
+ # @!attribute [rw] version_id
756
+ # The image set version identifier.
757
+ # @return [String]
758
+ #
759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSetMetadataRequest AWS API Documentation
760
+ #
761
+ class GetImageSetMetadataRequest < Struct.new(
762
+ :datastore_id,
763
+ :image_set_id,
764
+ :version_id)
765
+ SENSITIVE = []
766
+ include Aws::Structure
767
+ end
768
+
769
+ # @!attribute [rw] image_set_metadata_blob
770
+ # The blob containing the aggregated metadata information for the
771
+ # image set.
772
+ # @return [IO]
773
+ #
774
+ # @!attribute [rw] content_type
775
+ # The format in which the study metadata is returned to the customer.
776
+ # Default is `text/plain`.
777
+ # @return [String]
778
+ #
779
+ # @!attribute [rw] content_encoding
780
+ # The compression format in which image set metadata attributes are
781
+ # returned.
782
+ # @return [String]
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSetMetadataResponse AWS API Documentation
785
+ #
786
+ class GetImageSetMetadataResponse < Struct.new(
787
+ :image_set_metadata_blob,
788
+ :content_type,
789
+ :content_encoding)
790
+ SENSITIVE = []
791
+ include Aws::Structure
792
+ end
793
+
794
+ # @!attribute [rw] datastore_id
795
+ # The data store identifier.
796
+ # @return [String]
797
+ #
798
+ # @!attribute [rw] image_set_id
799
+ # The image set identifier.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] version_id
803
+ # The image set version identifier.
804
+ # @return [String]
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSetRequest AWS API Documentation
807
+ #
808
+ class GetImageSetRequest < Struct.new(
809
+ :datastore_id,
810
+ :image_set_id,
811
+ :version_id)
812
+ SENSITIVE = []
813
+ include Aws::Structure
814
+ end
815
+
816
+ # @!attribute [rw] datastore_id
817
+ # The data store identifier.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] image_set_id
821
+ # The image set identifier.
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] version_id
825
+ # The image set version identifier.
826
+ # @return [String]
827
+ #
828
+ # @!attribute [rw] image_set_state
829
+ # The image set state.
830
+ # @return [String]
831
+ #
832
+ # @!attribute [rw] image_set_workflow_status
833
+ # The image set workflow status.
834
+ # @return [String]
835
+ #
836
+ # @!attribute [rw] created_at
837
+ # The timestamp when image set properties were created.
838
+ # @return [Time]
839
+ #
840
+ # @!attribute [rw] updated_at
841
+ # The timestamp when image set properties were updated.
842
+ # @return [Time]
843
+ #
844
+ # @!attribute [rw] deleted_at
845
+ # The timestamp when the image set properties were deleted.
846
+ # @return [Time]
847
+ #
848
+ # @!attribute [rw] message
849
+ # The error message thrown if an image set action fails.
850
+ # @return [String]
851
+ #
852
+ # @!attribute [rw] image_set_arn
853
+ # The Amazon Resource Name (ARN) assigned to the image set.
854
+ # @return [String]
855
+ #
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSetResponse AWS API Documentation
857
+ #
858
+ class GetImageSetResponse < Struct.new(
859
+ :datastore_id,
860
+ :image_set_id,
861
+ :version_id,
862
+ :image_set_state,
863
+ :image_set_workflow_status,
864
+ :created_at,
865
+ :updated_at,
866
+ :deleted_at,
867
+ :message,
868
+ :image_set_arn)
869
+ SENSITIVE = []
870
+ include Aws::Structure
871
+ end
872
+
873
+ # Information about the image frame (pixel data) identifier.
874
+ #
875
+ # @!attribute [rw] image_frame_id
876
+ # The image frame (pixel data) identifier.
877
+ # @return [String]
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ImageFrameInformation AWS API Documentation
880
+ #
881
+ class ImageFrameInformation < Struct.new(
882
+ :image_frame_id)
883
+ SENSITIVE = []
884
+ include Aws::Structure
885
+ end
886
+
887
+ # The image set properties.
888
+ #
889
+ # @!attribute [rw] image_set_id
890
+ # The image set identifier.
891
+ # @return [String]
892
+ #
893
+ # @!attribute [rw] version_id
894
+ # The image set version identifier.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] image_set_state
898
+ # The image set state.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] image_set_workflow_status
902
+ # The image set workflow status.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] created_at
906
+ # The timestamp when the image set properties were created.
907
+ # @return [Time]
908
+ #
909
+ # @!attribute [rw] updated_at
910
+ # The timestamp when the image set properties were updated.
911
+ # @return [Time]
912
+ #
913
+ # @!attribute [rw] deleted_at
914
+ # The timestamp when the image set properties were deleted.
915
+ # @return [Time]
916
+ #
917
+ # @!attribute [rw] message
918
+ # The error message thrown if an image set action fails.
919
+ # @return [String]
920
+ #
921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ImageSetProperties AWS API Documentation
922
+ #
923
+ class ImageSetProperties < Struct.new(
924
+ :image_set_id,
925
+ :version_id,
926
+ :image_set_state,
927
+ :image_set_workflow_status,
928
+ :created_at,
929
+ :updated_at,
930
+ :deleted_at,
931
+ :message)
932
+ SENSITIVE = []
933
+ include Aws::Structure
934
+ end
935
+
936
+ # Summary of the image set metadata.
937
+ #
938
+ # @!attribute [rw] image_set_id
939
+ # The image set identifier.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] version
943
+ # The image set version.
944
+ # @return [Integer]
945
+ #
946
+ # @!attribute [rw] created_at
947
+ # The time an image set is created in AWS HealthImaging. Sample
948
+ # creation date is provided in `1985-04-12T23:20:50.52Z` format.
949
+ # @return [Time]
950
+ #
951
+ # @!attribute [rw] updated_at
952
+ # The time when an image was last updated in AWS HealthImaging.
953
+ # @return [Time]
954
+ #
955
+ # @!attribute [rw] dicom_tags
956
+ # The DICOM tags associated with the image set.
957
+ # @return [Types::DICOMTags]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ImageSetsMetadataSummary AWS API Documentation
960
+ #
961
+ class ImageSetsMetadataSummary < Struct.new(
962
+ :image_set_id,
963
+ :version,
964
+ :created_at,
965
+ :updated_at,
966
+ :dicom_tags)
967
+ SENSITIVE = []
968
+ include Aws::Structure
969
+ end
970
+
971
+ # An unexpected error occurred during processing of the request.
972
+ #
973
+ # @!attribute [rw] message
974
+ # @return [String]
975
+ #
976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/InternalServerException AWS API Documentation
977
+ #
978
+ class InternalServerException < Struct.new(
979
+ :message)
980
+ SENSITIVE = []
981
+ include Aws::Structure
982
+ end
983
+
984
+ # @!attribute [rw] datastore_id
985
+ # The data store identifier.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] job_status
989
+ # The filters for listing import jobs based on status.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] next_token
993
+ # The pagination token used to request the list of import jobs on the
994
+ # next page.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] max_results
998
+ # The max results count. The upper bound is determined by load
999
+ # testing.
1000
+ # @return [Integer]
1001
+ #
1002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListDICOMImportJobsRequest AWS API Documentation
1003
+ #
1004
+ class ListDICOMImportJobsRequest < Struct.new(
1005
+ :datastore_id,
1006
+ :job_status,
1007
+ :next_token,
1008
+ :max_results)
1009
+ SENSITIVE = []
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @!attribute [rw] job_summaries
1014
+ # A list of job summaries.
1015
+ # @return [Array<Types::DICOMImportJobSummary>]
1016
+ #
1017
+ # @!attribute [rw] next_token
1018
+ # The pagination token used to retrieve the list of import jobs on the
1019
+ # next page.
1020
+ # @return [String]
1021
+ #
1022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListDICOMImportJobsResponse AWS API Documentation
1023
+ #
1024
+ class ListDICOMImportJobsResponse < Struct.new(
1025
+ :job_summaries,
1026
+ :next_token)
1027
+ SENSITIVE = []
1028
+ include Aws::Structure
1029
+ end
1030
+
1031
+ # @!attribute [rw] datastore_status
1032
+ # The data store status.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] next_token
1036
+ # The pagination token used to request the list of data stores on the
1037
+ # next page.
1038
+ # @return [String]
1039
+ #
1040
+ # @!attribute [rw] max_results
1041
+ # Valid Range: Minimum value of 1. Maximum value of 50.
1042
+ # @return [Integer]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListDatastoresRequest AWS API Documentation
1045
+ #
1046
+ class ListDatastoresRequest < Struct.new(
1047
+ :datastore_status,
1048
+ :next_token,
1049
+ :max_results)
1050
+ SENSITIVE = []
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # @!attribute [rw] datastore_summaries
1055
+ # The list of summaries of data stores.
1056
+ # @return [Array<Types::DatastoreSummary>]
1057
+ #
1058
+ # @!attribute [rw] next_token
1059
+ # The pagination token used to retrieve the list of data stores on the
1060
+ # next page.
1061
+ # @return [String]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListDatastoresResponse AWS API Documentation
1064
+ #
1065
+ class ListDatastoresResponse < Struct.new(
1066
+ :datastore_summaries,
1067
+ :next_token)
1068
+ SENSITIVE = []
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # @!attribute [rw] datastore_id
1073
+ # The data store identifier.
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] image_set_id
1077
+ # The image set identifier.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] next_token
1081
+ # The pagination token used to request the list of image set versions
1082
+ # on the next page.
1083
+ # @return [String]
1084
+ #
1085
+ # @!attribute [rw] max_results
1086
+ # The max results count.
1087
+ # @return [Integer]
1088
+ #
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListImageSetVersionsRequest AWS API Documentation
1090
+ #
1091
+ class ListImageSetVersionsRequest < Struct.new(
1092
+ :datastore_id,
1093
+ :image_set_id,
1094
+ :next_token,
1095
+ :max_results)
1096
+ SENSITIVE = []
1097
+ include Aws::Structure
1098
+ end
1099
+
1100
+ # @!attribute [rw] image_set_properties_list
1101
+ # Lists all properties associated with an image set.
1102
+ # @return [Array<Types::ImageSetProperties>]
1103
+ #
1104
+ # @!attribute [rw] next_token
1105
+ # The pagination token used to retrieve the list of image set versions
1106
+ # on the next page.
1107
+ # @return [String]
1108
+ #
1109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListImageSetVersionsResponse AWS API Documentation
1110
+ #
1111
+ class ListImageSetVersionsResponse < Struct.new(
1112
+ :image_set_properties_list,
1113
+ :next_token)
1114
+ SENSITIVE = []
1115
+ include Aws::Structure
1116
+ end
1117
+
1118
+ # @!attribute [rw] resource_arn
1119
+ # The Amazon Resource Name (ARN) of the medical imaging resource to
1120
+ # list tags for.
1121
+ # @return [String]
1122
+ #
1123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListTagsForResourceRequest AWS API Documentation
1124
+ #
1125
+ class ListTagsForResourceRequest < Struct.new(
1126
+ :resource_arn)
1127
+ SENSITIVE = []
1128
+ include Aws::Structure
1129
+ end
1130
+
1131
+ # @!attribute [rw] tags
1132
+ # A list of all tags associated with a medical imaging resource.
1133
+ # @return [Hash<String,String>]
1134
+ #
1135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListTagsForResourceResponse AWS API Documentation
1136
+ #
1137
+ class ListTagsForResourceResponse < Struct.new(
1138
+ :tags)
1139
+ SENSITIVE = []
1140
+ include Aws::Structure
1141
+ end
1142
+
1143
+ # Contains DICOMUpdates.
1144
+ #
1145
+ # @note MetadataUpdates is a union - when making an API calls you must set exactly one of the members.
1146
+ #
1147
+ # @!attribute [rw] dicom_updates
1148
+ # The object containing `removableAttributes` and
1149
+ # `updatableAttributes`.
1150
+ # @return [Types::DICOMUpdates]
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/MetadataUpdates AWS API Documentation
1153
+ #
1154
+ class MetadataUpdates < Struct.new(
1155
+ :dicom_updates,
1156
+ :unknown)
1157
+ SENSITIVE = []
1158
+ include Aws::Structure
1159
+ include Aws::Structure::Union
1160
+
1161
+ class DicomUpdates < MetadataUpdates; end
1162
+ class Unknown < MetadataUpdates; end
1163
+ end
1164
+
1165
+ # The request references a resource which does not exist.
1166
+ #
1167
+ # @!attribute [rw] message
1168
+ # @return [String]
1169
+ #
1170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ResourceNotFoundException AWS API Documentation
1171
+ #
1172
+ class ResourceNotFoundException < Struct.new(
1173
+ :message)
1174
+ SENSITIVE = []
1175
+ include Aws::Structure
1176
+ end
1177
+
1178
+ # The search input attribute value.
1179
+ #
1180
+ # @note SearchByAttributeValue is a union - when making an API calls you must set exactly one of the members.
1181
+ #
1182
+ # @!attribute [rw] dicom_patient_id
1183
+ # The patient ID input for search.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] dicom_accession_number
1187
+ # The DICOM accession number for search.
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] dicom_study_id
1191
+ # The DICOM study ID for search.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] dicom_study_instance_uid
1195
+ # The DICOM study instance UID for search.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] created_at
1199
+ # The created at time of the image set provided for search.
1200
+ # @return [Time]
1201
+ #
1202
+ # @!attribute [rw] dicom_study_date_and_time
1203
+ # The aggregated structure containing DICOM study date and study time
1204
+ # for search.
1205
+ # @return [Types::DICOMStudyDateAndTime]
1206
+ #
1207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchByAttributeValue AWS API Documentation
1208
+ #
1209
+ class SearchByAttributeValue < Struct.new(
1210
+ :dicom_patient_id,
1211
+ :dicom_accession_number,
1212
+ :dicom_study_id,
1213
+ :dicom_study_instance_uid,
1214
+ :created_at,
1215
+ :dicom_study_date_and_time,
1216
+ :unknown)
1217
+ SENSITIVE = [:dicom_patient_id, :dicom_accession_number, :dicom_study_id, :dicom_study_instance_uid]
1218
+ include Aws::Structure
1219
+ include Aws::Structure::Union
1220
+
1221
+ class DicomPatientId < SearchByAttributeValue; end
1222
+ class DicomAccessionNumber < SearchByAttributeValue; end
1223
+ class DicomStudyId < SearchByAttributeValue; end
1224
+ class DicomStudyInstanceUid < SearchByAttributeValue; end
1225
+ class CreatedAt < SearchByAttributeValue; end
1226
+ class DicomStudyDateAndTime < SearchByAttributeValue; end
1227
+ class Unknown < SearchByAttributeValue; end
1228
+ end
1229
+
1230
+ # The search criteria.
1231
+ #
1232
+ # @!attribute [rw] filters
1233
+ # The filters for the search criteria.
1234
+ # @return [Array<Types::SearchFilter>]
1235
+ #
1236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchCriteria AWS API Documentation
1237
+ #
1238
+ class SearchCriteria < Struct.new(
1239
+ :filters)
1240
+ SENSITIVE = []
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # The search filter.
1245
+ #
1246
+ # @!attribute [rw] values
1247
+ # The search filter values.
1248
+ # @return [Array<Types::SearchByAttributeValue>]
1249
+ #
1250
+ # @!attribute [rw] operator
1251
+ # The search filter operator for `imageSetDateTime`.
1252
+ # @return [String]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchFilter AWS API Documentation
1255
+ #
1256
+ class SearchFilter < Struct.new(
1257
+ :values,
1258
+ :operator)
1259
+ SENSITIVE = []
1260
+ include Aws::Structure
1261
+ end
1262
+
1263
+ # @!attribute [rw] datastore_id
1264
+ # The identifier of the data store where the image sets reside.
1265
+ # @return [String]
1266
+ #
1267
+ # @!attribute [rw] search_criteria
1268
+ # The search criteria that filters by applying a maximum of 1 item to
1269
+ # `SearchByAttribute`.
1270
+ # @return [Types::SearchCriteria]
1271
+ #
1272
+ # @!attribute [rw] max_results
1273
+ # The maximum number of results that can be returned in a search.
1274
+ # @return [Integer]
1275
+ #
1276
+ # @!attribute [rw] next_token
1277
+ # The token used for pagination of results returned in the response.
1278
+ # Use the token returned from the previous request to continue results
1279
+ # where the previous request ended.
1280
+ # @return [String]
1281
+ #
1282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchImageSetsRequest AWS API Documentation
1283
+ #
1284
+ class SearchImageSetsRequest < Struct.new(
1285
+ :datastore_id,
1286
+ :search_criteria,
1287
+ :max_results,
1288
+ :next_token)
1289
+ SENSITIVE = [:search_criteria]
1290
+ include Aws::Structure
1291
+ end
1292
+
1293
+ # @!attribute [rw] image_sets_metadata_summaries
1294
+ # The model containing the image set results.
1295
+ # @return [Array<Types::ImageSetsMetadataSummary>]
1296
+ #
1297
+ # @!attribute [rw] next_token
1298
+ # The token for pagination results.
1299
+ # @return [String]
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchImageSetsResponse AWS API Documentation
1302
+ #
1303
+ class SearchImageSetsResponse < Struct.new(
1304
+ :image_sets_metadata_summaries,
1305
+ :next_token)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ end
1309
+
1310
+ # The request caused a service quota to be exceeded.
1311
+ #
1312
+ # @!attribute [rw] message
1313
+ # @return [String]
1314
+ #
1315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ServiceQuotaExceededException AWS API Documentation
1316
+ #
1317
+ class ServiceQuotaExceededException < Struct.new(
1318
+ :message)
1319
+ SENSITIVE = []
1320
+ include Aws::Structure
1321
+ end
1322
+
1323
+ # @!attribute [rw] job_name
1324
+ # The import job name.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] data_access_role_arn
1328
+ # The Amazon Resource Name (ARN) of the IAM role that grants
1329
+ # permission to access medical imaging resources.
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] client_token
1333
+ # A unique identifier for API idempotency.
1334
+ #
1335
+ # **A suitable default value is auto-generated.** You should normally
1336
+ # not need to pass this option.
1337
+ # @return [String]
1338
+ #
1339
+ # @!attribute [rw] datastore_id
1340
+ # The data store identifier.
1341
+ # @return [String]
1342
+ #
1343
+ # @!attribute [rw] input_s3_uri
1344
+ # The input prefix path for the S3 bucket that contains the DICOM
1345
+ # files to be imported.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] output_s3_uri
1349
+ # The output prefix of the S3 bucket to upload the results of the
1350
+ # DICOM import job.
1351
+ # @return [String]
1352
+ #
1353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/StartDICOMImportJobRequest AWS API Documentation
1354
+ #
1355
+ class StartDICOMImportJobRequest < Struct.new(
1356
+ :job_name,
1357
+ :data_access_role_arn,
1358
+ :client_token,
1359
+ :datastore_id,
1360
+ :input_s3_uri,
1361
+ :output_s3_uri)
1362
+ SENSITIVE = []
1363
+ include Aws::Structure
1364
+ end
1365
+
1366
+ # @!attribute [rw] datastore_id
1367
+ # The data store identifier.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] job_id
1371
+ # The import job identifier.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] job_status
1375
+ # The import job status.
1376
+ # @return [String]
1377
+ #
1378
+ # @!attribute [rw] submitted_at
1379
+ # The timestamp when the import job was submitted.
1380
+ # @return [Time]
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/StartDICOMImportJobResponse AWS API Documentation
1383
+ #
1384
+ class StartDICOMImportJobResponse < Struct.new(
1385
+ :datastore_id,
1386
+ :job_id,
1387
+ :job_status,
1388
+ :submitted_at)
1389
+ SENSITIVE = []
1390
+ include Aws::Structure
1391
+ end
1392
+
1393
+ # @!attribute [rw] resource_arn
1394
+ # The Amazon Resource Name (ARN) of the medical imaging resource that
1395
+ # tags are being added to.
1396
+ # @return [String]
1397
+ #
1398
+ # @!attribute [rw] tags
1399
+ # The user-specified key and value tag pairs added to a medical
1400
+ # imaging resource.
1401
+ # @return [Hash<String,String>]
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/TagResourceRequest AWS API Documentation
1404
+ #
1405
+ class TagResourceRequest < Struct.new(
1406
+ :resource_arn,
1407
+ :tags)
1408
+ SENSITIVE = []
1409
+ include Aws::Structure
1410
+ end
1411
+
1412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/TagResourceResponse AWS API Documentation
1413
+ #
1414
+ class TagResourceResponse < Aws::EmptyStructure; end
1415
+
1416
+ # The request was denied due to throttling.
1417
+ #
1418
+ # @!attribute [rw] message
1419
+ # @return [String]
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ThrottlingException AWS API Documentation
1422
+ #
1423
+ class ThrottlingException < Struct.new(
1424
+ :message)
1425
+ SENSITIVE = []
1426
+ include Aws::Structure
1427
+ end
1428
+
1429
+ # @!attribute [rw] resource_arn
1430
+ # The Amazon Resource Name (ARN) of the medical imaging resource that
1431
+ # tags are being removed from.
1432
+ # @return [String]
1433
+ #
1434
+ # @!attribute [rw] tag_keys
1435
+ # The keys for the tags to be removed from the medical imaging
1436
+ # resource.
1437
+ # @return [Array<String>]
1438
+ #
1439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/UntagResourceRequest AWS API Documentation
1440
+ #
1441
+ class UntagResourceRequest < Struct.new(
1442
+ :resource_arn,
1443
+ :tag_keys)
1444
+ SENSITIVE = []
1445
+ include Aws::Structure
1446
+ end
1447
+
1448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/UntagResourceResponse AWS API Documentation
1449
+ #
1450
+ class UntagResourceResponse < Aws::EmptyStructure; end
1451
+
1452
+ # @!attribute [rw] datastore_id
1453
+ # The data store identifier.
1454
+ # @return [String]
1455
+ #
1456
+ # @!attribute [rw] image_set_id
1457
+ # The image set identifier.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] latest_version_id
1461
+ # The latest image set version identifier.
1462
+ # @return [String]
1463
+ #
1464
+ # @!attribute [rw] update_image_set_metadata_updates
1465
+ # Update image set metadata updates.
1466
+ # @return [Types::MetadataUpdates]
1467
+ #
1468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/UpdateImageSetMetadataRequest AWS API Documentation
1469
+ #
1470
+ class UpdateImageSetMetadataRequest < Struct.new(
1471
+ :datastore_id,
1472
+ :image_set_id,
1473
+ :latest_version_id,
1474
+ :update_image_set_metadata_updates)
1475
+ SENSITIVE = []
1476
+ include Aws::Structure
1477
+ end
1478
+
1479
+ # @!attribute [rw] datastore_id
1480
+ # The data store identifier.
1481
+ # @return [String]
1482
+ #
1483
+ # @!attribute [rw] image_set_id
1484
+ # The image set identifier.
1485
+ # @return [String]
1486
+ #
1487
+ # @!attribute [rw] latest_version_id
1488
+ # The latest image set version identifier.
1489
+ # @return [String]
1490
+ #
1491
+ # @!attribute [rw] image_set_state
1492
+ # The image set state.
1493
+ # @return [String]
1494
+ #
1495
+ # @!attribute [rw] image_set_workflow_status
1496
+ # The image set workflow status.
1497
+ # @return [String]
1498
+ #
1499
+ # @!attribute [rw] created_at
1500
+ # The timestamp when image set metadata was created.
1501
+ # @return [Time]
1502
+ #
1503
+ # @!attribute [rw] updated_at
1504
+ # The timestamp when image set metadata was updated.
1505
+ # @return [Time]
1506
+ #
1507
+ # @!attribute [rw] message
1508
+ # The error message thrown if an update image set metadata action
1509
+ # fails.
1510
+ # @return [String]
1511
+ #
1512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/UpdateImageSetMetadataResponse AWS API Documentation
1513
+ #
1514
+ class UpdateImageSetMetadataResponse < Struct.new(
1515
+ :datastore_id,
1516
+ :image_set_id,
1517
+ :latest_version_id,
1518
+ :image_set_state,
1519
+ :image_set_workflow_status,
1520
+ :created_at,
1521
+ :updated_at,
1522
+ :message)
1523
+ SENSITIVE = []
1524
+ include Aws::Structure
1525
+ end
1526
+
1527
+ # The input fails to satisfy the constraints specified by an AWS
1528
+ # service.
1529
+ #
1530
+ # @!attribute [rw] message
1531
+ # @return [String]
1532
+ #
1533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ValidationException AWS API Documentation
1534
+ #
1535
+ class ValidationException < Struct.new(
1536
+ :message)
1537
+ SENSITIVE = []
1538
+ include Aws::Structure
1539
+ end
1540
+
1541
+ end
1542
+ end