medicalimaging/aws.sdk.kotlin.services.medicalimaging/MedicalImagingClient

MedicalImagingClient

interface MedicalImagingClient : SdkClient

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For an introduction to the service, see the AWS HealthImaging Developer Guide.

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

Data store actions

CreateDatastore – See Creating a data store.
GetDatastore – See Getting data store properties.
ListDatastores – See Listing data stores.
DeleteDatastore – See Deleting a data store.

Import job actions

StartDICOMImportJob – See Starting an import job.
GetDICOMImportJob – See Getting import job properties.
ListDICOMImportJobs – See Listing import jobs.

Image set access actions

SearchImageSets – See Searching image sets.
GetImageSet – See Getting image set properties.
GetImageSetMetadata – See Getting image set metadata.
GetImageFrame – See Getting image set pixel data.

Image set modification actions

ListImageSetVersions – See Listing image set versions.
UpdateImageSetMetadata – See Updating image set metadata.
CopyImageSet – See Copying an image set.
DeleteImageSet – See Deleting an image set.

Tagging actions

TagResource – See Tagging a data store and Tagging an image set.
ListTagsForResource – See Tagging a data store and Tagging an image set.
UntagResource – See Tagging a data store and Tagging an image set.

Types

Builder

class Builder : AbstractSdkClientBuilder<MedicalImagingClient.Config, MedicalImagingClient.Config.Builder, MedicalImagingClient>

Companion

object Companion : AbstractAwsSdkClientFactory<MedicalImagingClient.Config, MedicalImagingClient.Config.Builder, MedicalImagingClient, MedicalImagingClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: MedicalImagingClient.Config

MedicalImagingClient's configuration

Functions

copyImageSet

abstract suspend fun copyImageSet(input: CopyImageSetRequest): CopyImageSetResponse

Copy an image set.

createDatastore

abstract suspend fun createDatastore(input: CreateDatastoreRequest): CreateDatastoreResponse

Create a data store.

deleteDatastore

abstract suspend fun deleteDatastore(input: DeleteDatastoreRequest): DeleteDatastoreResponse

Delete a data store.

deleteImageSet

abstract suspend fun deleteImageSet(input: DeleteImageSetRequest): DeleteImageSetResponse

Delete an image set.

getDatastore

abstract suspend fun getDatastore(input: GetDatastoreRequest): GetDatastoreResponse

Get data store properties.

getDicomImportJob

abstract suspend fun getDicomImportJob(input: GetDicomImportJobRequest): GetDicomImportJobResponse

Get the import job properties to learn more about the job or job progress.

getImageFrame

abstract suspend fun <T> getImageFrame(input: GetImageFrameRequest, block: suspend (GetImageFrameResponse) -> T): T

Get an image frame (pixel data) for an image set.

getImageSet

abstract suspend fun getImageSet(input: GetImageSetRequest): GetImageSetResponse

Get image set properties.

getImageSetMetadata

abstract suspend fun <T> getImageSetMetadata(input: GetImageSetMetadataRequest, block: suspend (GetImageSetMetadataResponse) -> T): T

Get metadata attributes for an image set.

listDatastores

abstract suspend fun listDatastores(input: ListDatastoresRequest = ListDatastoresRequest { }): ListDatastoresResponse

List data stores.

listDicomImportJobs

abstract suspend fun listDicomImportJobs(input: ListDicomImportJobsRequest): ListDicomImportJobsResponse

List import jobs created for a specific data store.

listImageSetVersions

abstract suspend fun listImageSetVersions(input: ListImageSetVersionsRequest): ListImageSetVersionsResponse

List image set versions.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all tags associated with a medical imaging resource.

searchImageSets

abstract suspend fun searchImageSets(input: SearchImageSetsRequest): SearchImageSetsResponse

Search image sets based on defined input attributes.

startDicomImportJob

abstract suspend fun startDicomImportJob(input: StartDicomImportJobRequest): StartDicomImportJobResponse

Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a user-specifed key and value tag to a medical imaging resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from a medical imaging resource.

updateImageSetMetadata

abstract suspend fun updateImageSetMetadata(input: UpdateImageSetMetadataRequest): UpdateImageSetMetadataResponse

Update image set metadata attributes.

Inherited functions

expect abstract fun close()

copyImageSet

