com.amazonaws.services.comprehendmedical

Interface AWSComprehendMedical

All Known Subinterfaces:

AWSComprehendMedicalAsync

All Known Implementing Classes:

AbstractAWSComprehendMedical, AbstractAWSComprehendMedicalAsync, AWSComprehendMedicalAsyncClient, AWSComprehendMedicalClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSComprehendMedical

Interface for accessing ComprehendMedical.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSComprehendMedical instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DetectEntitiesResult	detectEntities(DetectEntitiesRequest detectEntitiesRequest) 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 detectPHIRequest) 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

detectEntities

DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest)

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.

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

DetectPHIResult detectPHI(DetectPHIRequest detectPHIRequest)

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

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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