File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (533 lines) | stat: -rw-r--r-- 12,163 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Copy the destination image set.
type CopyDestinationImageSet struct {

	// The image set identifier for the destination image set.
	//
	// This member is required.
	ImageSetId *string

	// The latest version identifier for the destination image set.
	//
	// This member is required.
	LatestVersionId *string

	noSmithyDocumentSerde
}

// Copy the image set properties of the destination image set.
type CopyDestinationImageSetProperties struct {

	// The image set identifier of the copied image set properties.
	//
	// This member is required.
	ImageSetId *string

	// The latest version identifier for the destination image set properties.
	//
	// This member is required.
	LatestVersionId *string

	// The timestamp when the destination image set properties were created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) assigned to the destination image set.
	ImageSetArn *string

	// The image set state of the destination image set properties.
	ImageSetState ImageSetState

	// The image set workflow status of the destination image set properties.
	ImageSetWorkflowStatus ImageSetWorkflowStatus

	// The timestamp when the destination image set properties were last updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// Copy image set information.
type CopyImageSetInformation struct {

	// The source image set.
	//
	// This member is required.
	SourceImageSet *CopySourceImageSetInformation

	// The destination image set.
	DestinationImageSet *CopyDestinationImageSet

	noSmithyDocumentSerde
}

// Copy source image set information.
type CopySourceImageSetInformation struct {

	// The latest version identifier for the source image set.
	//
	// This member is required.
	LatestVersionId *string

	noSmithyDocumentSerde
}

// Copy source image set properties.
type CopySourceImageSetProperties struct {

	// The image set identifier for the copied source image set.
	//
	// This member is required.
	ImageSetId *string

	// The latest version identifier for the copied source image set.
	//
	// This member is required.
	LatestVersionId *string

	// The timestamp when the source image set properties were created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) assigned to the source image set.
	ImageSetArn *string

	// The image set state of the copied source image set.
	ImageSetState ImageSetState

	// The workflow status of the copied source image set.
	ImageSetWorkflowStatus ImageSetWorkflowStatus

	// The timestamp when the source image set properties were updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// The properties associated with the data store.
type DatastoreProperties struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The data store name.
	//
	// This member is required.
	DatastoreName *string

	// The data store status.
	//
	// This member is required.
	DatastoreStatus DatastoreStatus

	// The timestamp when the data store was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) for the data store.
	DatastoreArn *string

	// The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key
	// for accessing encrypted data.
	KmsKeyArn *string

	// The timestamp when the data store was last updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// List of summaries of data stores.
type DatastoreSummary struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The data store name.
	//
	// This member is required.
	DatastoreName *string

	// The data store status.
	//
	// This member is required.
	DatastoreStatus DatastoreStatus

	// The timestamp when the data store was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) for the data store.
	DatastoreArn *string

	// The timestamp when the data store was last updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// Properties of the import job.
type DICOMImportJobProperties struct {

	// The Amazon Resource Name (ARN) that grants permissions to access medical
	// imaging resources.
	//
	// This member is required.
	DataAccessRoleArn *string

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The input prefix path for the S3 bucket that contains the DICOM P10 files to be
	// imported.
	//
	// This member is required.
	InputS3Uri *string

	// The import job identifier.
	//
	// This member is required.
	JobId *string

	// The import job name.
	//
	// This member is required.
	JobName *string

	// The filters for listing import jobs based on status.
	//
	// This member is required.
	JobStatus JobStatus

	// The output prefix of the S3 bucket to upload the results of the DICOM import
	// job.
	//
	// This member is required.
	OutputS3Uri *string

	// The timestamp for when the import job was ended.
	EndedAt *time.Time

	// The error message thrown if an import job fails.
	Message *string

	// The timestamp for when the import job was submitted.
	SubmittedAt *time.Time

	noSmithyDocumentSerde
}

// Summary of import job.
type DICOMImportJobSummary struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The import job identifier.
	//
	// This member is required.
	JobId *string

	// The import job name.
	//
	// This member is required.
	JobName *string

	// The filters for listing import jobs based on status.
	//
	// This member is required.
	JobStatus JobStatus

	// The Amazon Resource Name (ARN) that grants permissions to access medical
	// imaging resources.
	DataAccessRoleArn *string

	// The timestamp when an import job ended.
	EndedAt *time.Time

	// The error message thrown if an import job fails.
	Message *string

	// The timestamp when an import job was submitted.
	SubmittedAt *time.Time

	noSmithyDocumentSerde
}

// The aggregated structure to store DICOM study date and study time for search
// capabilities.
type DICOMStudyDateAndTime struct {

	// The DICOM study date provided in yyMMdd format.
	//
	// This member is required.
	DICOMStudyDate *string

	// The DICOM study time provided in HHmmss.FFFFFF format.
	DICOMStudyTime *string

	noSmithyDocumentSerde
}

// The DICOM attributes returned as a part of a response. Each image set has these
// properties as part of a search result.
type DICOMTags struct {

	// The accession number for the DICOM study.
	DICOMAccessionNumber *string

	// The total number of instances in the DICOM study.
	DICOMNumberOfStudyRelatedInstances int32

	// The total number of series in the DICOM study.
	DICOMNumberOfStudyRelatedSeries int32

	// The patient birth date.
	DICOMPatientBirthDate *string

	// The unique identifier for a patient in a DICOM Study.
	DICOMPatientId *string

	// The patient name.
	DICOMPatientName *string

	// The patient sex.
	DICOMPatientSex *string

	// The study date.
	DICOMStudyDate *string

	// The description of the study.
	DICOMStudyDescription *string

	// The DICOM provided studyId.
	DICOMStudyId *string

	// The DICOM provided identifier for studyInstanceUid.>
	DICOMStudyInstanceUID *string

	// The study time.
	DICOMStudyTime *string

	noSmithyDocumentSerde
}

// The object containing removableAttributes and updatableAttributes .
type DICOMUpdates struct {

	// The DICOM tags to be removed from ImageSetMetadata .
	RemovableAttributes []byte

	// The DICOM tags that need to be updated in ImageSetMetadata .
	UpdatableAttributes []byte

	noSmithyDocumentSerde
}

// Information about the image frame (pixel data) identifier.
type ImageFrameInformation struct {

	// The image frame (pixel data) identifier.
	//
	// This member is required.
	ImageFrameId *string

	noSmithyDocumentSerde
}

// The image set properties.
type ImageSetProperties struct {

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set state.
	//
	// This member is required.
	ImageSetState ImageSetState

	// The image set version identifier.
	//
	// This member is required.
	VersionId *string

	// The timestamp when the image set properties were created.
	CreatedAt *time.Time

	// The timestamp when the image set properties were deleted.
	DeletedAt *time.Time

	// The image set workflow status.
	ImageSetWorkflowStatus ImageSetWorkflowStatus

	// The error message thrown if an image set action fails.
	Message *string

	// The timestamp when the image set properties were updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// Summary of the image set metadata.
type ImageSetsMetadataSummary struct {

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The time an image set is created. Sample creation date is provided in
	// 1985-04-12T23:20:50.52Z format.
	CreatedAt *time.Time

	// The DICOM tags associated with the image set.
	DICOMTags *DICOMTags

	// The time an image set was last updated.
	UpdatedAt *time.Time

	// The image set version.
	Version *int32

	noSmithyDocumentSerde
}

// Contains DICOMUpdates.
//
// The following types satisfy this interface:
//
//	MetadataUpdatesMemberDICOMUpdates
type MetadataUpdates interface {
	isMetadataUpdates()
}

// The object containing removableAttributes and updatableAttributes .
type MetadataUpdatesMemberDICOMUpdates struct {
	Value DICOMUpdates

	noSmithyDocumentSerde
}

func (*MetadataUpdatesMemberDICOMUpdates) isMetadataUpdates() {}

// The search input attribute value.
//
// The following types satisfy this interface:
//
//	SearchByAttributeValueMemberCreatedAt
//	SearchByAttributeValueMemberDICOMAccessionNumber
//	SearchByAttributeValueMemberDICOMPatientId
//	SearchByAttributeValueMemberDICOMStudyDateAndTime
//	SearchByAttributeValueMemberDICOMStudyId
//	SearchByAttributeValueMemberDICOMStudyInstanceUID
type SearchByAttributeValue interface {
	isSearchByAttributeValue()
}

// The created at time of the image set provided for search.
type SearchByAttributeValueMemberCreatedAt struct {
	Value time.Time

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberCreatedAt) isSearchByAttributeValue() {}

// The DICOM accession number for search.
type SearchByAttributeValueMemberDICOMAccessionNumber struct {
	Value string

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberDICOMAccessionNumber) isSearchByAttributeValue() {}

// The patient ID input for search.
type SearchByAttributeValueMemberDICOMPatientId struct {
	Value string

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberDICOMPatientId) isSearchByAttributeValue() {}

// The aggregated structure containing DICOM study date and study time for search.
type SearchByAttributeValueMemberDICOMStudyDateAndTime struct {
	Value DICOMStudyDateAndTime

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberDICOMStudyDateAndTime) isSearchByAttributeValue() {}

// The DICOM study ID for search.
type SearchByAttributeValueMemberDICOMStudyId struct {
	Value string

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberDICOMStudyId) isSearchByAttributeValue() {}

// The DICOM study instance UID for search.
type SearchByAttributeValueMemberDICOMStudyInstanceUID struct {
	Value string

	noSmithyDocumentSerde
}

func (*SearchByAttributeValueMemberDICOMStudyInstanceUID) isSearchByAttributeValue() {}

// The search criteria.
type SearchCriteria struct {

	// The filters for the search criteria.
	Filters []SearchFilter

	noSmithyDocumentSerde
}

// The search filter.
type SearchFilter struct {

	// The search filter operator for imageSetDateTime .
	//
	// This member is required.
	Operator Operator

	// The search filter values.
	//
	// This member is required.
	Values []SearchByAttributeValue

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde

// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
	Tag   string
	Value []byte

	noSmithyDocumentSerde
}

func (*UnknownUnionMember) isMetadataUpdates()        {}
func (*UnknownUnionMember) isSearchByAttributeValue() {}