software.amazon.awssdk.services.comprehendmedical

Interface ComprehendMedicalClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface ComprehendMedicalClient
extends SdkClient

Service client for accessing ComprehendMedical. This can be created using the static builder() method.

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	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static ComprehendMedicalClientBuilder	builder() Create a builder that can be used to configure and create a ComprehendMedicalClient.
static ComprehendMedicalClient	create() Create a ComprehendMedicalClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeEntitiesDetectionV2JobResponse	describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job.
default DescribeEntitiesDetectionV2JobResponse	describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest) Gets the properties associated with a medical entities detection job.
default DescribePhiDetectionJobResponse	describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job.
default DescribePhiDetectionJobResponse	describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest) Gets the properties associated with a protected health information (PHI) detection job.
default DetectEntitiesResponse	detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) The DetectEntities operation is deprecated.
default DetectEntitiesResponse	detectEntities(DetectEntitiesRequest detectEntitiesRequest) The DetectEntities operation is deprecated.
default DetectEntitiesV2Response	detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> 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.
default DetectEntitiesV2Response	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.
default DetectPhiResponse	detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest) Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.
default DetectPhiResponse	detectPHI(DetectPhiRequest detectPhiRequest) Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.
default InferIcd10CmResponse	inferICD10CM(Consumer<InferIcd10CmRequest.Builder> inferIcd10CmRequest) 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.
default InferIcd10CmResponse	inferICD10CM(InferIcd10CmRequest inferIcd10CmRequest) 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.
default InferRxNormResponse	inferRxNorm(Consumer<InferRxNormRequest.Builder> inferRxNormRequest) 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.
default InferRxNormResponse	inferRxNorm(InferRxNormRequest inferRxNormRequest) 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.
default ListEntitiesDetectionV2JobsResponse	listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.
default ListEntitiesDetectionV2JobsResponse	listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest) Gets a list of medical entity detection jobs that you have submitted.
default ListPhiDetectionJobsResponse	listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs that you have submitted.
default ListPhiDetectionJobsResponse	listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest) Gets a list of protected health information (PHI) detection jobs that you have submitted.
static ServiceMetadata	serviceMetadata()
default StartEntitiesDetectionV2JobResponse	startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents.
default StartEntitiesDetectionV2JobResponse	startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest) Starts an asynchronous medical entity detection job for a collection of documents.
default StartPhiDetectionJobResponse	startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI).
default StartPhiDetectionJobResponse	startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest) Starts an asynchronous job to detect protected health information (PHI).
default StopEntitiesDetectionV2JobResponse	stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.
default StopEntitiesDetectionV2JobResponse	stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest) Stops a medical entities detection job in progress.
default StopPhiDetectionJobResponse	stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.
default StopPhiDetectionJobResponse	stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest) Stops a protected health information (PHI) detection job in progress.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ComprehendMedicalClient create()

Create a ComprehendMedicalClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ComprehendMedicalClientBuilder builder()

Create a builder that can be used to configure and create a ComprehendMedicalClient.

describeEntitiesDetectionV2Job

default DescribeEntitiesDetectionV2JobResponse describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)
                                                                       throws InvalidRequestException,
                                                                              TooManyRequestsException,
                                                                              ResourceNotFoundException,
                                                                              InternalServerException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeEntitiesDetectionV2Job

default DescribeEntitiesDetectionV2JobResponse describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)
                                                                       throws InvalidRequestException,
                                                                              TooManyRequestsException,
                                                                              ResourceNotFoundException,
                                                                              InternalServerException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ComprehendMedicalException

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

This is a convenience which creates an instance of the DescribeEntitiesDetectionV2JobRequest.Builder avoiding the need to create one manually via DescribeEntitiesDetectionV2JobRequest.builder()

Parameters:

describeEntitiesDetectionV2JobRequest - A Consumer that will call methods on DescribeEntitiesDetectionV2JobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePHIDetectionJob

default DescribePhiDetectionJobResponse describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)
                                                         throws InvalidRequestException,
                                                                TooManyRequestsException,
                                                                ResourceNotFoundException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describePHIDetectionJob

default DescribePhiDetectionJobResponse describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)
                                                         throws InvalidRequestException,
                                                                TooManyRequestsException,
                                                                ResourceNotFoundException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ComprehendMedicalException

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

This is a convenience which creates an instance of the DescribePhiDetectionJobRequest.Builder avoiding the need to create one manually via DescribePhiDetectionJobRequest.builder()

Parameters:

describePhiDetectionJobRequest - A Consumer that will call methods on DescribePHIDetectionJobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectEntities

default DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest)
                                       throws InternalServerException,
                                              ServiceUnavailableException,
                                              TooManyRequestsException,
                                              InvalidRequestException,
                                              InvalidEncodingException,
                                              TextSizeLimitExceededException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectEntities

default DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)
                                       throws InternalServerException,
                                              ServiceUnavailableException,
                                              TooManyRequestsException,
                                              InvalidRequestException,
                                              InvalidEncodingException,
                                              TextSizeLimitExceededException,
                                              AwsServiceException,
                                              SdkClientException,
                                              ComprehendMedicalException

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 .

This is a convenience which creates an instance of the DetectEntitiesRequest.Builder avoiding the need to create one manually via DetectEntitiesRequest.builder()

Parameters:

detectEntitiesRequest - A Consumer that will call methods on DetectEntitiesRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectEntitiesV2

default DetectEntitiesV2Response detectEntitiesV2(DetectEntitiesV2Request detectEntitiesV2Request)
                                           throws InternalServerException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  InvalidRequestException,
                                                  InvalidEncodingException,
                                                  TextSizeLimitExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ComprehendMedicalException

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectEntitiesV2

default DetectEntitiesV2Response detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request)
                                           throws InternalServerException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  InvalidRequestException,
                                                  InvalidEncodingException,
                                                  TextSizeLimitExceededException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ComprehendMedicalException

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.

This is a convenience which creates an instance of the DetectEntitiesV2Request.Builder avoiding the need to create one manually via DetectEntitiesV2Request.builder()

Parameters:

detectEntitiesV2Request - A Consumer that will call methods on DetectEntitiesV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectPHI

default DetectPhiResponse detectPHI(DetectPhiRequest detectPhiRequest)
                             throws InternalServerException,
                                    ServiceUnavailableException,
                                    TooManyRequestsException,
                                    InvalidRequestException,
                                    InvalidEncodingException,
                                    TextSizeLimitExceededException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ComprehendMedicalException

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

detectPHI

default DetectPhiResponse detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest)
                             throws InternalServerException,
                                    ServiceUnavailableException,
                                    TooManyRequestsException,
                                    InvalidRequestException,
                                    InvalidEncodingException,
                                    TextSizeLimitExceededException,
                                    AwsServiceException,
                                    SdkClientException,
                                    ComprehendMedicalException

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.

This is a convenience which creates an instance of the DetectPhiRequest.Builder avoiding the need to create one manually via DetectPhiRequest.builder()

Parameters:

detectPhiRequest - A Consumer that will call methods on DetectPHIRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

inferICD10CM

default InferIcd10CmResponse inferICD10CM(InferIcd10CmRequest inferIcd10CmRequest)
                                   throws InternalServerException,
                                          ServiceUnavailableException,
                                          TooManyRequestsException,
                                          InvalidRequestException,
                                          InvalidEncodingException,
                                          TextSizeLimitExceededException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ComprehendMedicalException

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

inferICD10CM

default InferIcd10CmResponse inferICD10CM(Consumer<InferIcd10CmRequest.Builder> inferIcd10CmRequest)
                                   throws InternalServerException,
                                          ServiceUnavailableException,
                                          TooManyRequestsException,
                                          InvalidRequestException,
                                          InvalidEncodingException,
                                          TextSizeLimitExceededException,
                                          AwsServiceException,
                                          SdkClientException,
                                          ComprehendMedicalException

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.

This is a convenience which creates an instance of the InferIcd10CmRequest.Builder avoiding the need to create one manually via InferIcd10CmRequest.builder()

Parameters:

inferIcd10CmRequest - A Consumer that will call methods on InferICD10CMRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

inferRxNorm

default InferRxNormResponse inferRxNorm(InferRxNormRequest inferRxNormRequest)
                                 throws InternalServerException,
                                        ServiceUnavailableException,
                                        TooManyRequestsException,
                                        InvalidRequestException,
                                        InvalidEncodingException,
                                        TextSizeLimitExceededException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ComprehendMedicalException

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

inferRxNorm

default InferRxNormResponse inferRxNorm(Consumer<InferRxNormRequest.Builder> inferRxNormRequest)
                                 throws InternalServerException,
                                        ServiceUnavailableException,
                                        TooManyRequestsException,
                                        InvalidRequestException,
                                        InvalidEncodingException,
                                        TextSizeLimitExceededException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ComprehendMedicalException

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.

This is a convenience which creates an instance of the InferRxNormRequest.Builder avoiding the need to create one manually via InferRxNormRequest.builder()

Parameters:

