Skip to content

Type definitions#

Index > HealthImaging > Type definitions

Auto-generated documentation for HealthImaging type annotations stubs module mypy-boto3-medical-imaging.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

CopyDestinationImageSetPropertiesTypeDef#

# CopyDestinationImageSetPropertiesTypeDef definition

class CopyDestinationImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,
    imageSetState: NotRequired[ImageSetStateType],  # (1)
    imageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    imageSetArn: NotRequired[str],
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType

CopyDestinationImageSetTypeDef#

# CopyDestinationImageSetTypeDef definition

class CopyDestinationImageSetTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,

CopySourceImageSetInformationTypeDef#

# CopySourceImageSetInformationTypeDef definition

class CopySourceImageSetInformationTypeDef(TypedDict):
    latestVersionId: str,

CopySourceImageSetPropertiesTypeDef#

# CopySourceImageSetPropertiesTypeDef definition

class CopySourceImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    latestVersionId: str,
    imageSetState: NotRequired[ImageSetStateType],  # (1)
    imageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    imageSetArn: NotRequired[str],
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateDatastoreRequestRequestTypeDef#

# CreateDatastoreRequestRequestTypeDef definition

class CreateDatastoreRequestRequestTypeDef(TypedDict):
    clientToken: str,
    datastoreName: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    kmsKeyArn: NotRequired[str],

DICOMImportJobPropertiesTypeDef#

# DICOMImportJobPropertiesTypeDef definition

class DICOMImportJobPropertiesTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    datastoreId: str,
    dataAccessRoleArn: str,
    inputS3Uri: str,
    outputS3Uri: str,
    endedAt: NotRequired[datetime],
    submittedAt: NotRequired[datetime],
    message: NotRequired[str],
  1. See JobStatusType

DICOMImportJobSummaryTypeDef#

# DICOMImportJobSummaryTypeDef definition

class DICOMImportJobSummaryTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    datastoreId: str,
    dataAccessRoleArn: NotRequired[str],
    endedAt: NotRequired[datetime],
    submittedAt: NotRequired[datetime],
    message: NotRequired[str],
  1. See JobStatusType

DICOMStudyDateAndTimeTypeDef#

# DICOMStudyDateAndTimeTypeDef definition

class DICOMStudyDateAndTimeTypeDef(TypedDict):
    DICOMStudyDate: str,
    DICOMStudyTime: NotRequired[str],

DICOMTagsTypeDef#

# DICOMTagsTypeDef definition

class DICOMTagsTypeDef(TypedDict):
    DICOMPatientId: NotRequired[str],
    DICOMPatientName: NotRequired[str],
    DICOMPatientBirthDate: NotRequired[str],
    DICOMPatientSex: NotRequired[str],
    DICOMStudyInstanceUID: NotRequired[str],
    DICOMStudyId: NotRequired[str],
    DICOMStudyDescription: NotRequired[str],
    DICOMNumberOfStudyRelatedSeries: NotRequired[int],
    DICOMNumberOfStudyRelatedInstances: NotRequired[int],
    DICOMAccessionNumber: NotRequired[str],
    DICOMStudyDate: NotRequired[str],
    DICOMStudyTime: NotRequired[str],

DatastorePropertiesTypeDef#

# DatastorePropertiesTypeDef definition

class DatastorePropertiesTypeDef(TypedDict):
    datastoreId: str,
    datastoreName: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    kmsKeyArn: NotRequired[str],
    datastoreArn: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
  1. See DatastoreStatusType

DatastoreSummaryTypeDef#

# DatastoreSummaryTypeDef definition

class DatastoreSummaryTypeDef(TypedDict):
    datastoreId: str,
    datastoreName: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    datastoreArn: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
  1. See DatastoreStatusType

DeleteDatastoreRequestRequestTypeDef#

# DeleteDatastoreRequestRequestTypeDef definition

class DeleteDatastoreRequestRequestTypeDef(TypedDict):
    datastoreId: str,

DeleteImageSetRequestRequestTypeDef#

# DeleteImageSetRequestRequestTypeDef definition

class DeleteImageSetRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,

GetDICOMImportJobRequestRequestTypeDef#

# GetDICOMImportJobRequestRequestTypeDef definition

class GetDICOMImportJobRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    jobId: str,

GetDatastoreRequestRequestTypeDef#

# GetDatastoreRequestRequestTypeDef definition

class GetDatastoreRequestRequestTypeDef(TypedDict):
    datastoreId: str,

ImageFrameInformationTypeDef#

# ImageFrameInformationTypeDef definition

class ImageFrameInformationTypeDef(TypedDict):
    imageFrameId: str,

GetImageSetMetadataRequestRequestTypeDef#

# GetImageSetMetadataRequestRequestTypeDef definition

class GetImageSetMetadataRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: NotRequired[str],

GetImageSetRequestRequestTypeDef#

# GetImageSetRequestRequestTypeDef definition

class GetImageSetRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: NotRequired[str],

ImageSetPropertiesTypeDef#

# ImageSetPropertiesTypeDef definition

