@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSComprehendMedicalClient extends AmazonWebServiceClient implements AWSComprehendMedical
Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSComprehendMedicalClientBuilder |
builder() |
DescribeEntitiesDetectionV2JobResult |
describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest request)
Gets the properties associated with a medical entities detection job.
|
DescribeICD10CMInferenceJobResult |
describeICD10CMInferenceJob(DescribeICD10CMInferenceJobRequest request)
Gets the properties associated with an InferICD10CM job.
|
DescribePHIDetectionJobResult |
describePHIDetectionJob(DescribePHIDetectionJobRequest request)
Gets the properties associated with a protected health information (PHI) detection job.
|
DescribeRxNormInferenceJobResult |
describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest request)
Gets the properties associated with an InferRxNorm 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 returns the entity category,
location, and confidence score for each entity.
|
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.
|
ListICD10CMInferenceJobsResult |
listICD10CMInferenceJobs(ListICD10CMInferenceJobsRequest request)
Gets a list of InferICD10CM jobs that you have submitted.
|
ListPHIDetectionJobsResult |
listPHIDetectionJobs(ListPHIDetectionJobsRequest request)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
|
ListRxNormInferenceJobsResult |
listRxNormInferenceJobs(ListRxNormInferenceJobsRequest request)
Gets a list of InferRxNorm jobs that you have submitted.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartEntitiesDetectionV2JobResult |
startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest request)
Starts an asynchronous medical entity detection job for a collection of documents.
|
StartICD10CMInferenceJobResult |
startICD10CMInferenceJob(StartICD10CMInferenceJobRequest request)
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
|
StartPHIDetectionJobResult |
startPHIDetectionJob(StartPHIDetectionJobRequest request)
Starts an asynchronous job to detect protected health information (PHI).
|
StartRxNormInferenceJobResult |
startRxNormInferenceJob(StartRxNormInferenceJobRequest request)
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
|
StopEntitiesDetectionV2JobResult |
stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest request)
Stops a medical entities detection job in progress.
|
StopICD10CMInferenceJobResult |
stopICD10CMInferenceJob(StopICD10CMInferenceJobRequest request)
Stops an InferICD10CM inference job in progress.
|
StopPHIDetectionJobResult |
stopPHIDetectionJob(StopPHIDetectionJobRequest request)
Stops a protected health information (PHI) detection job in progress.
|
StopRxNormInferenceJobResult |
stopRxNormInferenceJob(StopRxNormInferenceJobRequest request)
Stops an InferRxNorm inference job in progress.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSComprehendMedicalClientBuilder builder()
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.
describeEntitiesDetectionV2Job
in interface AWSComprehendMedical
describeEntitiesDetectionV2JobRequest
- 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.public DescribeICD10CMInferenceJobResult describeICD10CMInferenceJob(DescribeICD10CMInferenceJobRequest request)
Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
describeICD10CMInferenceJob
in interface AWSComprehendMedical
describeICD10CMInferenceJobRequest
- 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.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.
describePHIDetectionJob
in interface AWSComprehendMedical
describePHIDetectionJobRequest
- 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.public DescribeRxNormInferenceJobResult describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest request)
Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
describeRxNormInferenceJob
in interface AWSComprehendMedical
describeRxNormInferenceJobRequest
- 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.@Deprecated public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
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 .
detectEntities
in interface AWSComprehendMedical
detectEntitiesRequest
- 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.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. 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.
detectEntitiesV2
in interface AWSComprehendMedical
detectEntitiesV2Request
- 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.public DetectPHIResult detectPHI(DetectPHIRequest request)
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.
detectPHI
in interface AWSComprehendMedical
detectPHIRequest
- 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.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. Amazon Comprehend Medical only detects medical entities in English language texts.
inferICD10CM
in interface AWSComprehendMedical
inferICD10CMRequest
- 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.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. Amazon Comprehend Medical only detects medical entities in English language texts.
inferRxNorm
in interface AWSComprehendMedical
inferRxNormRequest
- 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.public ListEntitiesDetectionV2JobsResult listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest request)
Gets a list of medical entity detection jobs that you have submitted.
listEntitiesDetectionV2Jobs
in interface AWSComprehendMedical
listEntitiesDetectionV2JobsRequest
- 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.public ListICD10CMInferenceJobsResult listICD10CMInferenceJobs(ListICD10CMInferenceJobsRequest request)
Gets a list of InferICD10CM jobs that you have submitted.
listICD10CMInferenceJobs
in interface AWSComprehendMedical
listICD10CMInferenceJobsRequest
- 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.public ListPHIDetectionJobsResult listPHIDetectionJobs(ListPHIDetectionJobsRequest request)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
listPHIDetectionJobs
in interface AWSComprehendMedical
listPHIDetectionJobsRequest
- 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.public ListRxNormInferenceJobsResult listRxNormInferenceJobs(ListRxNormInferenceJobsRequest request)
Gets a list of InferRxNorm jobs that you have submitted.
listRxNormInferenceJobs
in interface AWSComprehendMedical
listRxNormInferenceJobsRequest
- 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.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.
startEntitiesDetectionV2Job
in interface AWSComprehendMedical
startEntitiesDetectionV2JobRequest
- 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.public StartICD10CMInferenceJobResult startICD10CMInferenceJob(StartICD10CMInferenceJobRequest request)
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.
startICD10CMInferenceJob
in interface AWSComprehendMedical
startICD10CMInferenceJobRequest
- 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.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.
startPHIDetectionJob
in interface AWSComprehendMedical
startPHIDetectionJobRequest
- 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.public StartRxNormInferenceJobResult startRxNormInferenceJob(StartRxNormInferenceJobRequest request)
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.
startRxNormInferenceJob
in interface AWSComprehendMedical
startRxNormInferenceJobRequest
- 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.public StopEntitiesDetectionV2JobResult stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest request)
Stops a medical entities detection job in progress.
stopEntitiesDetectionV2Job
in interface AWSComprehendMedical
stopEntitiesDetectionV2JobRequest
- 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.public StopICD10CMInferenceJobResult stopICD10CMInferenceJob(StopICD10CMInferenceJobRequest request)
Stops an InferICD10CM inference job in progress.
stopICD10CMInferenceJob
in interface AWSComprehendMedical
stopICD10CMInferenceJobRequest
- 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.public StopPHIDetectionJobResult stopPHIDetectionJob(StopPHIDetectionJobRequest request)
Stops a protected health information (PHI) detection job in progress.
stopPHIDetectionJob
in interface AWSComprehendMedical
stopPHIDetectionJobRequest
- 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.public StopRxNormInferenceJobResult stopRxNormInferenceJob(StopRxNormInferenceJobRequest request)
Stops an InferRxNorm inference job in progress.
stopRxNormInferenceJob
in interface AWSComprehendMedical
stopRxNormInferenceJobRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSComprehendMedical
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSComprehendMedical
shutdown
in class AmazonWebServiceClient