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.

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

Method Summary

Modifier and Type	Method and Description
DescribeEntitiesDetectionV2JobResult	describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job.
DescribePHIDetectionJobResult	describePHIDetectionJob(DescribePHIDetectionJobRequest describePHIDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job.
DetectEntitiesResult	detectEntities(DetectEntitiesRequest detectEntitiesRequest) Deprecated.
DetectEntitiesV2Result	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.
DetectPHIResult	detectPHI(DetectPHIRequest detectPHIRequest) 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.
ListEntitiesDetectionV2JobsResult	listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.
ListPHIDetectionJobsResult	listPHIDetectionJobs(ListPHIDetectionJobsRequest listPHIDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs that you have submitted.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartEntitiesDetectionV2JobResult	startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents.
StartPHIDetectionJobResult	startPHIDetectionJob(StartPHIDetectionJobRequest startPHIDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI).
StopEntitiesDetectionV2JobResult	stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.
StopPHIDetectionJobResult	stopPHIDetectionJob(StopPHIDetectionJobRequest stopPHIDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.

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

describeEntitiesDetectionV2Job

DescribeEntitiesDetectionV2JobResult describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)

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

Parameters:

describeEntitiesDetectionV2JobRequest -

Returns:

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

DescribePHIDetectionJobResult describePHIDetectionJob(DescribePHIDetectionJobRequest describePHIDetectionJobRequest)

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

Parameters:

describePHIDetectionJobRequest -

Returns:

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
DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest)

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 .

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

DetectEntitiesV2Result 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.

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. It does not return the Quality or Quantity entities.

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

DetectPHIResult detectPHI(DetectPHIRequest detectPHIRequest)

Inspects the clinical text for protected 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 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

ListEntitiesDetectionV2JobsResult listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)

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

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

ListPHIDetectionJobsResult listPHIDetectionJobs(ListPHIDetectionJobsRequest listPHIDetectionJobsRequest)

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

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

StartEntitiesDetectionV2JobResult startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)

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

Parameters:

startEntitiesDetectionV2JobRequest -

Returns:

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

StartPHIDetectionJobResult startPHIDetectionJob(StartPHIDetectionJobRequest startPHIDetectionJobRequest)

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

Parameters:

startPHIDetectionJobRequest -

Returns:

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

StopEntitiesDetectionV2JobResult stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)

Stops a medical entities detection job in progress.

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

StopPHIDetectionJobResult stopPHIDetectionJob(StopPHIDetectionJobRequest stopPHIDetectionJobRequest)

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

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

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.