Interface ComprehendMedicalClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ComprehendMedicalClient
extends AwsClient

Service client for accessing ComprehendMedical. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ComprehendMedicalClientBuilder	builder()	Create a builder that can be used to configure and create a ComprehendMedicalClient.
static ComprehendMedicalClient	create()	Create a ComprehendMedicalClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeEntitiesDetectionV2JobResponse	describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)	Gets the properties associated with a medical entities detection job.
default DescribeEntitiesDetectionV2JobResponse	describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)	Gets the properties associated with a medical entities detection job.
default DescribeIcd10CmInferenceJobResponse	describeICD10CMInferenceJob(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest)	Gets the properties associated with an InferICD10CM job.
default DescribeIcd10CmInferenceJobResponse	describeICD10CMInferenceJob(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest)	Gets the properties associated with an InferICD10CM job.
default DescribePhiDetectionJobResponse	describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)	Gets the properties associated with a protected health information (PHI) detection job.
default DescribePhiDetectionJobResponse	describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)	Gets the properties associated with a protected health information (PHI) detection job.
default DescribeRxNormInferenceJobResponse	describeRxNormInferenceJob(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest)	Gets the properties associated with an InferRxNorm job.
default DescribeRxNormInferenceJobResponse	describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest)	Gets the properties associated with an InferRxNorm job.
default DescribeSnomedctInferenceJobResponse	describeSNOMEDCTInferenceJob(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest)	Gets the properties associated with an InferSNOMEDCT job.
default DescribeSnomedctInferenceJobResponse	describeSNOMEDCTInferenceJob(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest)	Gets the properties associated with an InferSNOMEDCT job.
default DetectEntitiesResponse	detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)	Deprecated. This operation is deprecated, use DetectEntitiesV2 instead.
default DetectEntitiesResponse	detectEntities(DetectEntitiesRequest detectEntitiesRequest)	Deprecated. This operation is deprecated, use DetectEntitiesV2 instead.
default 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.
default 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.
default 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 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 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 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 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 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 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
default 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
default ListEntitiesDetectionV2JobsResponse	listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)	Gets a list of medical entity detection jobs that you have submitted.
default ListEntitiesDetectionV2JobsResponse	listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)	Gets a list of medical entity detection jobs that you have submitted.
default ListIcd10CmInferenceJobsResponse	listICD10CMInferenceJobs(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest)	Gets a list of InferICD10CM jobs that you have submitted.
default ListIcd10CmInferenceJobsResponse	listICD10CMInferenceJobs(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest)	Gets a list of InferICD10CM jobs that you have submitted.
default ListPhiDetectionJobsResponse	listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)	Gets a list of protected health information (PHI) detection jobs you have submitted.
default ListPhiDetectionJobsResponse	listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)	Gets a list of protected health information (PHI) detection jobs you have submitted.
default ListRxNormInferenceJobsResponse	listRxNormInferenceJobs(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest)	Gets a list of InferRxNorm jobs that you have submitted.
default ListRxNormInferenceJobsResponse	listRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest)	Gets a list of InferRxNorm jobs that you have submitted.
default ListSnomedctInferenceJobsResponse	listSNOMEDCTInferenceJobs(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest)	Gets a list of InferSNOMEDCT jobs a user has submitted.
default ListSnomedctInferenceJobsResponse	listSNOMEDCTInferenceJobs(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest)	Gets a list of InferSNOMEDCT jobs a user has submitted.
default ComprehendMedicalServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartEntitiesDetectionV2JobResponse	startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)	Starts an asynchronous medical entity detection job for a collection of documents.
default StartEntitiesDetectionV2JobResponse	startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)	Starts an asynchronous medical entity detection job for a collection of documents.
default StartIcd10CmInferenceJobResponse	startICD10CMInferenceJob(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest)	Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
default StartIcd10CmInferenceJobResponse	startICD10CMInferenceJob(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest)	Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
default StartPhiDetectionJobResponse	startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)	Starts an asynchronous job to detect protected health information (PHI).
default StartPhiDetectionJobResponse	startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)	Starts an asynchronous job to detect protected health information (PHI).
default StartRxNormInferenceJobResponse	startRxNormInferenceJob(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest)	Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
default StartRxNormInferenceJobResponse	startRxNormInferenceJob(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest)	Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
default StartSnomedctInferenceJobResponse	startSNOMEDCTInferenceJob(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest)	Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.
default StartSnomedctInferenceJobResponse	startSNOMEDCTInferenceJob(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest)	Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.
default StopEntitiesDetectionV2JobResponse	stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)	Stops a medical entities detection job in progress.
default StopEntitiesDetectionV2JobResponse	stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)	Stops a medical entities detection job in progress.
default StopIcd10CmInferenceJobResponse	stopICD10CMInferenceJob(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest)	Stops an InferICD10CM inference job in progress.
default StopIcd10CmInferenceJobResponse	stopICD10CMInferenceJob(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest)	Stops an InferICD10CM inference job in progress.
default StopPhiDetectionJobResponse	stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)	Stops a protected health information (PHI) detection job in progress.
default StopPhiDetectionJobResponse	stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)	Stops a protected health information (PHI) detection job in progress.
default StopRxNormInferenceJobResponse	stopRxNormInferenceJob(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest)	Stops an InferRxNorm inference job in progress.
default StopRxNormInferenceJobResponse	stopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest)	Stops an InferRxNorm inference job in progress.
default StopSnomedctInferenceJobResponse	stopSNOMEDCTInferenceJob(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest)	Stops an InferSNOMEDCT inference job in progress.
default StopSnomedctInferenceJobResponse	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

