@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMedicalImagingAsync extends AWSMedicalImaging
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMedicalImagingAsync instead.
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
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying 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.
ENDPOINT_PREFIXcopyImageSet, createDatastore, deleteDatastore, deleteImageSet, getCachedResponseMetadata, getDatastore, getDICOMImportJob, getImageFrame, getImageSet, getImageSetMetadata, listDatastores, listDICOMImportJobs, listImageSetVersions, listTagsForResource, searchImageSets, shutdown, startDICOMImportJob, tagResource, untagResource, updateImageSetMetadataFuture<CopyImageSetResult> copyImageSetAsync(CopyImageSetRequest copyImageSetRequest)
Copy an image set.
copyImageSetRequest - Future<CopyImageSetResult> copyImageSetAsync(CopyImageSetRequest copyImageSetRequest, AsyncHandler<CopyImageSetRequest,CopyImageSetResult> asyncHandler)
Copy an image set.
copyImageSetRequest - asyncHandler - 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.Future<CreateDatastoreResult> createDatastoreAsync(CreateDatastoreRequest createDatastoreRequest)
Create a data store.
createDatastoreRequest - Future<CreateDatastoreResult> createDatastoreAsync(CreateDatastoreRequest createDatastoreRequest, AsyncHandler<CreateDatastoreRequest,CreateDatastoreResult> asyncHandler)
Create a data store.
createDatastoreRequest - asyncHandler - 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.Future<DeleteDatastoreResult> deleteDatastoreAsync(DeleteDatastoreRequest deleteDatastoreRequest)
Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreRequest - Future<DeleteDatastoreResult> deleteDatastoreAsync(DeleteDatastoreRequest deleteDatastoreRequest, AsyncHandler<DeleteDatastoreRequest,DeleteDatastoreResult> asyncHandler)
Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreRequest - asyncHandler - 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.Future<DeleteImageSetResult> deleteImageSetAsync(DeleteImageSetRequest deleteImageSetRequest)
Delete an image set.
deleteImageSetRequest - Future<DeleteImageSetResult> deleteImageSetAsync(DeleteImageSetRequest deleteImageSetRequest, AsyncHandler<DeleteImageSetRequest,DeleteImageSetResult> asyncHandler)
Delete an image set.
deleteImageSetRequest - asyncHandler - 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.Future<GetDICOMImportJobResult> getDICOMImportJobAsync(GetDICOMImportJobRequest getDICOMImportJobRequest)
Get the import job properties to learn more about the job or job progress.
getDICOMImportJobRequest - Future<GetDICOMImportJobResult> getDICOMImportJobAsync(GetDICOMImportJobRequest getDICOMImportJobRequest, AsyncHandler<GetDICOMImportJobRequest,GetDICOMImportJobResult> asyncHandler)
Get the import job properties to learn more about the job or job progress.
getDICOMImportJobRequest - asyncHandler - 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.Future<GetDatastoreResult> getDatastoreAsync(GetDatastoreRequest getDatastoreRequest)
Get data store properties.
getDatastoreRequest - Future<GetDatastoreResult> getDatastoreAsync(GetDatastoreRequest getDatastoreRequest, AsyncHandler<GetDatastoreRequest,GetDatastoreResult> asyncHandler)
Get data store properties.
getDatastoreRequest - asyncHandler - 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.Future<GetImageFrameResult> getImageFrameAsync(GetImageFrameRequest getImageFrameRequest)
Get an image frame (pixel data) for an image set.
getImageFrameRequest - Future<GetImageFrameResult> getImageFrameAsync(GetImageFrameRequest getImageFrameRequest, AsyncHandler<GetImageFrameRequest,GetImageFrameResult> asyncHandler)
Get an image frame (pixel data) for an image set.
getImageFrameRequest - asyncHandler - 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.Future<GetImageSetResult> getImageSetAsync(GetImageSetRequest getImageSetRequest)
Get image set properties.
getImageSetRequest - Future<GetImageSetResult> getImageSetAsync(GetImageSetRequest getImageSetRequest, AsyncHandler<GetImageSetRequest,GetImageSetResult> asyncHandler)
Get image set properties.
getImageSetRequest - asyncHandler - 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.Future<GetImageSetMetadataResult> getImageSetMetadataAsync(GetImageSetMetadataRequest getImageSetMetadataRequest)
Get metadata attributes for an image set.
getImageSetMetadataRequest - Future<GetImageSetMetadataResult> getImageSetMetadataAsync(GetImageSetMetadataRequest getImageSetMetadataRequest, AsyncHandler<GetImageSetMetadataRequest,GetImageSetMetadataResult> asyncHandler)
Get metadata attributes for an image set.
getImageSetMetadataRequest - asyncHandler - 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.Future<ListDICOMImportJobsResult> listDICOMImportJobsAsync(ListDICOMImportJobsRequest listDICOMImportJobsRequest)
List import jobs created for a specific data store.
listDICOMImportJobsRequest - Future<ListDICOMImportJobsResult> listDICOMImportJobsAsync(ListDICOMImportJobsRequest listDICOMImportJobsRequest, AsyncHandler<ListDICOMImportJobsRequest,ListDICOMImportJobsResult> asyncHandler)
List import jobs created for a specific data store.
listDICOMImportJobsRequest - asyncHandler - 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.Future<ListDatastoresResult> listDatastoresAsync(ListDatastoresRequest listDatastoresRequest)
List data stores.
listDatastoresRequest - Future<ListDatastoresResult> listDatastoresAsync(ListDatastoresRequest listDatastoresRequest, AsyncHandler<ListDatastoresRequest,ListDatastoresResult> asyncHandler)
List data stores.
listDatastoresRequest - asyncHandler - 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.Future<ListImageSetVersionsResult> listImageSetVersionsAsync(ListImageSetVersionsRequest listImageSetVersionsRequest)
List image set versions.
listImageSetVersionsRequest - Future<ListImageSetVersionsResult> listImageSetVersionsAsync(ListImageSetVersionsRequest listImageSetVersionsRequest, AsyncHandler<ListImageSetVersionsRequest,ListImageSetVersionsResult> asyncHandler)
List image set versions.
listImageSetVersionsRequest - asyncHandler - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a medical imaging resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags associated with a medical imaging resource.
listTagsForResourceRequest - asyncHandler - 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.Future<SearchImageSetsResult> searchImageSetsAsync(SearchImageSetsRequest searchImageSetsRequest)
Search 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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
searchImageSetsRequest - Future<SearchImageSetsResult> searchImageSetsAsync(SearchImageSetsRequest searchImageSetsRequest, AsyncHandler<SearchImageSetsRequest,SearchImageSetsResult> asyncHandler)
Search 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 range queries must be input as
(lowerBound, upperBound).
SearchImageSets uses the updatedAt field for sorting in decreasing order from latest to
oldest.
searchImageSetsRequest - asyncHandler - 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.Future<StartDICOMImportJobResult> startDICOMImportJobAsync(StartDICOMImportJobRequest startDICOMImportJobRequest)
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.
startDICOMImportJobRequest - Future<StartDICOMImportJobResult> startDICOMImportJobAsync(StartDICOMImportJobRequest startDICOMImportJobRequest, AsyncHandler<StartDICOMImportJobRequest,StartDICOMImportJobResult> asyncHandler)
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.
startDICOMImportJobRequest - asyncHandler - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds a user-specifed key and value tag to a medical imaging resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds a user-specifed key and value tag to a medical imaging resource.
tagResourceRequest - asyncHandler - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from a medical imaging resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from a medical imaging resource.
untagResourceRequest - asyncHandler - 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.Future<UpdateImageSetMetadataResult> updateImageSetMetadataAsync(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)
Update image set metadata attributes.
updateImageSetMetadataRequest - Future<UpdateImageSetMetadataResult> updateImageSetMetadataAsync(UpdateImageSetMetadataRequest updateImageSetMetadataRequest, AsyncHandler<UpdateImageSetMetadataRequest,UpdateImageSetMetadataResult> asyncHandler)
Update image set metadata attributes.
updateImageSetMetadataRequest - asyncHandler - 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.Copyright © 2024. All rights reserved.