@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMedicalImagingAsyncClient extends AWSMedicalImagingClient implements AWSMedicalImagingAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. 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.
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 tested code examples.
Data store actions
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying an image set.
Tagging actions
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, copyImageSet, createDatastore, deleteDatastore, deleteImageSet, getCachedResponseMetadata, getDatastore, getDICOMImportJob, getImageFrame, getImageSet, getImageSetMetadata, listDatastores, listDICOMImportJobs, listImageSetVersions, listTagsForResource, searchImageSets, startDICOMImportJob, tagResource, untagResource, updateImageSetMetadataaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcopyImageSet, createDatastore, deleteDatastore, deleteImageSet, getCachedResponseMetadata, getDatastore, getDICOMImportJob, getImageFrame, getImageSet, getImageSetMetadata, listDatastores, listDICOMImportJobs, listImageSetVersions, listTagsForResource, searchImageSets, startDICOMImportJob, tagResource, untagResource, updateImageSetMetadatapublic static AWSMedicalImagingAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CopyImageSetResult> copyImageSetAsync(CopyImageSetRequest request)
AWSMedicalImagingAsyncCopy an image set.
copyImageSetAsync in interface AWSMedicalImagingAsyncpublic Future<CopyImageSetResult> copyImageSetAsync(CopyImageSetRequest request, AsyncHandler<CopyImageSetRequest,CopyImageSetResult> asyncHandler)
AWSMedicalImagingAsyncCopy an image set.
copyImageSetAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDatastoreResult> createDatastoreAsync(CreateDatastoreRequest request)
AWSMedicalImagingAsyncCreate a data store.
createDatastoreAsync in interface AWSMedicalImagingAsyncpublic Future<CreateDatastoreResult> createDatastoreAsync(CreateDatastoreRequest request, AsyncHandler<CreateDatastoreRequest,CreateDatastoreResult> asyncHandler)
AWSMedicalImagingAsyncCreate a data store.
createDatastoreAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDatastoreResult> deleteDatastoreAsync(DeleteDatastoreRequest request)
AWSMedicalImagingAsyncDelete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreAsync in interface AWSMedicalImagingAsyncpublic Future<DeleteDatastoreResult> deleteDatastoreAsync(DeleteDatastoreRequest request, AsyncHandler<DeleteDatastoreRequest,DeleteDatastoreResult> asyncHandler)
AWSMedicalImagingAsyncDelete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteImageSetResult> deleteImageSetAsync(DeleteImageSetRequest request)
AWSMedicalImagingAsyncDelete an image set.
deleteImageSetAsync in interface AWSMedicalImagingAsyncpublic Future<DeleteImageSetResult> deleteImageSetAsync(DeleteImageSetRequest request, AsyncHandler<DeleteImageSetRequest,DeleteImageSetResult> asyncHandler)
AWSMedicalImagingAsyncDelete an image set.
deleteImageSetAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDICOMImportJobResult> getDICOMImportJobAsync(GetDICOMImportJobRequest request)
AWSMedicalImagingAsyncGet the import job properties to learn more about the job or job progress.
The jobStatus refers to the execution of the import job. Therefore, an import job can return a
jobStatus as COMPLETED even if validation issues are discovered during the import
process. If a jobStatus returns as COMPLETED, we still recommend you review the output
manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
getDICOMImportJobAsync in interface AWSMedicalImagingAsyncpublic Future<GetDICOMImportJobResult> getDICOMImportJobAsync(GetDICOMImportJobRequest request, AsyncHandler<GetDICOMImportJobRequest,GetDICOMImportJobResult> asyncHandler)
AWSMedicalImagingAsyncGet the import job properties to learn more about the job or job progress.
The jobStatus refers to the execution of the import job. Therefore, an import job can return a
jobStatus as COMPLETED even if validation issues are discovered during the import
process. If a jobStatus returns as COMPLETED, we still recommend you review the output
manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
getDICOMImportJobAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDatastoreResult> getDatastoreAsync(GetDatastoreRequest request)
AWSMedicalImagingAsyncGet data store properties.
getDatastoreAsync in interface AWSMedicalImagingAsyncpublic Future<GetDatastoreResult> getDatastoreAsync(GetDatastoreRequest request, AsyncHandler<GetDatastoreRequest,GetDatastoreResult> asyncHandler)
AWSMedicalImagingAsyncGet data store properties.
getDatastoreAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetImageFrameResult> getImageFrameAsync(GetImageFrameRequest request)
AWSMedicalImagingAsyncGet an image frame (pixel data) for an image set.
getImageFrameAsync in interface AWSMedicalImagingAsyncpublic Future<GetImageFrameResult> getImageFrameAsync(GetImageFrameRequest request, AsyncHandler<GetImageFrameRequest,GetImageFrameResult> asyncHandler)
AWSMedicalImagingAsyncGet an image frame (pixel data) for an image set.
getImageFrameAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetImageSetResult> getImageSetAsync(GetImageSetRequest request)
AWSMedicalImagingAsyncGet image set properties.
getImageSetAsync in interface AWSMedicalImagingAsyncpublic Future<GetImageSetResult> getImageSetAsync(GetImageSetRequest request, AsyncHandler<GetImageSetRequest,GetImageSetResult> asyncHandler)
AWSMedicalImagingAsyncGet image set properties.
getImageSetAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetImageSetMetadataResult> getImageSetMetadataAsync(GetImageSetMetadataRequest request)
AWSMedicalImagingAsyncGet metadata attributes for an image set.
getImageSetMetadataAsync in interface AWSMedicalImagingAsyncpublic Future<GetImageSetMetadataResult> getImageSetMetadataAsync(GetImageSetMetadataRequest request, AsyncHandler<GetImageSetMetadataRequest,GetImageSetMetadataResult> asyncHandler)
AWSMedicalImagingAsyncGet metadata attributes for an image set.
getImageSetMetadataAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDICOMImportJobsResult> listDICOMImportJobsAsync(ListDICOMImportJobsRequest request)
AWSMedicalImagingAsyncList import jobs created for a specific data store.
listDICOMImportJobsAsync in interface AWSMedicalImagingAsyncpublic Future<ListDICOMImportJobsResult> listDICOMImportJobsAsync(ListDICOMImportJobsRequest request, AsyncHandler<ListDICOMImportJobsRequest,ListDICOMImportJobsResult> asyncHandler)
AWSMedicalImagingAsyncList import jobs created for a specific data store.
listDICOMImportJobsAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDatastoresResult> listDatastoresAsync(ListDatastoresRequest request)
AWSMedicalImagingAsyncList data stores.
listDatastoresAsync in interface AWSMedicalImagingAsyncpublic Future<ListDatastoresResult> listDatastoresAsync(ListDatastoresRequest request, AsyncHandler<ListDatastoresRequest,ListDatastoresResult> asyncHandler)
AWSMedicalImagingAsyncList data stores.
listDatastoresAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListImageSetVersionsResult> listImageSetVersionsAsync(ListImageSetVersionsRequest request)
AWSMedicalImagingAsyncList image set versions.
listImageSetVersionsAsync in interface AWSMedicalImagingAsyncpublic Future<ListImageSetVersionsResult> listImageSetVersionsAsync(ListImageSetVersionsRequest request, AsyncHandler<ListImageSetVersionsRequest,ListImageSetVersionsResult> asyncHandler)
AWSMedicalImagingAsyncList image set versions.
listImageSetVersionsAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSMedicalImagingAsyncLists all tags associated with a medical imaging resource.
listTagsForResourceAsync in interface AWSMedicalImagingAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSMedicalImagingAsyncLists all tags associated with a medical imaging resource.
listTagsForResourceAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchImageSetsResult> searchImageSetsAsync(SearchImageSetsRequest request)
AWSMedicalImagingAsyncSearch image sets based on defined input attributes.
SearchImageSets accepts a single search query parameter and returns a paginated response of all
image sets that have the matching criteria. All date range queries must be input as
(lowerBound, upperBound).
By default, SearchImageSets uses the updatedAt field for sorting in descending order
from newest to oldest.
searchImageSetsAsync in interface AWSMedicalImagingAsyncpublic Future<SearchImageSetsResult> searchImageSetsAsync(SearchImageSetsRequest request, AsyncHandler<SearchImageSetsRequest,SearchImageSetsResult> asyncHandler)
AWSMedicalImagingAsyncSearch image sets based on defined input attributes.
SearchImageSets accepts a single search query parameter and returns a paginated response of all
image sets that have the matching criteria. All date range queries must be input as
(lowerBound, upperBound).
By default, SearchImageSets uses the updatedAt field for sorting in descending order
from newest to oldest.
searchImageSetsAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDICOMImportJobResult> startDICOMImportJobAsync(StartDICOMImportJobRequest request)
AWSMedicalImagingAsync
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.
startDICOMImportJobAsync in interface AWSMedicalImagingAsyncpublic Future<StartDICOMImportJobResult> startDICOMImportJobAsync(StartDICOMImportJobRequest request, AsyncHandler<StartDICOMImportJobRequest,StartDICOMImportJobResult> asyncHandler)
AWSMedicalImagingAsync
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.
startDICOMImportJobAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSMedicalImagingAsyncAdds a user-specifed key and value tag to a medical imaging resource.
tagResourceAsync in interface AWSMedicalImagingAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSMedicalImagingAsyncAdds a user-specifed key and value tag to a medical imaging resource.
tagResourceAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSMedicalImagingAsyncRemoves tags from a medical imaging resource.
untagResourceAsync in interface AWSMedicalImagingAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSMedicalImagingAsyncRemoves tags from a medical imaging resource.
untagResourceAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateImageSetMetadataResult> updateImageSetMetadataAsync(UpdateImageSetMetadataRequest request)
AWSMedicalImagingAsyncUpdate image set metadata attributes.
updateImageSetMetadataAsync in interface AWSMedicalImagingAsyncpublic Future<UpdateImageSetMetadataResult> updateImageSetMetadataAsync(UpdateImageSetMetadataRequest request, AsyncHandler<UpdateImageSetMetadataRequest,UpdateImageSetMetadataResult> asyncHandler)
AWSMedicalImagingAsyncUpdate image set metadata attributes.
updateImageSetMetadataAsync in interface AWSMedicalImagingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSMedicalImagingshutdown in class AWSMedicalImagingClient