inferRxNormRequest - A Consumer that will call methods on InferRxNormRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEntitiesDetectionV2Jobs

default ListEntitiesDetectionV2JobsResponse listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)
                                                                 throws InvalidRequestException,
                                                                        ValidationException,
                                                                        TooManyRequestsException,
                                                                        InternalServerException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEntitiesDetectionV2Jobs

default ListEntitiesDetectionV2JobsResponse listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)
                                                                 throws InvalidRequestException,
                                                                        ValidationException,
                                                                        TooManyRequestsException,
                                                                        InternalServerException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ComprehendMedicalException

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

This is a convenience which creates an instance of the ListEntitiesDetectionV2JobsRequest.Builder avoiding the need to create one manually via ListEntitiesDetectionV2JobsRequest.builder()

Parameters:

listEntitiesDetectionV2JobsRequest - A Consumer that will call methods on ListEntitiesDetectionV2JobsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPHIDetectionJobs

default ListPhiDetectionJobsResponse listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)
                                                   throws InvalidRequestException,
                                                          ValidationException,
                                                          TooManyRequestsException,
                                                          InternalServerException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPHIDetectionJobs

default ListPhiDetectionJobsResponse listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)
                                                   throws InvalidRequestException,
                                                          ValidationException,
                                                          TooManyRequestsException,
                                                          InternalServerException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ComprehendMedicalException

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

This is a convenience which creates an instance of the ListPhiDetectionJobsRequest.Builder avoiding the need to create one manually via ListPhiDetectionJobsRequest.builder()

Parameters:

listPhiDetectionJobsRequest - A Consumer that will call methods on ListPHIDetectionJobsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startEntitiesDetectionV2Job

default StartEntitiesDetectionV2JobResponse startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)
                                                                 throws InvalidRequestException,
                                                                        TooManyRequestsException,
                                                                        ResourceNotFoundException,
                                                                        InternalServerException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startEntitiesDetectionV2Job

default StartEntitiesDetectionV2JobResponse startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)
                                                                 throws InvalidRequestException,
                                                                        TooManyRequestsException,
                                                                        ResourceNotFoundException,
                                                                        InternalServerException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ComprehendMedicalException

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

This is a convenience which creates an instance of the StartEntitiesDetectionV2JobRequest.Builder avoiding the need to create one manually via StartEntitiesDetectionV2JobRequest.builder()

Parameters:

startEntitiesDetectionV2JobRequest - A Consumer that will call methods on StartEntitiesDetectionV2JobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startPHIDetectionJob

default StartPhiDetectionJobResponse startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)
                                                   throws InvalidRequestException,
                                                          TooManyRequestsException,
                                                          ResourceNotFoundException,
                                                          InternalServerException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startPHIDetectionJob

default StartPhiDetectionJobResponse startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)
                                                   throws InvalidRequestException,
                                                          TooManyRequestsException,
                                                          ResourceNotFoundException,
                                                          InternalServerException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ComprehendMedicalException

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

This is a convenience which creates an instance of the StartPhiDetectionJobRequest.Builder avoiding the need to create one manually via StartPhiDetectionJobRequest.builder()

Parameters:

startPhiDetectionJobRequest - A Consumer that will call methods on StartPHIDetectionJobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopEntitiesDetectionV2Job

default StopEntitiesDetectionV2JobResponse stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)
                                                               throws InvalidRequestException,
                                                                      ResourceNotFoundException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopEntitiesDetectionV2Job

default StopEntitiesDetectionV2JobResponse stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)
                                                               throws InvalidRequestException,
                                                                      ResourceNotFoundException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ComprehendMedicalException

Stops a medical entities detection job in progress.

This is a convenience which creates an instance of the StopEntitiesDetectionV2JobRequest.Builder avoiding the need to create one manually via StopEntitiesDetectionV2JobRequest.builder()

Parameters:

stopEntitiesDetectionV2JobRequest - A Consumer that will call methods on StopEntitiesDetectionV2JobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopPHIDetectionJob

default StopPhiDetectionJobResponse stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)
                                                 throws InvalidRequestException,
                                                        ResourceNotFoundException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ComprehendMedicalException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopPHIDetectionJob

default StopPhiDetectionJobResponse stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)
                                                 throws InvalidRequestException,
                                                        ResourceNotFoundException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ComprehendMedicalException

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

This is a convenience which creates an instance of the StopPhiDetectionJobRequest.Builder avoiding the need to create one manually via StopPhiDetectionJobRequest.builder()

Parameters:

stopPhiDetectionJobRequest - A Consumer that will call methods on StopPHIDetectionJobRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ComprehendMedicalException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()