describeEntitiesDetectionV2Job

default DescribeEntitiesDetectionV2JobResponse describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)
                                                                       throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

Parameters:

describeEntitiesDetectionV2JobRequest -

Returns:

Result of the DescribeEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

describeEntitiesDetectionV2Job

default DescribeEntitiesDetectionV2JobResponse describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)
                                                                       throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DescribeEntitiesDetectionV2JobRequest.builder()

Parameters:

describeEntitiesDetectionV2JobRequest - A Consumer that will call methods on DescribeEntitiesDetectionV2JobRequest.Builder to create a request.

Returns:

Result of the DescribeEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

describeICD10CMInferenceJob

default DescribeIcd10CmInferenceJobResponse describeICD10CMInferenceJob(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest)
                                                                 throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

Parameters:

describeIcd10CmInferenceJobRequest -

Returns:

Result of the DescribeICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

describeICD10CMInferenceJob

default DescribeIcd10CmInferenceJobResponse describeICD10CMInferenceJob(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest)
                                                                 throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DescribeIcd10CmInferenceJobRequest.builder()

Parameters:

describeIcd10CmInferenceJobRequest - A Consumer that will call methods on DescribeIcd10CmInferenceJobRequest.Builder to create a request.

Returns:

Result of the DescribeICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

describePHIDetectionJob

default DescribePhiDetectionJobResponse describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)
                                                         throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the DescribePHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

describePHIDetectionJob

default DescribePhiDetectionJobResponse describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)
                                                         throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DescribePhiDetectionJobRequest.builder()

Parameters:

describePhiDetectionJobRequest - A Consumer that will call methods on DescribePhiDetectionJobRequest.Builder to create a request.

Returns:

Result of the DescribePHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

describeRxNormInferenceJob

default DescribeRxNormInferenceJobResponse describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest)
                                                               throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

Parameters:

describeRxNormInferenceJobRequest -

Returns:

Result of the DescribeRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

describeRxNormInferenceJob

default DescribeRxNormInferenceJobResponse describeRxNormInferenceJob(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest)
                                                               throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DescribeRxNormInferenceJobRequest.builder()

Parameters:

describeRxNormInferenceJobRequest - A Consumer that will call methods on DescribeRxNormInferenceJobRequest.Builder to create a request.

Returns:

Result of the DescribeRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

describeSNOMEDCTInferenceJob

default DescribeSnomedctInferenceJobResponse describeSNOMEDCTInferenceJob(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest)
                                                                   throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.

Parameters:

describeSnomedctInferenceJobRequest -

Returns:

Result of the DescribeSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

describeSNOMEDCTInferenceJob

default DescribeSnomedctInferenceJobResponse describeSNOMEDCTInferenceJob(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest)
                                                                   throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DescribeSnomedctInferenceJobRequest.builder()

Parameters:

describeSnomedctInferenceJobRequest - A Consumer that will call methods on DescribeSnomedctInferenceJobRequest.Builder to create a request.

Returns:

Result of the DescribeSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

detectEntities

@Deprecated
default DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest)
                                       throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the DetectEntities operation returned by the service.

See Also:

• AWS API Documentation

detectEntities

@Deprecated
default DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)
                                       throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DetectEntitiesRequest.builder()

Parameters:

detectEntitiesRequest - A Consumer that will call methods on DetectEntitiesRequest.Builder to create a request.

Returns:

Result of the DetectEntities operation returned by the service.

See Also:

• AWS API Documentation

detectEntitiesV2

default DetectEntitiesV2Response detectEntitiesV2(DetectEntitiesV2Request detectEntitiesV2Request)
                                           throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

Parameters:

detectEntitiesV2Request -

Returns:

Result of the DetectEntitiesV2 operation returned by the service.

See Also:

• AWS API Documentation

detectEntitiesV2

default DetectEntitiesV2Response detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request)
                                           throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

This is a convenience which creates an instance of the DetectEntitiesV2Request.Builder avoiding the need to create one manually via DetectEntitiesV2Request.builder()

Parameters:

detectEntitiesV2Request - A Consumer that will call methods on DetectEntitiesV2Request.Builder to create a request.

Returns:

Result of the DetectEntitiesV2 operation returned by the service.

See Also:

• AWS API Documentation

detectPHI

default DetectPhiResponse detectPHI(DetectPhiRequest detectPhiRequest)
                             throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the DetectPHI operation returned by the service.

See Also:

• AWS API Documentation

detectPHI

default DetectPhiResponse detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest)
                             throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via DetectPhiRequest.builder()

Parameters:

detectPhiRequest - A Consumer that will call methods on DetectPhiRequest.Builder to create a request.

Returns:

Result of the DetectPHI operation returned by the service.

See Also:

• AWS API Documentation

inferICD10CM

default InferIcd10CmResponse inferICD10CM(InferIcd10CmRequest inferIcd10CmRequest)
                                   throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the InferICD10CM operation returned by the service.

See Also:

• AWS API Documentation

inferICD10CM

default InferIcd10CmResponse inferICD10CM(Consumer<InferIcd10CmRequest.Builder> inferIcd10CmRequest)
                                   throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via InferIcd10CmRequest.builder()

Parameters:

inferIcd10CmRequest - A Consumer that will call methods on InferIcd10CmRequest.Builder to create a request.

Returns:

Result of the InferICD10CM operation returned by the service.

See Also:

• AWS API Documentation

inferRxNorm

default InferRxNormResponse inferRxNorm(InferRxNormRequest inferRxNormRequest)
                                 throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the InferRxNorm operation returned by the service.

See Also:

• AWS API Documentation

inferRxNorm

default InferRxNormResponse inferRxNorm(Consumer<InferRxNormRequest.Builder> inferRxNormRequest)
                                 throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via InferRxNormRequest.builder()

Parameters:

inferRxNormRequest - A Consumer that will call methods on InferRxNormRequest.Builder to create a request.

Returns:

Result of the InferRxNorm operation returned by the service.

See Also:

• AWS API Documentation

inferSNOMEDCT

default InferSnomedctResponse inferSNOMEDCT(InferSnomedctRequest inferSnomedctRequest)
                                     throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the InferSNOMEDCT operation returned by the service.

See Also:

• AWS API Documentation

inferSNOMEDCT

default InferSnomedctResponse inferSNOMEDCT(Consumer<InferSnomedctRequest.Builder> inferSnomedctRequest)
                                     throws InternalServerException,
ServiceUnavailableException,
TooManyRequestsException,
InvalidRequestException,
InvalidEncodingException,
TextSizeLimitExceededException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via InferSnomedctRequest.builder()

Parameters:

inferSnomedctRequest - A Consumer that will call methods on InferSnomedctRequest.Builder to create a request.

Returns:

Result of the InferSNOMEDCT operation returned by the service.

See Also:

• AWS API Documentation

listEntitiesDetectionV2Jobs

default ListEntitiesDetectionV2JobsResponse listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)
                                                                 throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets a list of medical entity detection jobs that you have submitted.

Parameters:

listEntitiesDetectionV2JobsRequest -

Returns:

Result of the ListEntitiesDetectionV2Jobs operation returned by the service.

See Also:

• AWS API Documentation

listEntitiesDetectionV2Jobs

default ListEntitiesDetectionV2JobsResponse listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)
                                                                 throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via ListEntitiesDetectionV2JobsRequest.builder()

Parameters:

listEntitiesDetectionV2JobsRequest - A Consumer that will call methods on ListEntitiesDetectionV2JobsRequest.Builder to create a request.

Returns:

Result of the ListEntitiesDetectionV2Jobs operation returned by the service.

See Also:

• AWS API Documentation

listICD10CMInferenceJobs

default ListIcd10CmInferenceJobsResponse listICD10CMInferenceJobs(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest)
                                                           throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets a list of InferICD10CM jobs that you have submitted.

Parameters:

listIcd10CmInferenceJobsRequest -

Returns:

Result of the ListICD10CMInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

listICD10CMInferenceJobs

default ListIcd10CmInferenceJobsResponse listICD10CMInferenceJobs(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest)
                                                           throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via ListIcd10CmInferenceJobsRequest.builder()

Parameters:

listIcd10CmInferenceJobsRequest - A Consumer that will call methods on ListIcd10CmInferenceJobsRequest.Builder to create a request.

Returns:

Result of the ListICD10CMInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

listPHIDetectionJobs

default ListPhiDetectionJobsResponse listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)
                                                   throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets a list of protected health information (PHI) detection jobs you have submitted.

Parameters:

listPhiDetectionJobsRequest -

Returns:

Result of the ListPHIDetectionJobs operation returned by the service.

See Also:

• AWS API Documentation

listPHIDetectionJobs

default ListPhiDetectionJobsResponse listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)
                                                   throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via ListPhiDetectionJobsRequest.builder()

Parameters:

listPhiDetectionJobsRequest - A Consumer that will call methods on ListPhiDetectionJobsRequest.Builder to create a request.

Returns:

Result of the ListPHIDetectionJobs operation returned by the service.

See Also:

• AWS API Documentation

listRxNormInferenceJobs

default ListRxNormInferenceJobsResponse listRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest)
                                                         throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets a list of InferRxNorm jobs that you have submitted.

Parameters:

listRxNormInferenceJobsRequest -

Returns:

Result of the ListRxNormInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

listRxNormInferenceJobs

default ListRxNormInferenceJobsResponse listRxNormInferenceJobs(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest)
                                                         throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via ListRxNormInferenceJobsRequest.builder()

Parameters:

listRxNormInferenceJobsRequest - A Consumer that will call methods on ListRxNormInferenceJobsRequest.Builder to create a request.

Returns:

Result of the ListRxNormInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

listSNOMEDCTInferenceJobs

default ListSnomedctInferenceJobsResponse listSNOMEDCTInferenceJobs(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest)
                                                             throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Gets a list of InferSNOMEDCT jobs a user has submitted.

Parameters:

listSnomedctInferenceJobsRequest -

Returns:

Result of the ListSNOMEDCTInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

listSNOMEDCTInferenceJobs

default ListSnomedctInferenceJobsResponse listSNOMEDCTInferenceJobs(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest)
                                                             throws InvalidRequestException,
ValidationException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via ListSnomedctInferenceJobsRequest.builder()

Parameters:

listSnomedctInferenceJobsRequest - A Consumer that will call methods on ListSnomedctInferenceJobsRequest.Builder to create a request.

Returns:

Result of the ListSNOMEDCTInferenceJobs operation returned by the service.

See Also:

• AWS API Documentation

startEntitiesDetectionV2Job

default StartEntitiesDetectionV2JobResponse startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)
                                                                 throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the StartEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

startEntitiesDetectionV2Job

default StartEntitiesDetectionV2JobResponse startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)
                                                                 throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StartEntitiesDetectionV2JobRequest.builder()

Parameters:

startEntitiesDetectionV2JobRequest - A Consumer that will call methods on StartEntitiesDetectionV2JobRequest.Builder to create a request.

Returns:

Result of the StartEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

startICD10CMInferenceJob

default StartIcd10CmInferenceJobResponse startICD10CMInferenceJob(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest)
                                                           throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the StartICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

startICD10CMInferenceJob

default StartIcd10CmInferenceJobResponse startICD10CMInferenceJob(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest)
                                                           throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StartIcd10CmInferenceJobRequest.builder()

Parameters:

startIcd10CmInferenceJobRequest - A Consumer that will call methods on StartIcd10CmInferenceJobRequest.Builder to create a request.

Returns:

Result of the StartICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

startPHIDetectionJob

default StartPhiDetectionJobResponse startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)
                                                   throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Parameters:

startPhiDetectionJobRequest -

Returns:

Result of the StartPHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

startPHIDetectionJob

default StartPhiDetectionJobResponse startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)
                                                   throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StartPhiDetectionJobRequest.builder()

Parameters:

startPhiDetectionJobRequest - A Consumer that will call methods on StartPhiDetectionJobRequest.Builder to create a request.

Returns:

Result of the StartPHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

startRxNormInferenceJob

default StartRxNormInferenceJobResponse startRxNormInferenceJob(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest)
                                                         throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the StartRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

startRxNormInferenceJob

default StartRxNormInferenceJobResponse startRxNormInferenceJob(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest)
                                                         throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StartRxNormInferenceJobRequest.builder()

Parameters:

startRxNormInferenceJobRequest - A Consumer that will call methods on StartRxNormInferenceJobRequest.Builder to create a request.

Returns:

Result of the StartRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

startSNOMEDCTInferenceJob

default StartSnomedctInferenceJobResponse startSNOMEDCTInferenceJob(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest)
                                                             throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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:

Result of the StartSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

startSNOMEDCTInferenceJob

default StartSnomedctInferenceJobResponse startSNOMEDCTInferenceJob(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest)
                                                             throws InvalidRequestException,
TooManyRequestsException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StartSnomedctInferenceJobRequest.builder()

Parameters:

startSnomedctInferenceJobRequest - A Consumer that will call methods on StartSnomedctInferenceJobRequest.Builder to create a request.

Returns:

Result of the StartSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopEntitiesDetectionV2Job

default StopEntitiesDetectionV2JobResponse stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Stops a medical entities detection job in progress.

Parameters:

stopEntitiesDetectionV2JobRequest -

Returns:

Result of the StopEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

stopEntitiesDetectionV2Job

default StopEntitiesDetectionV2JobResponse stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)
                                                               throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StopEntitiesDetectionV2JobRequest.builder()

Parameters:

stopEntitiesDetectionV2JobRequest - A Consumer that will call methods on StopEntitiesDetectionV2JobRequest.Builder to create a request.

Returns:

Result of the StopEntitiesDetectionV2Job operation returned by the service.

See Also:

• AWS API Documentation

stopICD10CMInferenceJob

default StopIcd10CmInferenceJobResponse stopICD10CMInferenceJob(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest)
                                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Stops an InferICD10CM inference job in progress.

Parameters:

stopIcd10CmInferenceJobRequest -

Returns:

Result of the StopICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopICD10CMInferenceJob

default StopIcd10CmInferenceJobResponse stopICD10CMInferenceJob(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest)
                                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StopIcd10CmInferenceJobRequest.builder()

Parameters:

stopIcd10CmInferenceJobRequest - A Consumer that will call methods on StopIcd10CmInferenceJobRequest.Builder to create a request.

Returns:

Result of the StopICD10CMInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopPHIDetectionJob

default StopPhiDetectionJobResponse stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Stops a protected health information (PHI) detection job in progress.

Parameters:

stopPhiDetectionJobRequest -

Returns:

Result of the StopPHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

stopPHIDetectionJob

default StopPhiDetectionJobResponse stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)
                                                 throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StopPhiDetectionJobRequest.builder()

Parameters:

stopPhiDetectionJobRequest - A Consumer that will call methods on StopPhiDetectionJobRequest.Builder to create a request.

Returns:

Result of the StopPHIDetectionJob operation returned by the service.

See Also:

• AWS API Documentation

stopRxNormInferenceJob

default StopRxNormInferenceJobResponse stopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest)
                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Stops an InferRxNorm inference job in progress.

Parameters:

stopRxNormInferenceJobRequest -

Returns:

Result of the StopRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopRxNormInferenceJob

default StopRxNormInferenceJobResponse stopRxNormInferenceJob(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest)
                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StopRxNormInferenceJobRequest.builder()

Parameters:

stopRxNormInferenceJobRequest - A Consumer that will call methods on StopRxNormInferenceJobRequest.Builder to create a request.

Returns:

Result of the StopRxNormInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopSNOMEDCTInferenceJob

default StopSnomedctInferenceJobResponse stopSNOMEDCTInferenceJob(StopSnomedctInferenceJobRequest stopSnomedctInferenceJobRequest)
                                                           throws InvalidRequestException,
ResourceNotFoundException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

Stops an InferSNOMEDCT inference job in progress.

Parameters:

stopSnomedctInferenceJobRequest -

Returns:

Result of the StopSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

stopSNOMEDCTInferenceJob

default StopSnomedctInferenceJobResponse stopSNOMEDCTInferenceJob(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest)
                                                           throws InvalidRequestException,
ResourceNotFoundException,
TooManyRequestsException,
InternalServerException,
AwsServiceException,
SdkClientException,
ComprehendMedicalException

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 via StopSnomedctInferenceJobRequest.builder()

Parameters:

stopSnomedctInferenceJobRequest - A Consumer that will call methods on StopSnomedctInferenceJobRequest.Builder to create a request.

Returns:

Result of the StopSNOMEDCTInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

create

static ComprehendMedicalClient create()

Create a ComprehendMedicalClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ComprehendMedicalClientBuilder builder()

Create a builder that can be used to configure and create a ComprehendMedicalClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ComprehendMedicalServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration