com.amazonaws.services.medicalimaging

Interface AWSMedicalImaging

All Known Subinterfaces:

AWSMedicalImagingAsync

All Known Implementing Classes:

AbstractAWSMedicalImaging, AbstractAWSMedicalImagingAsync, AWSMedicalImagingAsyncClient, AWSMedicalImagingClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMedicalImaging

Interface for accessing AWS Health Imaging.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMedicalImaging instead.

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

• 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 resource.

• ListTagsForResource – See Listing tags for a resource.

• UntagResource – See Untagging a resource.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CopyImageSetResult	copyImageSet(CopyImageSetRequest copyImageSetRequest) Copy an image set.
CreateDatastoreResult	createDatastore(CreateDatastoreRequest createDatastoreRequest) Create a data store.
DeleteDatastoreResult	deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest) Delete a data store.
DeleteImageSetResult	deleteImageSet(DeleteImageSetRequest deleteImageSetRequest) Delete an image set.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDatastoreResult	getDatastore(GetDatastoreRequest getDatastoreRequest) Get data store properties.
GetDICOMImportJobResult	getDICOMImportJob(GetDICOMImportJobRequest getDICOMImportJobRequest) Get the import job properties to learn more about the job or job progress.
GetImageFrameResult	getImageFrame(GetImageFrameRequest getImageFrameRequest) Get an image frame (pixel data) for an image set.
GetImageSetResult	getImageSet(GetImageSetRequest getImageSetRequest) Get image set properties.
GetImageSetMetadataResult	getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest) Get metadata attributes for an image set.
ListDatastoresResult	listDatastores(ListDatastoresRequest listDatastoresRequest) List data stores.
ListDICOMImportJobsResult	listDICOMImportJobs(ListDICOMImportJobsRequest listDICOMImportJobsRequest) List import jobs created for a specific data store.
ListImageSetVersionsResult	listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest) List image set versions.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a medical imaging resource.
SearchImageSetsResult	searchImageSets(SearchImageSetsRequest searchImageSetsRequest) Search image sets based on defined input attributes.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDICOMImportJobResult	startDICOMImportJob(StartDICOMImportJobRequest startDICOMImportJobRequest) Start importing bulk data into an ACTIVE data store.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds a user-specifed key and value tag to a medical imaging resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a medical imaging resource.
UpdateImageSetMetadataResult	updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest) Update image set metadata attributes.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

copyImageSet

CopyImageSetResult copyImageSet(CopyImageSetRequest copyImageSetRequest)

Copy an image set.

Parameters:

copyImageSetRequest -

Returns:

Result of the CopyImageSet operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

ServiceQuotaExceededException - The request caused a service quota to be exceeded.

See Also:

AWS API Documentation

createDatastore

CreateDatastoreResult createDatastore(CreateDatastoreRequest createDatastoreRequest)

Create a data store.

Parameters:

createDatastoreRequest -

Returns:

Result of the CreateDatastore operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ServiceQuotaExceededException - The request caused a service quota to be exceeded.

See Also:

AWS API Documentation

deleteDatastore

DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)

Delete a data store.

Before a data store can be deleted, you must first delete all image sets within it.

Parameters:

deleteDatastoreRequest -

Returns:

Result of the DeleteDatastore operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

deleteImageSet

DeleteImageSetResult deleteImageSet(DeleteImageSetRequest deleteImageSetRequest)

Delete an image set.

Parameters:

deleteImageSetRequest -

Returns:

Result of the DeleteImageSet operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

getDICOMImportJob

GetDICOMImportJobResult getDICOMImportJob(GetDICOMImportJobRequest getDICOMImportJobRequest)

Get 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.

Parameters:

getDICOMImportJobRequest -

Returns:

Result of the GetDICOMImportJob operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

getDatastore

GetDatastoreResult getDatastore(GetDatastoreRequest getDatastoreRequest)

Get data store properties.

Parameters:

getDatastoreRequest -

Returns:

Result of the GetDatastore operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

getImageFrame

GetImageFrameResult getImageFrame(GetImageFrameRequest getImageFrameRequest)

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

Parameters:

getImageFrameRequest -

Returns:

Result of the GetImageFrame operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

getImageSet

GetImageSetResult getImageSet(GetImageSetRequest getImageSetRequest)

Get image set properties.

Parameters:

getImageSetRequest -

Returns:

Result of the GetImageSet operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

getImageSetMetadata

GetImageSetMetadataResult getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest)

Get metadata attributes for an image set.

Parameters:

getImageSetMetadataRequest -

Returns:

Result of the GetImageSetMetadata operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

listDICOMImportJobs

ListDICOMImportJobsResult listDICOMImportJobs(ListDICOMImportJobsRequest listDICOMImportJobsRequest)

List import jobs created for a specific data store.

Parameters:

listDICOMImportJobsRequest -

Returns:

Result of the ListDICOMImportJobs operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

listDatastores

ListDatastoresResult listDatastores(ListDatastoresRequest listDatastoresRequest)

List data stores.

Parameters:

listDatastoresRequest -

Returns:

Result of the ListDatastores operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

See Also:

AWS API Documentation

listImageSetVersions

ListImageSetVersionsResult listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest)

List image set versions.

Parameters:

listImageSetVersionsRequest -

Returns:

Result of the ListImageSetVersions operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags associated with a medical imaging resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

searchImageSets

SearchImageSetsResult searchImageSets(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 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.

Parameters:

searchImageSetsRequest -

Returns:

Result of the SearchImageSets operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

startDICOMImportJob

StartDICOMImportJobResult startDICOMImportJob(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.

Parameters:

startDICOMImportJobRequest -

Returns:

Result of the StartDICOMImportJob operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

ServiceQuotaExceededException - The request caused a service quota to be exceeded.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a medical imaging resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

See Also:

AWS API Documentation

updateImageSetMetadata

UpdateImageSetMetadataResult updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)

Update image set metadata attributes.

Parameters:

updateImageSetMetadataRequest -

Returns:

Result of the UpdateImageSetMetadata operation returned by the service.

Throws:

ThrottlingException - The request was denied due to throttling.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

AccessDeniedException - The user does not have sufficient access to perform this action.

ValidationException - The input fails to satisfy the constraints set by the service.

InternalServerException - An unexpected error occurred during processing of the request.

ResourceNotFoundException - The request references a resource which does not exist.

ServiceQuotaExceededException - The request caused a service quota to be exceeded.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.