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.

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, 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()
DetectEntitiesResult	detectEntities(DetectEntitiesRequest 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 personal 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.

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, 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()

detectEntities

public DetectEntitiesResult detectEntities(DetectEntitiesRequest 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 .

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 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 personal 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 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

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.