class ImageSetPropertiesTypeDef(TypedDict):
    imageSetId: str,
    versionId: str,
    imageSetState: ImageSetStateType,  # (1)
    ImageSetWorkflowStatus: NotRequired[ImageSetWorkflowStatusType],  # (2)
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    deletedAt: NotRequired[datetime],
    message: NotRequired[str],
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDICOMImportJobsRequestRequestTypeDef#

# ListDICOMImportJobsRequestRequestTypeDef definition

class ListDICOMImportJobsRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    jobStatus: NotRequired[JobStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See JobStatusType

ListDatastoresRequestRequestTypeDef#

# ListDatastoresRequestRequestTypeDef definition

class ListDatastoresRequestRequestTypeDef(TypedDict):
    datastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See DatastoreStatusType

ListImageSetVersionsRequestRequestTypeDef#

# ListImageSetVersionsRequestRequestTypeDef definition

class ListImageSetVersionsRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

StartDICOMImportJobRequestRequestTypeDef#

# StartDICOMImportJobRequestRequestTypeDef definition

class StartDICOMImportJobRequestRequestTypeDef(TypedDict):
    dataAccessRoleArn: str,
    clientToken: str,
    datastoreId: str,
    inputS3Uri: str,
    outputS3Uri: str,
    jobName: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

DICOMUpdatesTypeDef#

# DICOMUpdatesTypeDef definition

class DICOMUpdatesTypeDef(TypedDict):
    removableAttributes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    updatableAttributes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

CopyImageSetInformationTypeDef#

# CopyImageSetInformationTypeDef definition

class CopyImageSetInformationTypeDef(TypedDict):
    sourceImageSet: CopySourceImageSetInformationTypeDef,  # (1)
    destinationImageSet: NotRequired[CopyDestinationImageSetTypeDef],  # (2)
  1. See CopySourceImageSetInformationTypeDef
  2. See CopyDestinationImageSetTypeDef

CopyImageSetResponseTypeDef#

# CopyImageSetResponseTypeDef definition

class CopyImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    sourceImageSetProperties: CopySourceImageSetPropertiesTypeDef,  # (1)
    destinationImageSetProperties: CopyDestinationImageSetPropertiesTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CopySourceImageSetPropertiesTypeDef
  2. See CopyDestinationImageSetPropertiesTypeDef
  3. See ResponseMetadataTypeDef

CreateDatastoreResponseTypeDef#

# CreateDatastoreResponseTypeDef definition

class CreateDatastoreResponseTypeDef(TypedDict):
    datastoreId: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteDatastoreResponseTypeDef#

# DeleteDatastoreResponseTypeDef definition

class DeleteDatastoreResponseTypeDef(TypedDict):
    datastoreId: str,
    datastoreStatus: DatastoreStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreStatusType
  2. See ResponseMetadataTypeDef

DeleteImageSetResponseTypeDef#

# DeleteImageSetResponseTypeDef definition

class DeleteImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See ResponseMetadataTypeDef

GetImageFrameResponseTypeDef#

# GetImageFrameResponseTypeDef definition

class GetImageFrameResponseTypeDef(TypedDict):
    imageFrameBlob: StreamingBody,
    contentType: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetImageSetMetadataResponseTypeDef#

# GetImageSetMetadataResponseTypeDef definition

class GetImageSetMetadataResponseTypeDef(TypedDict):
    imageSetMetadataBlob: StreamingBody,
    contentType: str,
    contentEncoding: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetImageSetResponseTypeDef#

# GetImageSetResponseTypeDef definition

class GetImageSetResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    versionId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    createdAt: datetime,
    updatedAt: datetime,
    deletedAt: datetime,
    message: str,
    imageSetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDICOMImportJobResponseTypeDef#

# StartDICOMImportJobResponseTypeDef definition

class StartDICOMImportJobResponseTypeDef(TypedDict):
    datastoreId: str,
    jobId: str,
    jobStatus: JobStatusType,  # (1)
    submittedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

UpdateImageSetMetadataResponseTypeDef#

# UpdateImageSetMetadataResponseTypeDef definition

class UpdateImageSetMetadataResponseTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    latestVersionId: str,
    imageSetState: ImageSetStateType,  # (1)
    imageSetWorkflowStatus: ImageSetWorkflowStatusType,  # (2)
    createdAt: datetime,
    updatedAt: datetime,
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ImageSetStateType
  2. See ImageSetWorkflowStatusType
  3. See ResponseMetadataTypeDef

GetDICOMImportJobResponseTypeDef#

# GetDICOMImportJobResponseTypeDef definition

class GetDICOMImportJobResponseTypeDef(TypedDict):
    jobProperties: DICOMImportJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DICOMImportJobPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListDICOMImportJobsResponseTypeDef#

# ListDICOMImportJobsResponseTypeDef definition

class ListDICOMImportJobsResponseTypeDef(TypedDict):
    jobSummaries: List[DICOMImportJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DICOMImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ImageSetsMetadataSummaryTypeDef#

# ImageSetsMetadataSummaryTypeDef definition

class ImageSetsMetadataSummaryTypeDef(TypedDict):
    imageSetId: str,
    version: NotRequired[int],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    DICOMTags: NotRequired[DICOMTagsTypeDef],  # (1)
  1. See DICOMTagsTypeDef

GetDatastoreResponseTypeDef#

# GetDatastoreResponseTypeDef definition

class GetDatastoreResponseTypeDef(TypedDict):
    datastoreProperties: DatastorePropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastorePropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListDatastoresResponseTypeDef#

# ListDatastoresResponseTypeDef definition

class ListDatastoresResponseTypeDef(TypedDict):
    datastoreSummaries: List[DatastoreSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatastoreSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetImageFrameRequestRequestTypeDef#

# GetImageFrameRequestRequestTypeDef definition

class GetImageFrameRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    imageFrameInformation: ImageFrameInformationTypeDef,  # (1)
  1. See ImageFrameInformationTypeDef

ListImageSetVersionsResponseTypeDef#

# ListImageSetVersionsResponseTypeDef definition

class ListImageSetVersionsResponseTypeDef(TypedDict):
    imageSetPropertiesList: List[ImageSetPropertiesTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageSetPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListDICOMImportJobsRequestListDICOMImportJobsPaginateTypeDef#

# ListDICOMImportJobsRequestListDICOMImportJobsPaginateTypeDef definition

class ListDICOMImportJobsRequestListDICOMImportJobsPaginateTypeDef(TypedDict):
    datastoreId: str,
    jobStatus: NotRequired[JobStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See JobStatusType
  2. See PaginatorConfigTypeDef

ListDatastoresRequestListDatastoresPaginateTypeDef#

# ListDatastoresRequestListDatastoresPaginateTypeDef definition

class ListDatastoresRequestListDatastoresPaginateTypeDef(TypedDict):
    datastoreStatus: NotRequired[DatastoreStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DatastoreStatusType
  2. See PaginatorConfigTypeDef

ListImageSetVersionsRequestListImageSetVersionsPaginateTypeDef#

# ListImageSetVersionsRequestListImageSetVersionsPaginateTypeDef definition

class ListImageSetVersionsRequestListImageSetVersionsPaginateTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

SearchByAttributeValueTypeDef#

# SearchByAttributeValueTypeDef definition

class SearchByAttributeValueTypeDef(TypedDict):
    DICOMPatientId: NotRequired[str],
    DICOMAccessionNumber: NotRequired[str],
    DICOMStudyId: NotRequired[str],
    DICOMStudyInstanceUID: NotRequired[str],
    createdAt: NotRequired[Union[datetime, str]],
    DICOMStudyDateAndTime: NotRequired[DICOMStudyDateAndTimeTypeDef],  # (1)
  1. See DICOMStudyDateAndTimeTypeDef

MetadataUpdatesTypeDef#

# MetadataUpdatesTypeDef definition

class MetadataUpdatesTypeDef(TypedDict):
    DICOMUpdates: NotRequired[DICOMUpdatesTypeDef],  # (1)
  1. See DICOMUpdatesTypeDef

CopyImageSetRequestRequestTypeDef#

# CopyImageSetRequestRequestTypeDef definition

class CopyImageSetRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    sourceImageSetId: str,
    copyImageSetInformation: CopyImageSetInformationTypeDef,  # (1)
  1. See CopyImageSetInformationTypeDef

SearchImageSetsResponseTypeDef#

# SearchImageSetsResponseTypeDef definition

class SearchImageSetsResponseTypeDef(TypedDict):
    imageSetsMetadataSummaries: List[ImageSetsMetadataSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageSetsMetadataSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchFilterTypeDef#

# SearchFilterTypeDef definition

class SearchFilterTypeDef(TypedDict):
    values: Sequence[SearchByAttributeValueTypeDef],  # (1)
    operator: OperatorType,  # (2)
  1. See SearchByAttributeValueTypeDef
  2. See OperatorType

UpdateImageSetMetadataRequestRequestTypeDef#

# UpdateImageSetMetadataRequestRequestTypeDef definition

class UpdateImageSetMetadataRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    imageSetId: str,
    latestVersionId: str,
    updateImageSetMetadataUpdates: MetadataUpdatesTypeDef,  # (1)
  1. See MetadataUpdatesTypeDef

SearchCriteriaTypeDef#

# SearchCriteriaTypeDef definition

class SearchCriteriaTypeDef(TypedDict):
    filters: NotRequired[Sequence[SearchFilterTypeDef]],  # (1)
  1. See SearchFilterTypeDef

SearchImageSetsRequestRequestTypeDef#

# SearchImageSetsRequestRequestTypeDef definition

class SearchImageSetsRequestRequestTypeDef(TypedDict):
    datastoreId: str,
    searchCriteria: NotRequired[SearchCriteriaTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchCriteriaTypeDef

SearchImageSetsRequestSearchImageSetsPaginateTypeDef#

# SearchImageSetsRequestSearchImageSetsPaginateTypeDef definition

class SearchImageSetsRequestSearchImageSetsPaginateTypeDef(TypedDict):
    datastoreId: str,
    searchCriteria: NotRequired[SearchCriteriaTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchCriteriaTypeDef
  2. See PaginatorConfigTypeDef