inline suspend fun MedicalImagingClient.copyImageSet(crossinline block: CopyImageSetRequest.Builder.() -> Unit): CopyImageSetResponse

Copy an image set.

createDatastore

inline suspend fun MedicalImagingClient.createDatastore(crossinline block: CreateDatastoreRequest.Builder.() -> Unit): CreateDatastoreResponse

Create a data store.

deleteDatastore

inline suspend fun MedicalImagingClient.deleteDatastore(crossinline block: DeleteDatastoreRequest.Builder.() -> Unit): DeleteDatastoreResponse

Delete a data store.

deleteImageSet

inline suspend fun MedicalImagingClient.deleteImageSet(crossinline block: DeleteImageSetRequest.Builder.() -> Unit): DeleteImageSetResponse

Delete an image set.

getDatastore

inline suspend fun MedicalImagingClient.getDatastore(crossinline block: GetDatastoreRequest.Builder.() -> Unit): GetDatastoreResponse

Get data store properties.

getDicomImportJob

inline suspend fun MedicalImagingClient.getDicomImportJob(crossinline block: GetDicomImportJobRequest.Builder.() -> Unit): GetDicomImportJobResponse

Get the import job properties to learn more about the job or job progress.

getImageSet

inline suspend fun MedicalImagingClient.getImageSet(crossinline block: GetImageSetRequest.Builder.() -> Unit): GetImageSetResponse

Get image set properties.

listDatastores

inline suspend fun MedicalImagingClient.listDatastores(crossinline block: ListDatastoresRequest.Builder.() -> Unit): ListDatastoresResponse

List data stores.

listDicomImportJobs

inline suspend fun MedicalImagingClient.listDicomImportJobs(crossinline block: ListDicomImportJobsRequest.Builder.() -> Unit): ListDicomImportJobsResponse

List import jobs created for a specific data store.

listDicomImportJobsPaginated

fun MedicalImagingClient.listDicomImportJobsPaginated(initialRequest: ListDicomImportJobsRequest): Flow<ListDicomImportJobsResponse>

fun MedicalImagingClient.listDicomImportJobsPaginated(block: ListDicomImportJobsRequest.Builder.() -> Unit): Flow<ListDicomImportJobsResponse>

Paginate over ListDicomImportJobsResponse results.

listImageSetVersions

inline suspend fun MedicalImagingClient.listImageSetVersions(crossinline block: ListImageSetVersionsRequest.Builder.() -> Unit): ListImageSetVersionsResponse

List image set versions.

listImageSetVersionsPaginated

fun MedicalImagingClient.listImageSetVersionsPaginated(initialRequest: ListImageSetVersionsRequest): Flow<ListImageSetVersionsResponse>

fun MedicalImagingClient.listImageSetVersionsPaginated(block: ListImageSetVersionsRequest.Builder.() -> Unit): Flow<ListImageSetVersionsResponse>

Paginate over ListImageSetVersionsResponse results.

listTagsForResource

inline suspend fun MedicalImagingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags associated with a medical imaging resource.

searchImageSets

inline suspend fun MedicalImagingClient.searchImageSets(crossinline block: SearchImageSetsRequest.Builder.() -> Unit): SearchImageSetsResponse

Search image sets based on defined input attributes.

searchImageSetsPaginated

fun MedicalImagingClient.searchImageSetsPaginated(initialRequest: SearchImageSetsRequest): Flow<SearchImageSetsResponse>

fun MedicalImagingClient.searchImageSetsPaginated(block: SearchImageSetsRequest.Builder.() -> Unit): Flow<SearchImageSetsResponse>

Paginate over SearchImageSetsResponse results.

startDicomImportJob

inline suspend fun MedicalImagingClient.startDicomImportJob(crossinline block: StartDicomImportJobRequest.Builder.() -> Unit): StartDicomImportJobResponse

tagResource

inline suspend fun MedicalImagingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds a user-specifed key and value tag to a medical imaging resource.

untagResource

inline suspend fun MedicalImagingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a medical imaging resource.

updateImageSetMetadata

inline suspend fun MedicalImagingClient.updateImageSetMetadata(crossinline block: UpdateImageSetMetadataRequest.Builder.() -> Unit): UpdateImageSetMetadataResponse

Update image set metadata attributes.

withConfig

fun MedicalImagingClient.withConfig(block: MedicalImagingClient.Config.Builder.() -> Unit): MedicalImagingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.