/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.medicalimaging; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.medicalimaging.model.*; /** * Interface for accessing AWS Health Imaging. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.medicalimaging.AbstractAWSMedicalImaging} instead. *

* This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, and * analyzing 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 AWS 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 so 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. *
*

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSMedicalImaging { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "medical-imaging"; /** *

* Copy an image set. *

* * @param copyImageSetRequest * @return Result of the CopyImageSet operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @throws ServiceQuotaExceededException * The request caused a service quota to be exceeded. * @sample AWSMedicalImaging.CopyImageSet * @see AWS * API Documentation */ CopyImageSetResult copyImageSet(CopyImageSetRequest copyImageSetRequest); /** *

* Create a data store. *

* * @param createDatastoreRequest * @return Result of the CreateDatastore operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ServiceQuotaExceededException * The request caused a service quota to be exceeded. * @sample AWSMedicalImaging.CreateDatastore * @see AWS API Documentation */ CreateDatastoreResult createDatastore(CreateDatastoreRequest createDatastoreRequest); /** *

* Delete a data store. *

* *

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

* * * @param deleteDatastoreRequest * @return Result of the DeleteDatastore operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.DeleteDatastore * @see AWS API Documentation */ DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest); /** *

* Delete an image set. *

* * @param deleteImageSetRequest * @return Result of the DeleteImageSet operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.DeleteImageSet * @see AWS * API Documentation */ DeleteImageSetResult deleteImageSet(DeleteImageSetRequest deleteImageSetRequest); /** *

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

* * @param getDICOMImportJobRequest * @return Result of the GetDICOMImportJob operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.GetDICOMImportJob * @see AWS API Documentation */ GetDICOMImportJobResult getDICOMImportJob(GetDICOMImportJobRequest getDICOMImportJobRequest); /** *

* Get data store properties. *

* * @param getDatastoreRequest * @return Result of the GetDatastore operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.GetDatastore * @see AWS * API Documentation */ GetDatastoreResult getDatastore(GetDatastoreRequest getDatastoreRequest); /** *

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

* * @param getImageFrameRequest * @return Result of the GetImageFrame operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.GetImageFrame * @see AWS * API Documentation */ GetImageFrameResult getImageFrame(GetImageFrameRequest getImageFrameRequest); /** *

* Get image set properties. *

* * @param getImageSetRequest * @return Result of the GetImageSet operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.GetImageSet * @see AWS * API Documentation */ GetImageSetResult getImageSet(GetImageSetRequest getImageSetRequest); /** *

* Get metadata attributes for an image set. *

* * @param getImageSetMetadataRequest * @return Result of the GetImageSetMetadata operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.GetImageSetMetadata * @see AWS API Documentation */ GetImageSetMetadataResult getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest); /** *

* List import jobs created by this AWS account for a specific data store. *

* * @param listDICOMImportJobsRequest * @return Result of the ListDICOMImportJobs operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.ListDICOMImportJobs * @see AWS API Documentation */ ListDICOMImportJobsResult listDICOMImportJobs(ListDICOMImportJobsRequest listDICOMImportJobsRequest); /** *

* List data stores created by this AWS account. *

* * @param listDatastoresRequest * @return Result of the ListDatastores operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @sample AWSMedicalImaging.ListDatastores * @see AWS * API Documentation */ ListDatastoresResult listDatastores(ListDatastoresRequest listDatastoresRequest); /** *

* List image set versions. *

* * @param listImageSetVersionsRequest * @return Result of the ListImageSetVersions operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.ListImageSetVersions * @see AWS API Documentation */ ListImageSetVersionsResult listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest); /** *

* Lists all tags associated with a medical imaging resource. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Search image sets based on defined input attributes. *

* * @param searchImageSetsRequest * @return Result of the SearchImageSets operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.SearchImageSets * @see AWS API Documentation */ SearchImageSetsResult searchImageSets(SearchImageSetsRequest searchImageSetsRequest); /** *

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

* * @param startDICOMImportJobRequest * @return Result of the StartDICOMImportJob operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @throws ServiceQuotaExceededException * The request caused a service quota to be exceeded. * @sample AWSMedicalImaging.StartDICOMImportJob * @see AWS API Documentation */ StartDICOMImportJobResult startDICOMImportJob(StartDICOMImportJobRequest startDICOMImportJobRequest); /** *

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

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.TagResource * @see AWS * API Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes tags from a medical imaging resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @sample AWSMedicalImaging.UntagResource * @see AWS * API Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Update image set metadata attributes. *

* * @param updateImageSetMetadataRequest * @return Result of the UpdateImageSetMetadata operation returned by the service. * @throws ThrottlingException * The request was denied due to throttling. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws AccessDeniedException * The user does not have sufficient access to perform this action. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws InternalServerException * An unexpected error occurred during processing of the request. * @throws ResourceNotFoundException * The request references a resource which does not exist. * @throws ServiceQuotaExceededException * The request caused a service quota to be exceeded. * @sample AWSMedicalImaging.UpdateImageSetMetadata * @see AWS API Documentation */ UpdateImageSetMetadataResult updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }