/* * 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.services.comprehendmedical.model.*; /** * Interface for accessing ComprehendMedical asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.comprehendmedical.AbstractAWSComprehendMedicalAsync} 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 AWSComprehendMedicalAsync extends AWSComprehendMedical { /** ** Gets the properties associated with a medical entities detection job. Use this operation to get the status of a * detection job. *
* * @param describeEntitiesDetectionV2JobRequest * @return A Java Future containing the result of the DescribeEntitiesDetectionV2Job operation returned by the * service. * @sample AWSComprehendMedicalAsync.DescribeEntitiesDetectionV2Job * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with a medical entities detection job. Use this operation to get the status of a * detection job. *
* * @param describeEntitiesDetectionV2JobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeEntitiesDetectionV2Job operation returned by the * service. * @sample AWSComprehendMedicalAsyncHandler.DescribeEntitiesDetectionV2Job * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference * job. *
* * @param describeICD10CMInferenceJobRequest * @return A Java Future containing the result of the DescribeICD10CMInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.DescribeICD10CMInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference * job. *
* * @param describeICD10CMInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeICD10CMInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.DescribeICD10CMInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the DescribePHIDetectionJob operation returned by the service. * @sample AWSComprehendMedicalAsync.DescribePHIDetectionJob * @see AWS API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribePHIDetectionJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.DescribePHIDetectionJob * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. *
* * @param describeRxNormInferenceJobRequest * @return A Java Future containing the result of the DescribeRxNormInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.DescribeRxNormInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. *
* * @param describeRxNormInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRxNormInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.DescribeRxNormInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference * job. *
* * @param describeSNOMEDCTInferenceJobRequest * @return A Java Future containing the result of the DescribeSNOMEDCTInferenceJob operation returned by the * service. * @sample AWSComprehendMedicalAsync.DescribeSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference * job. *
* * @param describeSNOMEDCTInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSNOMEDCTInferenceJob operation returned by the * service. * @sample AWSComprehendMedicalAsyncHandler.DescribeSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future
* 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 A Java Future containing the result of the DetectEntities operation returned by the service. * @sample AWSComprehendMedicalAsync.DetectEntities * @see AWS API Documentation */ @Deprecated java.util.concurrent.Future
* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DetectEntities operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.DetectEntities * @see AWS API Documentation */ @Deprecated java.util.concurrent.Future* 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 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 A Java Future containing the result of the DetectPHI operation returned by the service. * @sample AWSComprehendMedicalAsync.DetectPHI * @see AWS * API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DetectPHI operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.DetectPHI * @see AWS * API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the InferICD10CM operation returned by the service. * @sample AWSComprehendMedicalAsync.InferICD10CM * @see AWS * API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InferICD10CM operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.InferICD10CM * @see AWS * API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the InferRxNorm operation returned by the service. * @sample AWSComprehendMedicalAsync.InferRxNorm * @see AWS * API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InferRxNorm operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.InferRxNorm * @see AWS * API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the InferSNOMEDCT operation returned by the service. * @sample AWSComprehendMedicalAsync.InferSNOMEDCT * @see AWS API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InferSNOMEDCT operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.InferSNOMEDCT * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of medical entity detection jobs that you have submitted. *
* * @param listEntitiesDetectionV2JobsRequest * @return A Java Future containing the result of the ListEntitiesDetectionV2Jobs operation returned by the service. * @sample AWSComprehendMedicalAsync.ListEntitiesDetectionV2Jobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of medical entity detection jobs that you have submitted. *
* * @param listEntitiesDetectionV2JobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListEntitiesDetectionV2Jobs operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.ListEntitiesDetectionV2Jobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferICD10CM jobs that you have submitted. *
* * @param listICD10CMInferenceJobsRequest * @return A Java Future containing the result of the ListICD10CMInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsync.ListICD10CMInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferICD10CM jobs that you have submitted. *
* * @param listICD10CMInferenceJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListICD10CMInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.ListICD10CMInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of protected health information (PHI) detection jobs you have submitted. *
* * @param listPHIDetectionJobsRequest * @return A Java Future containing the result of the ListPHIDetectionJobs operation returned by the service. * @sample AWSComprehendMedicalAsync.ListPHIDetectionJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of protected health information (PHI) detection jobs you have submitted. *
* * @param listPHIDetectionJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListPHIDetectionJobs operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.ListPHIDetectionJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferRxNorm jobs that you have submitted. *
* * @param listRxNormInferenceJobsRequest * @return A Java Future containing the result of the ListRxNormInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsync.ListRxNormInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferRxNorm jobs that you have submitted. *
* * @param listRxNormInferenceJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRxNormInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.ListRxNormInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferSNOMEDCT jobs a user has submitted. *
* * @param listSNOMEDCTInferenceJobsRequest * @return A Java Future containing the result of the ListSNOMEDCTInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsync.ListSNOMEDCTInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of InferSNOMEDCT jobs a user has submitted. *
* * @param listSNOMEDCTInferenceJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSNOMEDCTInferenceJobs operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.ListSNOMEDCTInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future
* 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 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 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 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 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 A Java Future containing the result of the StartSNOMEDCTInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.StartSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartSNOMEDCTInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StartSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops a medical entities detection job in progress. *
* * @param stopEntitiesDetectionV2JobRequest * @return A Java Future containing the result of the StopEntitiesDetectionV2Job operation returned by the service. * @sample AWSComprehendMedicalAsync.StopEntitiesDetectionV2Job * @see AWS API Documentation */ java.util.concurrent.Future* Stops a medical entities detection job in progress. *
* * @param stopEntitiesDetectionV2JobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopEntitiesDetectionV2Job operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StopEntitiesDetectionV2Job * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferICD10CM inference job in progress. *
* * @param stopICD10CMInferenceJobRequest * @return A Java Future containing the result of the StopICD10CMInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.StopICD10CMInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferICD10CM inference job in progress. *
* * @param stopICD10CMInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopICD10CMInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StopICD10CMInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops a protected health information (PHI) detection job in progress. *
* * @param stopPHIDetectionJobRequest * @return A Java Future containing the result of the StopPHIDetectionJob operation returned by the service. * @sample AWSComprehendMedicalAsync.StopPHIDetectionJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops a protected health information (PHI) detection job in progress. *
* * @param stopPHIDetectionJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopPHIDetectionJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StopPHIDetectionJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferRxNorm inference job in progress. *
* * @param stopRxNormInferenceJobRequest * @return A Java Future containing the result of the StopRxNormInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.StopRxNormInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferRxNorm inference job in progress. *
* * @param stopRxNormInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopRxNormInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StopRxNormInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferSNOMEDCT inference job in progress. *
* * @param stopSNOMEDCTInferenceJobRequest * @return A Java Future containing the result of the StopSNOMEDCTInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsync.StopSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Stops an InferSNOMEDCT inference job in progress. *
* * @param stopSNOMEDCTInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopSNOMEDCTInferenceJob operation returned by the service. * @sample AWSComprehendMedicalAsyncHandler.StopSNOMEDCTInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future