Skip to content

Medical Imaging Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CopyDestinationImageSet

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

CopyDestinationImageSetProperties

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DELETED', 'LOCKED']]

imageSetWorkflowStatus

  • Type: typing.Optional[typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

imageSetArn

  • Type: typing.Optional[str]

CopyImageSetInformation

sourceImageSet

  • Type:
  • Required: Yes

destinationImageSet

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.CopyDestinationImageSet]

CopyImageSetRequest

datastoreId

  • Type:
  • Required: Yes

sourceImageSetId

  • Type:
  • Required: Yes

copyImageSetInformation

  • Type:
  • Required: Yes

force

  • Type: typing.Optional[bool]

CopyImageSetResponse

datastoreId

  • Type:
  • Required: Yes

sourceImageSetProperties

  • Type:
  • Required: Yes

destinationImageSetProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CopySourceImageSetInformation

latestVersionId

  • Type:
  • Required: Yes

DICOMCopies

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.MetadataCopies]

CopySourceImageSetProperties

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DELETED', 'LOCKED']]

imageSetWorkflowStatus

  • Type: typing.Optional[typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

imageSetArn

  • Type: typing.Optional[str]

CreateDatastoreRequest

clientToken

  • Type:
  • Required: Yes

datastoreName

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

kmsKeyArn

  • Type: typing.Optional[str]

CreateDatastoreResponse

datastoreId

  • Type:
  • Required: Yes

datastoreStatus

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DICOMImportJobProperties

jobId

  • Type:
  • Required: Yes

jobName

  • Type:
  • Required: Yes

jobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'SUBMITTED']
  • Required: Yes

datastoreId

  • Type:
  • Required: Yes

dataAccessRoleArn

  • Type:
  • Required: Yes

inputS3Uri

  • Type:
  • Required: Yes

outputS3Uri

  • Type:
  • Required: Yes

endedAt

  • Type: typing.Optional[datetime.datetime]

submittedAt

  • Type: typing.Optional[datetime.datetime]

message

  • Type: typing.Optional[str]

DICOMImportJobSummary

jobId

  • Type:
  • Required: Yes

jobName

  • Type:
  • Required: Yes

jobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'SUBMITTED']
  • Required: Yes

datastoreId

  • Type:
  • Required: Yes

dataAccessRoleArn

  • Type: typing.Optional[str]

endedAt

  • Type: typing.Optional[datetime.datetime]

submittedAt

  • Type: typing.Optional[datetime.datetime]

message

  • Type: typing.Optional[str]

DICOMStudyDateAndTime

DICOMStudyDate

  • Type:
  • Required: Yes

DICOMStudyTime

  • Type: typing.Optional[str]

DICOMTags

DICOMPatientId

  • Type: typing.Optional[str]

DICOMPatientName

  • Type: typing.Optional[str]

DICOMPatientBirthDate

  • Type: typing.Optional[str]

DICOMPatientSex

  • Type: typing.Optional[str]

DICOMStudyInstanceUID

  • Type: typing.Optional[str]

DICOMStudyId

  • Type: typing.Optional[str]

DICOMStudyDescription

  • Type: typing.Optional[str]

DICOMNumberOfStudyRelatedSeries

  • Type: typing.Optional[int]

DICOMNumberOfStudyRelatedInstances

  • Type: typing.Optional[int]

DICOMAccessionNumber

  • Type: typing.Optional[str]

DICOMSeriesInstanceUID

  • Type: typing.Optional[str]

DICOMSeriesModality

  • Type: typing.Optional[str]

DICOMSeriesBodyPart

  • Type: typing.Optional[str]

DICOMSeriesNumber

  • Type: typing.Optional[int]

DICOMStudyDate

  • Type: typing.Optional[str]

DICOMStudyTime

  • Type: typing.Optional[str]

DICOMUpdates

removableAttributes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

updatableAttributes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

DatastoreProperties

datastoreId

  • Type:
  • Required: Yes

datastoreName

  • Type:
  • Required: Yes

datastoreStatus

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

kmsKeyArn

  • Type: typing.Optional[str]

datastoreArn

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DatastoreSummary

datastoreId

  • Type:
  • Required: Yes

datastoreName

  • Type:
  • Required: Yes

datastoreStatus

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

datastoreArn

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DeleteDatastoreRequest

datastoreId

  • Type:
  • Required: Yes

DeleteDatastoreResponse

datastoreId

  • Type:
  • Required: Yes

datastoreStatus

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteImageSetRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

DeleteImageSetResponse

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Literal['ACTIVE', 'DELETED', 'LOCKED']
  • Required: Yes

imageSetWorkflowStatus

  • Type: typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDICOMImportJobRequest

datastoreId

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

GetDICOMImportJobResponse

jobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDatastoreRequest

datastoreId

  • Type:
  • Required: Yes

GetDatastoreResponse

datastoreProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageFrameRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

imageFrameInformation

  • Type:
  • Required: Yes

GetImageFrameResponse

imageFrameBlob

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageSetMetadataRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type: typing.Optional[str]

GetImageSetMetadataResponse

imageSetMetadataBlob

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

contentEncoding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageSetRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type: typing.Optional[str]

GetImageSetResponse

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Literal['ACTIVE', 'DELETED', 'LOCKED']
  • Required: Yes

imageSetWorkflowStatus

  • Type: typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

deletedAt

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

imageSetArn

  • Type:
  • Required: Yes

overrides

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImageFrameInformation

imageFrameId

  • Type:
  • Required: Yes

ImageSetProperties

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Literal['ACTIVE', 'DELETED', 'LOCKED']
  • Required: Yes

ImageSetWorkflowStatus

  • Type: typing.Optional[typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

deletedAt

  • Type: typing.Optional[datetime.datetime]

message

  • Type: typing.Optional[str]

overrides

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.Overrides]

ImageSetsMetadataSummary

imageSetId

  • Type:
  • Required: Yes

version

  • Type: typing.Optional[int]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DICOMTags

  • Type:

ListDICOMImportJobsRequest

datastoreId

  • Type:
  • Required: Yes

jobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'SUBMITTED']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDICOMImportJobsRequestPaginate

datastoreId

  • Type:
  • Required: Yes

jobStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'SUBMITTED']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.PaginatorConfig]

ListDICOMImportJobsResponse

jobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.DICOMImportJobSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDatastoresRequest

datastoreStatus

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDatastoresRequestPaginate

datastoreStatus

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETING']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.PaginatorConfig]

ListDatastoresResponse

datastoreSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.DatastoreSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListImageSetVersionsRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListImageSetVersionsRequestPaginate

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.PaginatorConfig]

ListImageSetVersionsResponse

imageSetPropertiesList

  • Type: typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.ImageSetProperties]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MetadataCopies

copiableAttributes

  • Type:
  • Required: Yes

MetadataUpdates

DICOMUpdates

  • Type:

revertToVersionId

  • Type: typing.Optional[str]

Overrides

forced

  • Type: typing.Optional[bool]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SearchByAttributeValue

DICOMPatientId

  • Type: typing.Optional[str]

DICOMAccessionNumber

  • Type: typing.Optional[str]

DICOMStudyId

  • Type: typing.Optional[str]

DICOMStudyInstanceUID

  • Type: typing.Optional[str]

DICOMSeriesInstanceUID

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Union[datetime.datetime, str, NoneType]

updatedAt

  • Type: typing.Union[datetime.datetime, str, NoneType]

DICOMStudyDateAndTime

  • Type:

SearchCriteria

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.SearchFilter]]

sort

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.Sort]

SearchFilter

values

  • Type: typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.SearchByAttributeValue]
  • Required: Yes

operator

  • Type: typing.Literal['BETWEEN', 'EQUAL']
  • Required: Yes

SearchImageSetsRequest

datastoreId

  • Type:
  • Required: Yes

searchCriteria

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.SearchCriteria]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchImageSetsRequestPaginate

datastoreId

  • Type:
  • Required: Yes

searchCriteria

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.SearchCriteria]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.PaginatorConfig]

SearchImageSetsResponse

imageSetsMetadataSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.medical_imaging.medical_imaging_classes.ImageSetsMetadataSummary]
  • Required: Yes

sort

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

Sort

sortOrder

  • Type: typing.Literal['ASC', 'DESC']
  • Required: Yes

sortField

  • Type: typing.Literal['DICOMStudyDateAndTime', 'createdAt', 'updatedAt']
  • Required: Yes

StartDICOMImportJobRequest

dataAccessRoleArn

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

datastoreId

  • Type:
  • Required: Yes

inputS3Uri

  • Type:
  • Required: Yes

outputS3Uri

  • Type:
  • Required: Yes

jobName

  • Type: typing.Optional[str]

inputOwnerAccountId

  • Type: typing.Optional[str]

StartDICOMImportJobResponse

datastoreId

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

jobStatus

  • Type: typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'SUBMITTED']
  • Required: Yes

submittedAt

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateImageSetMetadataRequest

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

updateImageSetMetadataUpdates

  • Type:
  • Required: Yes

force

  • Type: typing.Optional[bool]

UpdateImageSetMetadataResponse

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

imageSetState

  • Type: typing.Literal['ACTIVE', 'DELETED', 'LOCKED']
  • Required: Yes

imageSetWorkflowStatus

  • Type: typing.Literal['COPIED', 'COPYING', 'COPYING_WITH_READ_ONLY_ACCESS', 'COPY_FAILED', 'CREATED', 'DELETED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

createdAt

  • Type:
  • Required: Yes

updatedAt

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes