com.amazonaws.services.comprehendmedical

Class AWSComprehendMedicalClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.comprehendmedical.AWSComprehendMedicalClient

All Implemented Interfaces:

AWSComprehendMedical

Direct Known Subclasses:

AWSComprehendMedicalAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSComprehendMedicalClient
extends AmazonWebServiceClient
implements AWSComprehendMedical

Client for accessing ComprehendMedical. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.comprehendmedical.AWSComprehendMedical

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSComprehendMedicalClientBuilder	builder()
DescribeEntitiesDetectionV2JobResult	describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest request) Gets the properties associated with a medical entities detection job.
DescribePHIDetectionJobResult	describePHIDetectionJob(DescribePHIDetectionJobRequest request) Gets the properties associated with a protected health information (PHI) detection job.
DetectEntitiesResult	detectEntities(DetectEntitiesRequest request) Deprecated.
DetectEntitiesV2Result	detectEntitiesV2(DetectEntitiesV2Request request) 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.
DetectPHIResult	detectPHI(DetectPHIRequest request) Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
InferICD10CMResult	inferICD10CM(InferICD10CMRequest request) 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.
InferRxNormResult	inferRxNorm(InferRxNormRequest request) 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.
ListEntitiesDetectionV2JobsResult	listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest request) Gets a list of medical entity detection jobs that you have submitted.
ListPHIDetectionJobsResult	listPHIDetectionJobs(ListPHIDetectionJobsRequest request) Gets a list of protected health information (PHI) detection jobs that you have submitted.
StartEntitiesDetectionV2JobResult	startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest request) Starts an asynchronous medical entity detection job for a collection of documents.
StartPHIDetectionJobResult	startPHIDetectionJob(StartPHIDetectionJobRequest request) Starts an asynchronous job to detect protected health information (PHI).
StopEntitiesDetectionV2JobResult	stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest request) Stops a medical entities detection job in progress.
StopPHIDetectionJobResult	stopPHIDetectionJob(StopPHIDetectionJobRequest request) Stops a protected health information (PHI) detection job in progress.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.comprehendmedical.AWSComprehendMedical

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSComprehendMedicalClientBuilder builder()

describeEntitiesDetectionV2Job

public DescribeEntitiesDetectionV2JobResult describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest request)

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

Specified by:

describeEntitiesDetectionV2Job in interface AWSComprehendMedical

Parameters:

describeEntitiesDetectionV2JobRequest -

Returns:

Result of the DescribeEntitiesDetectionV2Job operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

describePHIDetectionJob

public DescribePHIDetectionJobResult describePHIDetectionJob(DescribePHIDetectionJobRequest request)

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Specified by:

describePHIDetectionJob in interface AWSComprehendMedical

Parameters:

describePHIDetectionJobRequest -

Returns:

Result of the DescribePHIDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

detectEntities

@Deprecated
public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)

Deprecated.

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 .

Specified by:

detectEntities in interface AWSComprehendMedical

Parameters:

detectEntitiesRequest -

Returns:

Result of the DetectEntities operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

detectEntitiesV2

public DetectEntitiesV2Result detectEntitiesV2(DetectEntitiesV2Request request)

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.

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.

Specified by:

detectEntitiesV2 in interface AWSComprehendMedical

Parameters:

detectEntitiesV2Request -

Returns:

Result of the DetectEntitiesV2 operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

detectPHI

public DetectPHIResult detectPHI(DetectPHIRequest request)

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

Specified by:

detectPHI in interface AWSComprehendMedical

Parameters:

detectPHIRequest -

Returns:

Result of the DetectPHI operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

inferICD10CM

public InferICD10CMResult inferICD10CM(InferICD10CMRequest request)

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.

Specified by:

inferICD10CM in interface AWSComprehendMedical

Parameters:

inferICD10CMRequest -

Returns:

Result of the InferICD10CM operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

inferRxNorm

public InferRxNormResult inferRxNorm(InferRxNormRequest request)

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.

Specified by:

inferRxNorm in interface AWSComprehendMedical

Parameters:

inferRxNormRequest -

Returns:

Result of the InferRxNorm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEntitiesDetectionV2Jobs

public ListEntitiesDetectionV2JobsResult listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest request)

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

Specified by:

listEntitiesDetectionV2Jobs in interface AWSComprehendMedical

Parameters:

listEntitiesDetectionV2JobsRequest -

Returns:

Result of the ListEntitiesDetectionV2Jobs operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

listPHIDetectionJobs

public ListPHIDetectionJobsResult listPHIDetectionJobs(ListPHIDetectionJobsRequest request)

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

Specified by:

listPHIDetectionJobs in interface AWSComprehendMedical

Parameters:

listPHIDetectionJobsRequest -

Returns:

Result of the ListPHIDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

startEntitiesDetectionV2Job

public StartEntitiesDetectionV2JobResult startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest request)

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

Specified by:

startEntitiesDetectionV2Job in interface AWSComprehendMedical

Parameters:

startEntitiesDetectionV2JobRequest -

Returns:

Result of the StartEntitiesDetectionV2Job operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

startPHIDetectionJob

public StartPHIDetectionJobResult startPHIDetectionJob(StartPHIDetectionJobRequest request)

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

Specified by:

startPHIDetectionJob in interface AWSComprehendMedical

Parameters:

startPHIDetectionJobRequest -

Returns:

Result of the StartPHIDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

stopEntitiesDetectionV2Job

public StopEntitiesDetectionV2JobResult stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest request)

Stops a medical entities detection job in progress.

Specified by:

stopEntitiesDetectionV2Job in interface AWSComprehendMedical

Parameters:

stopEntitiesDetectionV2JobRequest -

Returns:

Result of the StopEntitiesDetectionV2Job operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

stopPHIDetectionJob

public StopPHIDetectionJobResult stopPHIDetectionJob(StopPHIDetectionJobRequest request)

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

Specified by:

stopPHIDetectionJob in interface AWSComprehendMedical

Parameters:

stopPHIDetectionJobRequest -

Returns:

Result of the StopPHIDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSComprehendMedical

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.