Skip to content

Medical Imaging Classes

BaseValidatorModel

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

CopyDestinationImageSetPropertiesTypeDef

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]

CopyDestinationImageSetTypeDef

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

CopyImageSetInformationTypeDef

sourceImageSet

  • Type:
  • Required: Yes

destinationImageSet

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.CopyDestinationImageSetTypeDef]

CopyImageSetRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

sourceImageSetId

  • Type:
  • Required: Yes

copyImageSetInformation

  • Type:
  • Required: Yes

CopyImageSetResponseTypeDef

datastoreId

  • Type:
  • Required: Yes

sourceImageSetProperties

  • Type:
  • Required: Yes

destinationImageSetProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CopySourceImageSetInformationTypeDef

latestVersionId

  • Type:
  • Required: Yes

CopySourceImageSetPropertiesTypeDef

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]

CreateDatastoreRequestRequestTypeDef

clientToken

  • Type:
  • Required: Yes

datastoreName

  • Type: typing.Optional[str]

tags

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

kmsKeyArn

  • Type: typing.Optional[str]

CreateDatastoreResponseTypeDef

datastoreId

  • Type:
  • Required: Yes

datastoreStatus

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

ResponseMetadata

  • Type:
  • Required: Yes

DICOMImportJobPropertiesTypeDef

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]

DICOMImportJobSummaryTypeDef

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]

DICOMStudyDateAndTimeTypeDef

DICOMStudyDate

  • Type:
  • Required: Yes

DICOMStudyTime

  • Type: typing.Optional[str]

DICOMTagsTypeDef

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]

DICOMUpdatesTypeDef

removableAttributes

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

updatableAttributes

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

DatastorePropertiesTypeDef

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]

DatastoreSummaryTypeDef

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]

DeleteDatastoreRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

DeleteDatastoreResponseTypeDef

datastoreId

  • Type:
  • Required: Yes

datastoreStatus

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

ResponseMetadata

  • Type:
  • Required: Yes

DeleteImageSetRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

DeleteImageSetResponseTypeDef

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

GetDICOMImportJobRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

GetDICOMImportJobResponseTypeDef

jobProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDatastoreRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

GetDatastoreResponseTypeDef

datastoreProperties

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageFrameRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

imageFrameInformation

  • Type:
  • Required: Yes

GetImageFrameResponseTypeDef

imageFrameBlob

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageSetMetadataRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type: typing.Optional[str]

GetImageSetMetadataResponseTypeDef

imageSetMetadataBlob

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

contentEncoding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImageSetRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

versionId

  • Type: typing.Optional[str]

GetImageSetResponseTypeDef

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

ResponseMetadata

  • Type:
  • Required: Yes

ImageFrameInformationTypeDef

imageFrameId

  • Type:
  • Required: Yes

ImageSetPropertiesTypeDef

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]

ImageSetsMetadataSummaryTypeDef

imageSetId

  • Type:
  • Required: Yes

version

  • Type: typing.Optional[int]

createdAt

  • Type: typing.Optional[datetime.datetime]

updatedAt

  • Type: typing.Optional[datetime.datetime]

DICOMTags

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.DICOMTagsTypeDef]

ListDICOMImportJobsRequestListDICOMImportJobsPaginateTypeDef

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_classes.PaginatorConfigTypeDef]

ListDICOMImportJobsRequestRequestTypeDef

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]

ListDICOMImportJobsResponseTypeDef

jobSummaries

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

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDatastoresRequestListDatastoresPaginateTypeDef

datastoreStatus

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

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.PaginatorConfigTypeDef]

ListDatastoresRequestRequestTypeDef

datastoreStatus

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

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDatastoresResponseTypeDef

datastoreSummaries

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

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListImageSetVersionsRequestListImageSetVersionsPaginateTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.PaginatorConfigTypeDef]

ListImageSetVersionsRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListImageSetVersionsResponseTypeDef

imageSetPropertiesList

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

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

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

ResponseMetadata

  • Type:
  • Required: Yes

MetadataUpdatesTypeDef

DICOMUpdates

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.DICOMUpdatesTypeDef]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

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]

SearchByAttributeValueTypeDef

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: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.DICOMStudyDateAndTimeTypeDef]

SearchCriteriaTypeDef

filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.medical_imaging_classes.SearchFilterTypeDef]]

sort

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.SortTypeDef]

SearchFilterTypeDef

values

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.medical_imaging_classes.SearchByAttributeValueTypeDef]
  • Required: Yes

operator

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

SearchImageSetsRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

searchCriteria

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.SearchCriteriaTypeDef]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchImageSetsRequestSearchImageSetsPaginateTypeDef

datastoreId

  • Type:
  • Required: Yes

searchCriteria

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.SearchCriteriaTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.medical_imaging_classes.PaginatorConfigTypeDef]

SearchImageSetsResponseTypeDef

imageSetsMetadataSummaries

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

sort

  • Type:
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SortTypeDef

sortOrder

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

sortField

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

StartDICOMImportJobRequestRequestTypeDef

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]

StartDICOMImportJobResponseTypeDef

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

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

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

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

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

UpdateImageSetMetadataRequestRequestTypeDef

datastoreId

  • Type:
  • Required: Yes

imageSetId

  • Type:
  • Required: Yes

latestVersionId

  • Type:
  • Required: Yes

updateImageSetMetadataUpdates

  • Type:
  • Required: Yes

UpdateImageSetMetadataResponseTypeDef

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