/* * 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.comprehendmedical; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.comprehendmedical.model.*; /** * Interface for accessing ComprehendMedical. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.comprehendmedical.AbstractAWSComprehendMedical} instead. *
**
* Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain * insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon * Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and * quotas in the Amazon Comprehend Medical Developer Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSComprehendMedical { /** * 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 = "comprehendmedical"; /** ** Gets the properties associated with a medical entities detection job. Use this operation to get the status of a * detection job. *
* * @param describeEntitiesDetectionV2JobRequest * @return Result of the DescribeEntitiesDetectionV2Job operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.DescribeEntitiesDetectionV2Job * @see AWS API Documentation */ DescribeEntitiesDetectionV2JobResult describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest); /** ** Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference * job. *
* * @param describeICD10CMInferenceJobRequest * @return Result of the DescribeICD10CMInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.DescribeICD10CMInferenceJob * @see AWS API Documentation */ DescribeICD10CMInferenceJobResult describeICD10CMInferenceJob(DescribeICD10CMInferenceJobRequest describeICD10CMInferenceJobRequest); /** ** Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get * the status of a detection job. *
* * @param describePHIDetectionJobRequest * @return Result of the DescribePHIDetectionJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.DescribePHIDetectionJob * @see AWS API Documentation */ DescribePHIDetectionJobResult describePHIDetectionJob(DescribePHIDetectionJobRequest describePHIDetectionJobRequest); /** ** Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. *
* * @param describeRxNormInferenceJobRequest * @return Result of the DescribeRxNormInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.DescribeRxNormInferenceJob * @see AWS API Documentation */ DescribeRxNormInferenceJobResult describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest); /** ** Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference * job. *
* * @param describeSNOMEDCTInferenceJobRequest * @return Result of the DescribeSNOMEDCTInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.DescribeSNOMEDCTInferenceJob * @see AWS API Documentation */ DescribeSNOMEDCTInferenceJobResult describeSNOMEDCTInferenceJob(DescribeSNOMEDCTInferenceJobRequest describeSNOMEDCTInferenceJobRequest); /** *
* The DetectEntities
operation is deprecated. You should use the DetectEntitiesV2 operation
* instead.
*
* Inspects the clinical text for a variety of medical entities and returns specific information about them such as * entity category, location, and confidence score on that information. *
* * @param detectEntitiesRequest * @return Result of the DetectEntities operation returned by the service. * @throws InternalServerException * An internal server error occurred. Retry your request. * @throws ServiceUnavailableException * The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws InvalidEncodingException * The input text was not in valid UTF-8 character encoding. Check your text then retry your request. * @throws TextSizeLimitExceededException * The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller * document and then retry your request. * @sample AWSComprehendMedical.DetectEntities * @see AWS API Documentation */ @Deprecated DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest); /** ** Inspects the clinical text for a variety of medical entities and returns specific information about them such as * entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects * medical entities in English language texts. *
*
* The DetectEntitiesV2
operation replaces the DetectEntities operation. This new action uses a
* different model for determining the entities in your medical text and changes the way that some entities are
* returned in the output. You should use the DetectEntitiesV2
operation in all new applications.
*
* The DetectEntitiesV2
operation returns the Acuity
and Direction
entities
* as attributes instead of types.
*
* Inspects the clinical text for protected health information (PHI) entities and returns the entity category, * location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English * language texts. *
* * @param detectPHIRequest * @return Result of the DetectPHI operation returned by the service. * @throws InternalServerException * An internal server error occurred. Retry your request. * @throws ServiceUnavailableException * The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws InvalidEncodingException * The input text was not in valid UTF-8 character encoding. Check your text then retry your request. * @throws TextSizeLimitExceededException * The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller * document and then retry your request. * @sample AWSComprehendMedical.DetectPHI * @see AWS * API Documentation */ DetectPHIResult detectPHI(DetectPHIRequest detectPHIRequest); /** ** InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to * normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon * Comprehend Medical only detects medical entities in English language texts. *
* * @param inferICD10CMRequest * @return Result of the InferICD10CM operation returned by the service. * @throws InternalServerException * An internal server error occurred. Retry your request. * @throws ServiceUnavailableException * The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws InvalidEncodingException * The input text was not in valid UTF-8 character encoding. Check your text then retry your request. * @throws TextSizeLimitExceededException * The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller * document and then retry your request. * @sample AWSComprehendMedical.InferICD10CM * @see AWS * API Documentation */ InferICD10CMResult inferICD10CM(InferICD10CMRequest inferICD10CMRequest); /** ** InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept * identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects * medical entities in English language texts. *
* * @param inferRxNormRequest * @return Result of the InferRxNorm operation returned by the service. * @throws InternalServerException * An internal server error occurred. Retry your request. * @throws ServiceUnavailableException * The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws InvalidEncodingException * The input text was not in valid UTF-8 character encoding. Check your text then retry your request. * @throws TextSizeLimitExceededException * The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller * document and then retry your request. * @sample AWSComprehendMedical.InferRxNorm * @see AWS * API Documentation */ InferRxNormResult inferRxNorm(InferRxNormRequest inferRxNormRequest); /** ** InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized * Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology *
* * @param inferSNOMEDCTRequest * @return Result of the InferSNOMEDCT operation returned by the service. * @throws InternalServerException * An internal server error occurred. Retry your request. * @throws ServiceUnavailableException * The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws InvalidEncodingException * The input text was not in valid UTF-8 character encoding. Check your text then retry your request. * @throws TextSizeLimitExceededException * The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller * document and then retry your request. * @sample AWSComprehendMedical.InferSNOMEDCT * @see AWS API Documentation */ InferSNOMEDCTResult inferSNOMEDCT(InferSNOMEDCTRequest inferSNOMEDCTRequest); /** ** Gets a list of medical entity detection jobs that you have submitted. *
* * @param listEntitiesDetectionV2JobsRequest * @return Result of the ListEntitiesDetectionV2Jobs operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ValidationException * The filter that you specified for the operation is invalid. Check the filter values that you entered and * try your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.ListEntitiesDetectionV2Jobs * @see AWS API Documentation */ ListEntitiesDetectionV2JobsResult listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest); /** ** Gets a list of InferICD10CM jobs that you have submitted. *
* * @param listICD10CMInferenceJobsRequest * @return Result of the ListICD10CMInferenceJobs operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ValidationException * The filter that you specified for the operation is invalid. Check the filter values that you entered and * try your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.ListICD10CMInferenceJobs * @see AWS API Documentation */ ListICD10CMInferenceJobsResult listICD10CMInferenceJobs(ListICD10CMInferenceJobsRequest listICD10CMInferenceJobsRequest); /** ** Gets a list of protected health information (PHI) detection jobs you have submitted. *
* * @param listPHIDetectionJobsRequest * @return Result of the ListPHIDetectionJobs operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ValidationException * The filter that you specified for the operation is invalid. Check the filter values that you entered and * try your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.ListPHIDetectionJobs * @see AWS API Documentation */ ListPHIDetectionJobsResult listPHIDetectionJobs(ListPHIDetectionJobsRequest listPHIDetectionJobsRequest); /** ** Gets a list of InferRxNorm jobs that you have submitted. *
* * @param listRxNormInferenceJobsRequest * @return Result of the ListRxNormInferenceJobs operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ValidationException * The filter that you specified for the operation is invalid. Check the filter values that you entered and * try your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.ListRxNormInferenceJobs * @see AWS API Documentation */ ListRxNormInferenceJobsResult listRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest); /** ** Gets a list of InferSNOMEDCT jobs a user has submitted. *
* * @param listSNOMEDCTInferenceJobsRequest * @return Result of the ListSNOMEDCTInferenceJobs operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ValidationException * The filter that you specified for the operation is invalid. Check the filter values that you entered and * try your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.ListSNOMEDCTInferenceJobs * @see AWS API Documentation */ ListSNOMEDCTInferenceJobsResult listSNOMEDCTInferenceJobs(ListSNOMEDCTInferenceJobsRequest listSNOMEDCTInferenceJobsRequest); /** *
* Starts an asynchronous medical entity detection job for a collection of documents. Use the
* DescribeEntitiesDetectionV2Job
operation to track the status of a job.
*
* Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the
* DescribeICD10CMInferenceJob
operation to track the status of a job.
*
* Starts an asynchronous job to detect protected health information (PHI). Use the
* DescribePHIDetectionJob
operation to track the status of a job.
*
* Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the
* DescribeRxNormInferenceJob
operation to track the status of a job.
*
* Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the * DescribeSNOMEDCTInferenceJob operation to track the status of a job. *
* * @param startSNOMEDCTInferenceJobRequest * @return Result of the StartSNOMEDCTInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StartSNOMEDCTInferenceJob * @see AWS API Documentation */ StartSNOMEDCTInferenceJobResult startSNOMEDCTInferenceJob(StartSNOMEDCTInferenceJobRequest startSNOMEDCTInferenceJobRequest); /** ** Stops a medical entities detection job in progress. *
* * @param stopEntitiesDetectionV2JobRequest * @return Result of the StopEntitiesDetectionV2Job operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StopEntitiesDetectionV2Job * @see AWS API Documentation */ StopEntitiesDetectionV2JobResult stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest); /** ** Stops an InferICD10CM inference job in progress. *
* * @param stopICD10CMInferenceJobRequest * @return Result of the StopICD10CMInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StopICD10CMInferenceJob * @see AWS API Documentation */ StopICD10CMInferenceJobResult stopICD10CMInferenceJob(StopICD10CMInferenceJobRequest stopICD10CMInferenceJobRequest); /** ** Stops a protected health information (PHI) detection job in progress. *
* * @param stopPHIDetectionJobRequest * @return Result of the StopPHIDetectionJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StopPHIDetectionJob * @see AWS API Documentation */ StopPHIDetectionJobResult stopPHIDetectionJob(StopPHIDetectionJobRequest stopPHIDetectionJobRequest); /** ** Stops an InferRxNorm inference job in progress. *
* * @param stopRxNormInferenceJobRequest * @return Result of the StopRxNormInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StopRxNormInferenceJob * @see AWS API Documentation */ StopRxNormInferenceJobResult stopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest); /** ** Stops an InferSNOMEDCT inference job in progress. *
* * @param stopSNOMEDCTInferenceJobRequest * @return Result of the StopSNOMEDCTInferenceJob operation returned by the service. * @throws InvalidRequestException * The request that you made is invalid. Check your request to determine why it's invalid and then retry the * request. * @throws ResourceNotFoundException * The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try * your request again. * @throws TooManyRequestsException * You have made too many requests within a short period of time. Wait for a short time and then try your * request again. Contact customer support for more information about a service limit increase. * @throws InternalServerException * An internal server error occurred. Retry your request. * @sample AWSComprehendMedical.StopSNOMEDCTInferenceJob * @see AWS API Documentation */ StopSNOMEDCTInferenceJobResult stopSNOMEDCTInferenceJob(StopSNOMEDCTInferenceJobRequest stopSNOMEDCTInferenceJobRequest); /** * 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); }