com.amazonaws.services.medicalimaging

Class AWSMedicalImagingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.medicalimaging.AWSMedicalImagingClient

All Implemented Interfaces:

AWSMedicalImaging

Direct Known Subclasses:

AWSMedicalImagingAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMedicalImagingClient
extends AmazonWebServiceClient
implements AWSMedicalImaging

Client for accessing AWS Health Imaging. All service calls made using this client are blocking, and will not return until the service call 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

• 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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.medicalimaging.AWSMedicalImaging

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMedicalImagingClientBuilder	builder()
CopyImageSetResult	copyImageSet(CopyImageSetRequest request) Copy an image set.
CreateDatastoreResult	createDatastore(CreateDatastoreRequest request) Create a data store.
DeleteDatastoreResult	deleteDatastore(DeleteDatastoreRequest request) Delete a data store.
DeleteImageSetResult	deleteImageSet(DeleteImageSetRequest request) 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 request) Get data store properties.
GetDICOMImportJobResult	getDICOMImportJob(GetDICOMImportJobRequest request) Get the import job properties to learn more about the job or job progress.
GetImageFrameResult	getImageFrame(GetImageFrameRequest request) Get an image frame (pixel data) for an image set.
GetImageSetResult	getImageSet(GetImageSetRequest request) Get image set properties.
GetImageSetMetadataResult	getImageSetMetadata(GetImageSetMetadataRequest request) Get metadata attributes for an image set.
ListDatastoresResult	listDatastores(ListDatastoresRequest request) List data stores.
ListDICOMImportJobsResult	listDICOMImportJobs(ListDICOMImportJobsRequest request) List import jobs created for a specific data store.
ListImageSetVersionsResult	listImageSetVersions(ListImageSetVersionsRequest request) List image set versions.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags associated with a medical imaging resource.
SearchImageSetsResult	searchImageSets(SearchImageSetsRequest request) 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 request) Start importing bulk data into an ACTIVE data store.
TagResourceResult	tagResource(TagResourceRequest request) Adds a user-specifed key and value tag to a medical imaging resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from a medical imaging resource.
UpdateImageSetMetadataResult	updateImageSetMetadata(UpdateImageSetMetadataRequest request) Update image set metadata attributes.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSMedicalImagingClientBuilder builder()

copyImageSet

public CopyImageSetResult copyImageSet(CopyImageSetRequest request)

Copy an image set.

Specified by:

copyImageSet in interface AWSMedicalImaging

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

public CreateDatastoreResult createDatastore(CreateDatastoreRequest request)

Create a data store.

Specified by:

createDatastore in interface AWSMedicalImaging

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

public DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest request)

Delete a data store.

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

Specified by:

deleteDatastore in interface AWSMedicalImaging

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

public DeleteImageSetResult deleteImageSet(DeleteImageSetRequest request)

Delete an image set.

Specified by:

deleteImageSet in interface AWSMedicalImaging

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

public GetDICOMImportJobResult getDICOMImportJob(GetDICOMImportJobRequest request)

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.

Specified by:

getDICOMImportJob in interface AWSMedicalImaging

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

public GetDatastoreResult getDatastore(GetDatastoreRequest request)

Get data store properties.

Specified by:

getDatastore in interface AWSMedicalImaging

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

public GetImageFrameResult getImageFrame(GetImageFrameRequest request)

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

Specified by:

getImageFrame in interface AWSMedicalImaging

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

public GetImageSetResult getImageSet(GetImageSetRequest request)

Get image set properties.

Specified by:

getImageSet in interface AWSMedicalImaging

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

public GetImageSetMetadataResult getImageSetMetadata(GetImageSetMetadataRequest request)

Get metadata attributes for an image set.

Specified by:

getImageSetMetadata in interface AWSMedicalImaging

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

public ListDICOMImportJobsResult listDICOMImportJobs(ListDICOMImportJobsRequest request)

List import jobs created for a specific data store.

Specified by:

listDICOMImportJobs in interface AWSMedicalImaging

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

public ListDatastoresResult listDatastores(ListDatastoresRequest request)

List data stores.

Specified by:

listDatastores in interface AWSMedicalImaging

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

public ListImageSetVersionsResult listImageSetVersions(ListImageSetVersionsRequest request)

List image set versions.

Specified by:

listImageSetVersions in interface AWSMedicalImaging

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags associated with a medical imaging resource.

Specified by:

listTagsForResource in interface AWSMedicalImaging

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

public SearchImageSetsResult searchImageSets(SearchImageSetsRequest request)

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.

Specified by:

searchImageSets in interface AWSMedicalImaging

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

public StartDICOMImportJobResult startDICOMImportJob(StartDICOMImportJobRequest request)

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.

Specified by:

startDICOMImportJob in interface AWSMedicalImaging

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

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AWSMedicalImaging

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from a medical imaging resource.

Specified by:

untagResource in interface AWSMedicalImaging

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

public UpdateImageSetMetadataResult updateImageSetMetadata(UpdateImageSetMetadataRequest request)

Update image set metadata attributes.

Specified by:

updateImageSetMetadata in interface AWSMedicalImaging

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSMedicalImaging

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMedicalImaging

Overrides:

shutdown in class AmazonWebServiceClient