Interface ComprehendMedicalAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aComprehendMedicalAsyncClient
.static ComprehendMedicalAsyncClient
create()
Create aComprehendMedicalAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.describeEntitiesDetectionV2Job
(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job.describeEntitiesDetectionV2Job
(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job.describeICD10CMInferenceJob
(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest) Gets the properties associated with an InferICD10CM job.describeICD10CMInferenceJob
(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest) Gets the properties associated with an InferICD10CM job.describePHIDetectionJob
(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job.describePHIDetectionJob
(DescribePhiDetectionJobRequest describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job.describeRxNormInferenceJob
(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest) Gets the properties associated with an InferRxNorm job.describeRxNormInferenceJob
(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest) Gets the properties associated with an InferRxNorm job.describeSNOMEDCTInferenceJob
(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest) Gets the properties associated with an InferSNOMEDCT job.describeSNOMEDCTInferenceJob
(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest) Gets the properties associated with an InferSNOMEDCT job.default CompletableFuture
<DetectEntitiesResponse> detectEntities
(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.default CompletableFuture
<DetectEntitiesResponse> detectEntities
(DetectEntitiesRequest detectEntitiesRequest) Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.detectEntitiesV2
(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request) 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.detectEntitiesV2
(DetectEntitiesV2Request detectEntitiesV2Request) 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.default CompletableFuture
<DetectPhiResponse> detectPHI
(Consumer<DetectPhiRequest.Builder> detectPhiRequest) Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.default CompletableFuture
<DetectPhiResponse> detectPHI
(DetectPhiRequest detectPhiRequest) Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.default CompletableFuture
<InferIcd10CmResponse> inferICD10CM
(Consumer<InferIcd10CmRequest.Builder> inferIcd10CmRequest) 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.default CompletableFuture
<InferIcd10CmResponse> inferICD10CM
(InferIcd10CmRequest inferIcd10CmRequest) 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.default CompletableFuture
<InferRxNormResponse> inferRxNorm
(Consumer<InferRxNormRequest.Builder> inferRxNormRequest) 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.default CompletableFuture
<InferRxNormResponse> inferRxNorm
(InferRxNormRequest inferRxNormRequest) 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.default CompletableFuture
<InferSnomedctResponse> inferSNOMEDCT
(Consumer<InferSnomedctRequest.Builder> inferSnomedctRequest) InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontologydefault CompletableFuture
<InferSnomedctResponse> inferSNOMEDCT
(InferSnomedctRequest inferSnomedctRequest) InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontologylistEntitiesDetectionV2Jobs
(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.listEntitiesDetectionV2Jobs
(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.listICD10CMInferenceJobs
(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest) Gets a list of InferICD10CM jobs that you have submitted.listICD10CMInferenceJobs
(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest) Gets a list of InferICD10CM jobs that you have submitted.listPHIDetectionJobs
(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs you have submitted.listPHIDetectionJobs
(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs you have submitted.listRxNormInferenceJobs
(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest) Gets a list of InferRxNorm jobs that you have submitted.listRxNormInferenceJobs
(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest) Gets a list of InferRxNorm jobs that you have submitted.listSNOMEDCTInferenceJobs
(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest) Gets a list of InferSNOMEDCT jobs a user has submitted.listSNOMEDCTInferenceJobs
(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest) Gets a list of InferSNOMEDCT jobs a user has submitted.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartEntitiesDetectionV2Job
(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents.startEntitiesDetectionV2Job
(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents.startICD10CMInferenceJob
(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest) Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.startICD10CMInferenceJob
(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest) Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.startPHIDetectionJob
(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI).startPHIDetectionJob
(StartPhiDetectionJobRequest startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI).startRxNormInferenceJob
(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest) Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.startRxNormInferenceJob
(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest) Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.startSNOMEDCTInferenceJob
(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest) Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.startSNOMEDCTInferenceJob
(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest) Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.stopEntitiesDetectionV2Job
(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.stopEntitiesDetectionV2Job
(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.stopICD10CMInferenceJob
(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest) Stops an InferICD10CM inference job in progress.stopICD10CMInferenceJob
(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest) Stops an InferICD10CM inference job in progress.stopPHIDetectionJob
(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.stopPHIDetectionJob
(StopPhiDetectionJobRequest stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.stopRxNormInferenceJob
(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest) Stops an InferRxNorm inference job in progress.stopRxNormInferenceJob
(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest) Stops an InferRxNorm inference job in progress.stopSNOMEDCTInferenceJob
(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest) Stops an InferSNOMEDCT inference job in progress.stopSNOMEDCTInferenceJob
(StopSnomedctInferenceJobRequest stopSnomedctInferenceJobRequest) Stops an InferSNOMEDCT inference job in progress.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
describeEntitiesDetectionV2Job
default CompletableFuture<DescribeEntitiesDetectionV2JobResponse> describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
- Parameters:
describeEntitiesDetectionV2JobRequest
-- Returns:
- A Java Future containing the result of the DescribeEntitiesDetectionV2Job operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEntitiesDetectionV2Job
default CompletableFuture<DescribeEntitiesDetectionV2JobResponse> describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribeEntitiesDetectionV2JobRequest.Builder
avoiding the need to create one manually viaDescribeEntitiesDetectionV2JobRequest.builder()
- Parameters:
describeEntitiesDetectionV2JobRequest
- AConsumer
that will call methods onDescribeEntitiesDetectionV2JobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEntitiesDetectionV2Job operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeICD10CMInferenceJob
default CompletableFuture<DescribeIcd10CmInferenceJobResponse> describeICD10CMInferenceJob(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest) Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
- Parameters:
describeIcd10CmInferenceJobRequest
-- Returns:
- A Java Future containing the result of the DescribeICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeICD10CMInferenceJob
default CompletableFuture<DescribeIcd10CmInferenceJobResponse> describeICD10CMInferenceJob(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest) Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeIcd10CmInferenceJobRequest.Builder
avoiding the need to create one manually viaDescribeIcd10CmInferenceJobRequest.builder()
- Parameters:
describeIcd10CmInferenceJobRequest
- AConsumer
that will call methods onDescribeIcd10CmInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePHIDetectionJob
default CompletableFuture<DescribePhiDetectionJobResponse> describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
- Parameters:
describePhiDetectionJobRequest
-- Returns:
- A Java Future containing the result of the DescribePHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePHIDetectionJob
default CompletableFuture<DescribePhiDetectionJobResponse> describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the
DescribePhiDetectionJobRequest.Builder
avoiding the need to create one manually viaDescribePhiDetectionJobRequest.builder()
- Parameters:
describePhiDetectionJobRequest
- AConsumer
that will call methods onDescribePhiDetectionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRxNormInferenceJob
default CompletableFuture<DescribeRxNormInferenceJobResponse> describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest) Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
- Parameters:
describeRxNormInferenceJobRequest
-- Returns:
- A Java Future containing the result of the DescribeRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRxNormInferenceJob
default CompletableFuture<DescribeRxNormInferenceJobResponse> describeRxNormInferenceJob(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest) Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeRxNormInferenceJobRequest.Builder
avoiding the need to create one manually viaDescribeRxNormInferenceJobRequest.builder()
- Parameters:
describeRxNormInferenceJobRequest
- AConsumer
that will call methods onDescribeRxNormInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSNOMEDCTInferenceJob
default CompletableFuture<DescribeSnomedctInferenceJobResponse> describeSNOMEDCTInferenceJob(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest) Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
- Parameters:
describeSnomedctInferenceJobRequest
-- Returns:
- A Java Future containing the result of the DescribeSNOMEDCTInferenceJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSNOMEDCTInferenceJob
default CompletableFuture<DescribeSnomedctInferenceJobResponse> describeSNOMEDCTInferenceJob(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest) Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeSnomedctInferenceJobRequest.Builder
avoiding the need to create one manually viaDescribeSnomedctInferenceJobRequest.builder()
- Parameters:
describeSnomedctInferenceJobRequest
- AConsumer
that will call methods onDescribeSnomedctInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSNOMEDCTInferenceJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectEntities
@Deprecated default CompletableFuture<DetectEntitiesResponse> detectEntities(DetectEntitiesRequest detectEntitiesRequest) Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.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.
- Parameters:
detectEntitiesRequest
-- Returns:
- A Java Future containing the result of the DetectEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectEntities
@Deprecated default CompletableFuture<DetectEntitiesResponse> detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.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.
This is a convenience which creates an instance of the
DetectEntitiesRequest.Builder
avoiding the need to create one manually viaDetectEntitiesRequest.builder()
- Parameters:
detectEntitiesRequest
- AConsumer
that will call methods onDetectEntitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectEntitiesV2
default CompletableFuture<DetectEntitiesV2Response> detectEntitiesV2(DetectEntitiesV2Request detectEntitiesV2Request) 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 theDetectEntitiesV2
operation in all new applications.The
DetectEntitiesV2
operation returns theAcuity
andDirection
entities as attributes instead of types.- Parameters:
detectEntitiesV2Request
-- Returns:
- A Java Future containing the result of the DetectEntitiesV2 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectEntitiesV2
default CompletableFuture<DetectEntitiesV2Response> detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request) 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 theDetectEntitiesV2
operation in all new applications.The
DetectEntitiesV2
operation returns theAcuity
andDirection
entities as attributes instead of types.
This is a convenience which creates an instance of the
DetectEntitiesV2Request.Builder
avoiding the need to create one manually viaDetectEntitiesV2Request.builder()
- Parameters:
detectEntitiesV2Request
- AConsumer
that will call methods onDetectEntitiesV2Request.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectEntitiesV2 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectPHI
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.
- Parameters:
detectPhiRequest
-- Returns:
- A Java Future containing the result of the DetectPHI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detectPHI
default CompletableFuture<DetectPhiResponse> detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest) 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.
This is a convenience which creates an instance of the
DetectPhiRequest.Builder
avoiding the need to create one manually viaDetectPhiRequest.builder()
- Parameters:
detectPhiRequest
- AConsumer
that will call methods onDetectPhiRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectPHI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferICD10CM
default CompletableFuture<InferIcd10CmResponse> inferICD10CM(InferIcd10CmRequest inferIcd10CmRequest) 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.
- Parameters:
inferIcd10CmRequest
-- Returns:
- A Java Future containing the result of the InferICD10CM operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferICD10CM
default CompletableFuture<InferIcd10CmResponse> inferICD10CM(Consumer<InferIcd10CmRequest.Builder> inferIcd10CmRequest) 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.
This is a convenience which creates an instance of the
InferIcd10CmRequest.Builder
avoiding the need to create one manually viaInferIcd10CmRequest.builder()
- Parameters:
inferIcd10CmRequest
- AConsumer
that will call methods onInferIcd10CmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InferICD10CM operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferRxNorm
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.
- Parameters:
inferRxNormRequest
-- Returns:
- A Java Future containing the result of the InferRxNorm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferRxNorm
default CompletableFuture<InferRxNormResponse> inferRxNorm(Consumer<InferRxNormRequest.Builder> inferRxNormRequest) 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.
This is a convenience which creates an instance of the
InferRxNormRequest.Builder
avoiding the need to create one manually viaInferRxNormRequest.builder()
- Parameters:
inferRxNormRequest
- AConsumer
that will call methods onInferRxNormRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InferRxNorm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferSNOMEDCT
default CompletableFuture<InferSnomedctResponse> inferSNOMEDCT(InferSnomedctRequest inferSnomedctRequest) InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
- Parameters:
inferSnomedctRequest
-- Returns:
- A Java Future containing the result of the InferSNOMEDCT operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
inferSNOMEDCT
default CompletableFuture<InferSnomedctResponse> inferSNOMEDCT(Consumer<InferSnomedctRequest.Builder> inferSnomedctRequest) InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
This is a convenience which creates an instance of the
InferSnomedctRequest.Builder
avoiding the need to create one manually viaInferSnomedctRequest.builder()
- Parameters:
inferSnomedctRequest
- AConsumer
that will call methods onInferSnomedctRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InferSNOMEDCT operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal server error occurred. Retry your request.
- ServiceUnavailableException The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
- 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.
- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEntitiesDetectionV2Jobs
default CompletableFuture<ListEntitiesDetectionV2JobsResponse> listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.
- Parameters:
listEntitiesDetectionV2JobsRequest
-- Returns:
- A Java Future containing the result of the ListEntitiesDetectionV2Jobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEntitiesDetectionV2Jobs
default CompletableFuture<ListEntitiesDetectionV2JobsResponse> listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.
This is a convenience which creates an instance of the
ListEntitiesDetectionV2JobsRequest.Builder
avoiding the need to create one manually viaListEntitiesDetectionV2JobsRequest.builder()
- Parameters:
listEntitiesDetectionV2JobsRequest
- AConsumer
that will call methods onListEntitiesDetectionV2JobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEntitiesDetectionV2Jobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listICD10CMInferenceJobs
default CompletableFuture<ListIcd10CmInferenceJobsResponse> listICD10CMInferenceJobs(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest) Gets a list of InferICD10CM jobs that you have submitted.
- Parameters:
listIcd10CmInferenceJobsRequest
-- Returns:
- A Java Future containing the result of the ListICD10CMInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listICD10CMInferenceJobs
default CompletableFuture<ListIcd10CmInferenceJobsResponse> listICD10CMInferenceJobs(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest) Gets a list of InferICD10CM jobs that you have submitted.
This is a convenience which creates an instance of the
ListIcd10CmInferenceJobsRequest.Builder
avoiding the need to create one manually viaListIcd10CmInferenceJobsRequest.builder()
- Parameters:
listIcd10CmInferenceJobsRequest
- AConsumer
that will call methods onListIcd10CmInferenceJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListICD10CMInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPHIDetectionJobs
default CompletableFuture<ListPhiDetectionJobsResponse> listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs you have submitted.
- Parameters:
listPhiDetectionJobsRequest
-- Returns:
- A Java Future containing the result of the ListPHIDetectionJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPHIDetectionJobs
default CompletableFuture<ListPhiDetectionJobsResponse> listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs you have submitted.
This is a convenience which creates an instance of the
ListPhiDetectionJobsRequest.Builder
avoiding the need to create one manually viaListPhiDetectionJobsRequest.builder()
- Parameters:
listPhiDetectionJobsRequest
- AConsumer
that will call methods onListPhiDetectionJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPHIDetectionJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRxNormInferenceJobs
default CompletableFuture<ListRxNormInferenceJobsResponse> listRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest) Gets a list of InferRxNorm jobs that you have submitted.
- Parameters:
listRxNormInferenceJobsRequest
-- Returns:
- A Java Future containing the result of the ListRxNormInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRxNormInferenceJobs
default CompletableFuture<ListRxNormInferenceJobsResponse> listRxNormInferenceJobs(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest) Gets a list of InferRxNorm jobs that you have submitted.
This is a convenience which creates an instance of the
ListRxNormInferenceJobsRequest.Builder
avoiding the need to create one manually viaListRxNormInferenceJobsRequest.builder()
- Parameters:
listRxNormInferenceJobsRequest
- AConsumer
that will call methods onListRxNormInferenceJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRxNormInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSNOMEDCTInferenceJobs
default CompletableFuture<ListSnomedctInferenceJobsResponse> listSNOMEDCTInferenceJobs(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest) Gets a list of InferSNOMEDCT jobs a user has submitted.
- Parameters:
listSnomedctInferenceJobsRequest
-- Returns:
- A Java Future containing the result of the ListSNOMEDCTInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSNOMEDCTInferenceJobs
default CompletableFuture<ListSnomedctInferenceJobsResponse> listSNOMEDCTInferenceJobs(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest) Gets a list of InferSNOMEDCT jobs a user has submitted.
This is a convenience which creates an instance of the
ListSnomedctInferenceJobsRequest.Builder
avoiding the need to create one manually viaListSnomedctInferenceJobsRequest.builder()
- Parameters:
listSnomedctInferenceJobsRequest
- AConsumer
that will call methods onListSnomedctInferenceJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSNOMEDCTInferenceJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ValidationException The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEntitiesDetectionV2Job
default CompletableFuture<StartEntitiesDetectionV2JobResponse> startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents. Use the
DescribeEntitiesDetectionV2Job
operation to track the status of a job.- Parameters:
startEntitiesDetectionV2JobRequest
-- Returns:
- A Java Future containing the result of the StartEntitiesDetectionV2Job operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEntitiesDetectionV2Job
default CompletableFuture<StartEntitiesDetectionV2JobResponse> startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents. Use the
DescribeEntitiesDetectionV2Job
operation to track the status of a job.
This is a convenience which creates an instance of the
StartEntitiesDetectionV2JobRequest.Builder
avoiding the need to create one manually viaStartEntitiesDetectionV2JobRequest.builder()
- Parameters:
startEntitiesDetectionV2JobRequest
- AConsumer
that will call methods onStartEntitiesDetectionV2JobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartEntitiesDetectionV2Job operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startICD10CMInferenceJob
default CompletableFuture<StartIcd10CmInferenceJobResponse> startICD10CMInferenceJob(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest) 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.- Parameters:
startIcd10CmInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StartICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startICD10CMInferenceJob
default CompletableFuture<StartIcd10CmInferenceJobResponse> startICD10CMInferenceJob(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest) 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.
This is a convenience which creates an instance of the
StartIcd10CmInferenceJobRequest.Builder
avoiding the need to create one manually viaStartIcd10CmInferenceJobRequest.builder()
- Parameters:
startIcd10CmInferenceJobRequest
- AConsumer
that will call methods onStartIcd10CmInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPHIDetectionJob
default CompletableFuture<StartPhiDetectionJobResponse> startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob
operation to track the status of a job.- Parameters:
startPhiDetectionJobRequest
-- Returns:
- A Java Future containing the result of the StartPHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPHIDetectionJob
default CompletableFuture<StartPhiDetectionJobResponse> startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob
operation to track the status of a job.
This is a convenience which creates an instance of the
StartPhiDetectionJobRequest.Builder
avoiding the need to create one manually viaStartPhiDetectionJobRequest.builder()
- Parameters:
startPhiDetectionJobRequest
- AConsumer
that will call methods onStartPhiDetectionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartPHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startRxNormInferenceJob
default CompletableFuture<StartRxNormInferenceJobResponse> startRxNormInferenceJob(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest) 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.- Parameters:
startRxNormInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StartRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startRxNormInferenceJob
default CompletableFuture<StartRxNormInferenceJobResponse> startRxNormInferenceJob(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest) 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.
This is a convenience which creates an instance of the
StartRxNormInferenceJobRequest.Builder
avoiding the need to create one manually viaStartRxNormInferenceJobRequest.builder()
- Parameters:
startRxNormInferenceJobRequest
- AConsumer
that will call methods onStartRxNormInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSNOMEDCTInferenceJob
default CompletableFuture<StartSnomedctInferenceJobResponse> startSNOMEDCTInferenceJob(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest) 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.
- Parameters:
startSnomedctInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StartSNOMEDCTInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSNOMEDCTInferenceJob
default CompletableFuture<StartSnomedctInferenceJobResponse> startSNOMEDCTInferenceJob(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest) 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.
This is a convenience which creates an instance of the
StartSnomedctInferenceJobRequest.Builder
avoiding the need to create one manually viaStartSnomedctInferenceJobRequest.builder()
- Parameters:
startSnomedctInferenceJobRequest
- AConsumer
that will call methods onStartSnomedctInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSNOMEDCTInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- 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.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEntitiesDetectionV2Job
default CompletableFuture<StopEntitiesDetectionV2JobResponse> stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.
- Parameters:
stopEntitiesDetectionV2JobRequest
-- Returns:
- A Java Future containing the result of the StopEntitiesDetectionV2Job operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEntitiesDetectionV2Job
default CompletableFuture<StopEntitiesDetectionV2JobResponse> stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.
This is a convenience which creates an instance of the
StopEntitiesDetectionV2JobRequest.Builder
avoiding the need to create one manually viaStopEntitiesDetectionV2JobRequest.builder()
- Parameters:
stopEntitiesDetectionV2JobRequest
- AConsumer
that will call methods onStopEntitiesDetectionV2JobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopEntitiesDetectionV2Job operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopICD10CMInferenceJob
default CompletableFuture<StopIcd10CmInferenceJobResponse> stopICD10CMInferenceJob(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest) Stops an InferICD10CM inference job in progress.
- Parameters:
stopIcd10CmInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StopICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopICD10CMInferenceJob
default CompletableFuture<StopIcd10CmInferenceJobResponse> stopICD10CMInferenceJob(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest) Stops an InferICD10CM inference job in progress.
This is a convenience which creates an instance of the
StopIcd10CmInferenceJobRequest.Builder
avoiding the need to create one manually viaStopIcd10CmInferenceJobRequest.builder()
- Parameters:
stopIcd10CmInferenceJobRequest
- AConsumer
that will call methods onStopIcd10CmInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopICD10CMInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopPHIDetectionJob
default CompletableFuture<StopPhiDetectionJobResponse> stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.
- Parameters:
stopPhiDetectionJobRequest
-- Returns:
- A Java Future containing the result of the StopPHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopPHIDetectionJob
default CompletableFuture<StopPhiDetectionJobResponse> stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.
This is a convenience which creates an instance of the
StopPhiDetectionJobRequest.Builder
avoiding the need to create one manually viaStopPhiDetectionJobRequest.builder()
- Parameters:
stopPhiDetectionJobRequest
- AConsumer
that will call methods onStopPhiDetectionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopPHIDetectionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopRxNormInferenceJob
default CompletableFuture<StopRxNormInferenceJobResponse> stopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest) Stops an InferRxNorm inference job in progress.
- Parameters:
stopRxNormInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StopRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopRxNormInferenceJob
default CompletableFuture<StopRxNormInferenceJobResponse> stopRxNormInferenceJob(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest) Stops an InferRxNorm inference job in progress.
This is a convenience which creates an instance of the
StopRxNormInferenceJobRequest.Builder
avoiding the need to create one manually viaStopRxNormInferenceJobRequest.builder()
- Parameters:
stopRxNormInferenceJobRequest
- AConsumer
that will call methods onStopRxNormInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopRxNormInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopSNOMEDCTInferenceJob
default CompletableFuture<StopSnomedctInferenceJobResponse> stopSNOMEDCTInferenceJob(StopSnomedctInferenceJobRequest stopSnomedctInferenceJobRequest) Stops an InferSNOMEDCT inference job in progress.
- Parameters:
stopSnomedctInferenceJobRequest
-- Returns:
- A Java Future containing the result of the StopSNOMEDCTInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopSNOMEDCTInferenceJob
default CompletableFuture<StopSnomedctInferenceJobResponse> stopSNOMEDCTInferenceJob(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest) Stops an InferSNOMEDCT inference job in progress.
This is a convenience which creates an instance of the
StopSnomedctInferenceJobRequest.Builder
avoiding the need to create one manually viaStopSnomedctInferenceJobRequest.builder()
- Parameters:
stopSnomedctInferenceJobRequest
- AConsumer
that will call methods onStopSnomedctInferenceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopSNOMEDCTInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
- ResourceNotFoundException The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
- 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.
- InternalServerException An internal server error occurred. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aComprehendMedicalAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aComprehendMedicalAsyncClient
.
-