Interface ComprehendMedicalClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ComprehendMedicalClient extends AwsClient
Service client for accessing ComprehendMedical. This can be created using the staticbuilder()method.Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and quotas in the Amazon Comprehend Medical Developer Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description static ComprehendMedicalClientBuilderbuilder()Create a builder that can be used to configure and create aComprehendMedicalClient.static ComprehendMedicalClientcreate()Create aComprehendMedicalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DescribeEntitiesDetectionV2JobResponsedescribeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)Gets the properties associated with a medical entities detection job.default DescribeEntitiesDetectionV2JobResponsedescribeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)Gets the properties associated with a medical entities detection job.default DescribeIcd10CmInferenceJobResponsedescribeICD10CMInferenceJob(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest)Gets the properties associated with an InferICD10CM job.default DescribeIcd10CmInferenceJobResponsedescribeICD10CMInferenceJob(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest)Gets the properties associated with an InferICD10CM job.default DescribePhiDetectionJobResponsedescribePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)Gets the properties associated with a protected health information (PHI) detection job.default DescribePhiDetectionJobResponsedescribePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)Gets the properties associated with a protected health information (PHI) detection job.default DescribeRxNormInferenceJobResponsedescribeRxNormInferenceJob(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest)Gets the properties associated with an InferRxNorm job.default DescribeRxNormInferenceJobResponsedescribeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest)Gets the properties associated with an InferRxNorm job.default DescribeSnomedctInferenceJobResponsedescribeSNOMEDCTInferenceJob(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest)Gets the properties associated with an InferSNOMEDCT job.default DescribeSnomedctInferenceJobResponsedescribeSNOMEDCTInferenceJob(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest)Gets the properties associated with an InferSNOMEDCT job.default DetectEntitiesResponsedetectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.default DetectEntitiesResponsedetectEntities(DetectEntitiesRequest detectEntitiesRequest)Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.default DetectEntitiesV2ResponsedetectEntitiesV2(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 DetectEntitiesV2ResponsedetectEntitiesV2(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 DetectPhiResponsedetectPHI(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 DetectPhiResponsedetectPHI(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 InferIcd10CmResponseinferICD10CM(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 InferIcd10CmResponseinferICD10CM(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 InferRxNormResponseinferRxNorm(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 InferRxNormResponseinferRxNorm(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 InferSnomedctResponseinferSNOMEDCT(Consumer<InferSnomedctRequest.Builder> inferSnomedctRequest)InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontologydefault InferSnomedctResponseinferSNOMEDCT(InferSnomedctRequest inferSnomedctRequest)InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontologydefault ListEntitiesDetectionV2JobsResponselistEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)Gets a list of medical entity detection jobs that you have submitted.default ListEntitiesDetectionV2JobsResponselistEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)Gets a list of medical entity detection jobs that you have submitted.default ListIcd10CmInferenceJobsResponselistICD10CMInferenceJobs(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest)Gets a list of InferICD10CM jobs that you have submitted.default ListIcd10CmInferenceJobsResponselistICD10CMInferenceJobs(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest)Gets a list of InferICD10CM jobs that you have submitted.default ListPhiDetectionJobsResponselistPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)Gets a list of protected health information (PHI) detection jobs you have submitted.default ListPhiDetectionJobsResponselistPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)Gets a list of protected health information (PHI) detection jobs you have submitted.default ListRxNormInferenceJobsResponselistRxNormInferenceJobs(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest)Gets a list of InferRxNorm jobs that you have submitted.default ListRxNormInferenceJobsResponselistRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest)Gets a list of InferRxNorm jobs that you have submitted.default ListSnomedctInferenceJobsResponselistSNOMEDCTInferenceJobs(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest)Gets a list of InferSNOMEDCT jobs a user has submitted.default ListSnomedctInferenceJobsResponselistSNOMEDCTInferenceJobs(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest)Gets a list of InferSNOMEDCT jobs a user has submitted.default ComprehendMedicalServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartEntitiesDetectionV2JobResponsestartEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)Starts an asynchronous medical entity detection job for a collection of documents.default StartEntitiesDetectionV2JobResponsestartEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)Starts an asynchronous medical entity detection job for a collection of documents.default StartIcd10CmInferenceJobResponsestartICD10CMInferenceJob(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest)Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.default StartIcd10CmInferenceJobResponsestartICD10CMInferenceJob(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest)Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.default StartPhiDetectionJobResponsestartPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)Starts an asynchronous job to detect protected health information (PHI).default StartPhiDetectionJobResponsestartPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)Starts an asynchronous job to detect protected health information (PHI).default StartRxNormInferenceJobResponsestartRxNormInferenceJob(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest)Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.default StartRxNormInferenceJobResponsestartRxNormInferenceJob(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest)Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.default StartSnomedctInferenceJobResponsestartSNOMEDCTInferenceJob(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest)Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.default StartSnomedctInferenceJobResponsestartSNOMEDCTInferenceJob(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest)Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.default StopEntitiesDetectionV2JobResponsestopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)Stops a medical entities detection job in progress.default StopEntitiesDetectionV2JobResponsestopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)Stops a medical entities detection job in progress.default StopIcd10CmInferenceJobResponsestopICD10CMInferenceJob(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest)Stops an InferICD10CM inference job in progress.default StopIcd10CmInferenceJobResponsestopICD10CMInferenceJob(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest)Stops an InferICD10CM inference job in progress.default StopPhiDetectionJobResponsestopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)Stops a protected health information (PHI) detection job in progress.default StopPhiDetectionJobResponsestopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)Stops a protected health information (PHI) detection job in progress.default StopRxNormInferenceJobResponsestopRxNormInferenceJob(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest)Stops an InferRxNorm inference job in progress.default StopRxNormInferenceJobResponsestopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest)Stops an InferRxNorm inference job in progress.default StopSnomedctInferenceJobResponsestopSNOMEDCTInferenceJob(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest)Stops an InferSNOMEDCT inference job in progress.default StopSnomedctInferenceJobResponsestopSNOMEDCTInferenceJob(StopSnomedctInferenceJobRequest stopSnomedctInferenceJobRequest)Stops an InferSNOMEDCT inference job in progress.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.Builderavoiding the need to create one manually viaDescribeEntitiesDetectionV2JobRequest.builder()- Parameters:
describeEntitiesDetectionV2JobRequest- AConsumerthat will call methods onDescribeEntitiesDetectionV2JobRequest.Builderto 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
-
describeICD10CMInferenceJob
default DescribeIcd10CmInferenceJobResponse describeICD10CMInferenceJob(DescribeIcd10CmInferenceJobRequest describeIcd10CmInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
- Parameters:
describeIcd10CmInferenceJobRequest-- Returns:
- Result of the DescribeICD10CMInferenceJob 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
-
describeICD10CMInferenceJob
default DescribeIcd10CmInferenceJobResponse describeICD10CMInferenceJob(Consumer<DescribeIcd10CmInferenceJobRequest.Builder> describeIcd10CmInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeIcd10CmInferenceJobRequest.Builderavoiding the need to create one manually viaDescribeIcd10CmInferenceJobRequest.builder()- Parameters:
describeIcd10CmInferenceJobRequest- AConsumerthat will call methods onDescribeIcd10CmInferenceJobRequest.Builderto create a request.- Returns:
- Result of the DescribeICD10CMInferenceJob 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.Builderavoiding the need to create one manually viaDescribePhiDetectionJobRequest.builder()- Parameters:
describePhiDetectionJobRequest- AConsumerthat will call methods onDescribePhiDetectionJobRequest.Builderto 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
-
describeRxNormInferenceJob
default DescribeRxNormInferenceJobResponse describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest describeRxNormInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
- Parameters:
describeRxNormInferenceJobRequest-- Returns:
- Result of the DescribeRxNormInferenceJob 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
-
describeRxNormInferenceJob
default DescribeRxNormInferenceJobResponse describeRxNormInferenceJob(Consumer<DescribeRxNormInferenceJobRequest.Builder> describeRxNormInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeRxNormInferenceJobRequest.Builderavoiding the need to create one manually viaDescribeRxNormInferenceJobRequest.builder()- Parameters:
describeRxNormInferenceJobRequest- AConsumerthat will call methods onDescribeRxNormInferenceJobRequest.Builderto create a request.- Returns:
- Result of the DescribeRxNormInferenceJob 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
-
describeSNOMEDCTInferenceJob
default DescribeSnomedctInferenceJobResponse describeSNOMEDCTInferenceJob(DescribeSnomedctInferenceJobRequest describeSnomedctInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
- Parameters:
describeSnomedctInferenceJobRequest-- Returns:
- Result of the DescribeSNOMEDCTInferenceJob 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
-
describeSNOMEDCTInferenceJob
default DescribeSnomedctInferenceJobResponse describeSNOMEDCTInferenceJob(Consumer<DescribeSnomedctInferenceJobRequest.Builder> describeSnomedctInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
This is a convenience which creates an instance of the
DescribeSnomedctInferenceJobRequest.Builderavoiding the need to create one manually viaDescribeSnomedctInferenceJobRequest.builder()- Parameters:
describeSnomedctInferenceJobRequest- AConsumerthat will call methods onDescribeSnomedctInferenceJobRequest.Builderto create a request.- Returns:
- Result of the DescribeSNOMEDCTInferenceJob 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
@Deprecated default DetectEntitiesResponse detectEntities(DetectEntitiesRequest detectEntitiesRequest) throws InternalServerException, ServiceUnavailableException, TooManyRequestsException, InvalidRequestException, InvalidEncodingException, TextSizeLimitExceededException, AwsServiceException, SdkClientException, ComprehendMedicalException
Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.The
DetectEntitiesoperation 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
@Deprecated default DetectEntitiesResponse detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) throws InternalServerException, ServiceUnavailableException, TooManyRequestsException, InvalidRequestException, InvalidEncodingException, TextSizeLimitExceededException, AwsServiceException, SdkClientException, ComprehendMedicalException
Deprecated.This operation is deprecated, use DetectEntitiesV2 instead.The
DetectEntitiesoperation 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.Builderavoiding the need to create one manually viaDetectEntitiesRequest.builder()- Parameters:
detectEntitiesRequest- AConsumerthat will call methods onDetectEntitiesRequest.Builderto 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
DetectEntitiesV2operation 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 theDetectEntitiesV2operation in all new applications.The
DetectEntitiesV2operation returns theAcuityandDirectionentities 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
DetectEntitiesV2operation 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 theDetectEntitiesV2operation in all new applications.The
DetectEntitiesV2operation returns theAcuityandDirectionentities as attributes instead of types.
This is a convenience which creates an instance of the
DetectEntitiesV2Request.Builderavoiding the need to create one manually viaDetectEntitiesV2Request.builder()- Parameters:
detectEntitiesV2Request- AConsumerthat will call methods onDetectEntitiesV2Request.Builderto 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.Builderavoiding the need to create one manually viaDetectPhiRequest.builder()- Parameters:
detectPhiRequest- AConsumerthat will call methods onDetectPhiRequest.Builderto 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.Builderavoiding the need to create one manually viaInferIcd10CmRequest.builder()- Parameters:
inferIcd10CmRequest- AConsumerthat will call methods onInferIcd10CmRequest.Builderto 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.Builderavoiding the need to create one manually viaInferRxNormRequest.builder()- Parameters:
inferRxNormRequest- AConsumerthat will call methods onInferRxNormRequest.Builderto 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
-
inferSNOMEDCT
default InferSnomedctResponse inferSNOMEDCT(InferSnomedctRequest inferSnomedctRequest) throws InternalServerException, ServiceUnavailableException, TooManyRequestsException, InvalidRequestException, InvalidEncodingException, TextSizeLimitExceededException, AwsServiceException, SdkClientException, ComprehendMedicalException
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
- Parameters:
inferSnomedctRequest-- Returns:
- Result of the InferSNOMEDCT 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
-
inferSNOMEDCT
default InferSnomedctResponse inferSNOMEDCT(Consumer<InferSnomedctRequest.Builder> inferSnomedctRequest) throws InternalServerException, ServiceUnavailableException, TooManyRequestsException, InvalidRequestException, InvalidEncodingException, TextSizeLimitExceededException, AwsServiceException, SdkClientException, ComprehendMedicalException
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
This is a convenience which creates an instance of the
InferSnomedctRequest.Builderavoiding the need to create one manually viaInferSnomedctRequest.builder()- Parameters:
inferSnomedctRequest- AConsumerthat will call methods onInferSnomedctRequest.Builderto create a request.- Returns:
- Result of the InferSNOMEDCT 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.Builderavoiding the need to create one manually viaListEntitiesDetectionV2JobsRequest.builder()- Parameters:
listEntitiesDetectionV2JobsRequest- AConsumerthat will call methods onListEntitiesDetectionV2JobsRequest.Builderto 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
-
listICD10CMInferenceJobs
default ListIcd10CmInferenceJobsResponse listICD10CMInferenceJobs(ListIcd10CmInferenceJobsRequest listIcd10CmInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferICD10CM jobs that you have submitted.
- Parameters:
listIcd10CmInferenceJobsRequest-- Returns:
- Result of the ListICD10CMInferenceJobs 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
-
listICD10CMInferenceJobs
default ListIcd10CmInferenceJobsResponse listICD10CMInferenceJobs(Consumer<ListIcd10CmInferenceJobsRequest.Builder> listIcd10CmInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferICD10CM jobs that you have submitted.
This is a convenience which creates an instance of the
ListIcd10CmInferenceJobsRequest.Builderavoiding the need to create one manually viaListIcd10CmInferenceJobsRequest.builder()- Parameters:
listIcd10CmInferenceJobsRequest- AConsumerthat will call methods onListIcd10CmInferenceJobsRequest.Builderto create a request.- Returns:
- Result of the ListICD10CMInferenceJobs 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 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 you have submitted.
This is a convenience which creates an instance of the
ListPhiDetectionJobsRequest.Builderavoiding the need to create one manually viaListPhiDetectionJobsRequest.builder()- Parameters:
listPhiDetectionJobsRequest- AConsumerthat will call methods onListPhiDetectionJobsRequest.Builderto 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
-
listRxNormInferenceJobs
default ListRxNormInferenceJobsResponse listRxNormInferenceJobs(ListRxNormInferenceJobsRequest listRxNormInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferRxNorm jobs that you have submitted.
- Parameters:
listRxNormInferenceJobsRequest-- Returns:
- Result of the ListRxNormInferenceJobs 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
-
listRxNormInferenceJobs
default ListRxNormInferenceJobsResponse listRxNormInferenceJobs(Consumer<ListRxNormInferenceJobsRequest.Builder> listRxNormInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferRxNorm jobs that you have submitted.
This is a convenience which creates an instance of the
ListRxNormInferenceJobsRequest.Builderavoiding the need to create one manually viaListRxNormInferenceJobsRequest.builder()- Parameters:
listRxNormInferenceJobsRequest- AConsumerthat will call methods onListRxNormInferenceJobsRequest.Builderto create a request.- Returns:
- Result of the ListRxNormInferenceJobs 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
-
listSNOMEDCTInferenceJobs
default ListSnomedctInferenceJobsResponse listSNOMEDCTInferenceJobs(ListSnomedctInferenceJobsRequest listSnomedctInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferSNOMEDCT jobs a user has submitted.
- Parameters:
listSnomedctInferenceJobsRequest-- Returns:
- Result of the ListSNOMEDCTInferenceJobs 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
-
listSNOMEDCTInferenceJobs
default ListSnomedctInferenceJobsResponse listSNOMEDCTInferenceJobs(Consumer<ListSnomedctInferenceJobsRequest.Builder> listSnomedctInferenceJobsRequest) throws InvalidRequestException, ValidationException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Gets a list of InferSNOMEDCT jobs a user has submitted.
This is a convenience which creates an instance of the
ListSnomedctInferenceJobsRequest.Builderavoiding the need to create one manually viaListSnomedctInferenceJobsRequest.builder()- Parameters:
listSnomedctInferenceJobsRequest- AConsumerthat will call methods onListSnomedctInferenceJobsRequest.Builderto create a request.- Returns:
- Result of the ListSNOMEDCTInferenceJobs 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
DescribeEntitiesDetectionV2Joboperation 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
DescribeEntitiesDetectionV2Joboperation to track the status of a job.
This is a convenience which creates an instance of the
StartEntitiesDetectionV2JobRequest.Builderavoiding the need to create one manually viaStartEntitiesDetectionV2JobRequest.builder()- Parameters:
startEntitiesDetectionV2JobRequest- AConsumerthat will call methods onStartEntitiesDetectionV2JobRequest.Builderto 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
-
startICD10CMInferenceJob
default StartIcd10CmInferenceJobResponse startICD10CMInferenceJob(StartIcd10CmInferenceJobRequest startIcd10CmInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the
DescribeICD10CMInferenceJoboperation to track the status of a job.- Parameters:
startIcd10CmInferenceJobRequest-- Returns:
- Result of the StartICD10CMInferenceJob 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
-
startICD10CMInferenceJob
default StartIcd10CmInferenceJobResponse startICD10CMInferenceJob(Consumer<StartIcd10CmInferenceJobRequest.Builder> startIcd10CmInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the
DescribeICD10CMInferenceJoboperation to track the status of a job.
This is a convenience which creates an instance of the
StartIcd10CmInferenceJobRequest.Builderavoiding the need to create one manually viaStartIcd10CmInferenceJobRequest.builder()- Parameters:
startIcd10CmInferenceJobRequest- AConsumerthat will call methods onStartIcd10CmInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StartICD10CMInferenceJob 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
DescribePHIDetectionJoboperation 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
DescribePHIDetectionJoboperation to track the status of a job.
This is a convenience which creates an instance of the
StartPhiDetectionJobRequest.Builderavoiding the need to create one manually viaStartPhiDetectionJobRequest.builder()- Parameters:
startPhiDetectionJobRequest- AConsumerthat will call methods onStartPhiDetectionJobRequest.Builderto 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
-
startRxNormInferenceJob
default StartRxNormInferenceJobResponse startRxNormInferenceJob(StartRxNormInferenceJobRequest startRxNormInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the
DescribeRxNormInferenceJoboperation to track the status of a job.- Parameters:
startRxNormInferenceJobRequest-- Returns:
- Result of the StartRxNormInferenceJob 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
-
startRxNormInferenceJob
default StartRxNormInferenceJobResponse startRxNormInferenceJob(Consumer<StartRxNormInferenceJobRequest.Builder> startRxNormInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the
DescribeRxNormInferenceJoboperation to track the status of a job.
This is a convenience which creates an instance of the
StartRxNormInferenceJobRequest.Builderavoiding the need to create one manually viaStartRxNormInferenceJobRequest.builder()- Parameters:
startRxNormInferenceJobRequest- AConsumerthat will call methods onStartRxNormInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StartRxNormInferenceJob 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
-
startSNOMEDCTInferenceJob
default StartSnomedctInferenceJobResponse startSNOMEDCTInferenceJob(StartSnomedctInferenceJobRequest startSnomedctInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
- Parameters:
startSnomedctInferenceJobRequest-- Returns:
- Result of the StartSNOMEDCTInferenceJob 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
-
startSNOMEDCTInferenceJob
default StartSnomedctInferenceJobResponse startSNOMEDCTInferenceJob(Consumer<StartSnomedctInferenceJobRequest.Builder> startSnomedctInferenceJobRequest) throws InvalidRequestException, TooManyRequestsException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
This is a convenience which creates an instance of the
StartSnomedctInferenceJobRequest.Builderavoiding the need to create one manually viaStartSnomedctInferenceJobRequest.builder()- Parameters:
startSnomedctInferenceJobRequest- AConsumerthat will call methods onStartSnomedctInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StartSNOMEDCTInferenceJob 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.Builderavoiding the need to create one manually viaStopEntitiesDetectionV2JobRequest.builder()- Parameters:
stopEntitiesDetectionV2JobRequest- AConsumerthat will call methods onStopEntitiesDetectionV2JobRequest.Builderto 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
-
stopICD10CMInferenceJob
default StopIcd10CmInferenceJobResponse stopICD10CMInferenceJob(StopIcd10CmInferenceJobRequest stopIcd10CmInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferICD10CM inference job in progress.
- Parameters:
stopIcd10CmInferenceJobRequest-- Returns:
- Result of the StopICD10CMInferenceJob 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
-
stopICD10CMInferenceJob
default StopIcd10CmInferenceJobResponse stopICD10CMInferenceJob(Consumer<StopIcd10CmInferenceJobRequest.Builder> stopIcd10CmInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferICD10CM inference job in progress.
This is a convenience which creates an instance of the
StopIcd10CmInferenceJobRequest.Builderavoiding the need to create one manually viaStopIcd10CmInferenceJobRequest.builder()- Parameters:
stopIcd10CmInferenceJobRequest- AConsumerthat will call methods onStopIcd10CmInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StopICD10CMInferenceJob 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.Builderavoiding the need to create one manually viaStopPhiDetectionJobRequest.builder()- Parameters:
stopPhiDetectionJobRequest- AConsumerthat will call methods onStopPhiDetectionJobRequest.Builderto 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
-
stopRxNormInferenceJob
default StopRxNormInferenceJobResponse stopRxNormInferenceJob(StopRxNormInferenceJobRequest stopRxNormInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferRxNorm inference job in progress.
- Parameters:
stopRxNormInferenceJobRequest-- Returns:
- Result of the StopRxNormInferenceJob 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
-
stopRxNormInferenceJob
default StopRxNormInferenceJobResponse stopRxNormInferenceJob(Consumer<StopRxNormInferenceJobRequest.Builder> stopRxNormInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferRxNorm inference job in progress.
This is a convenience which creates an instance of the
StopRxNormInferenceJobRequest.Builderavoiding the need to create one manually viaStopRxNormInferenceJobRequest.builder()- Parameters:
stopRxNormInferenceJobRequest- AConsumerthat will call methods onStopRxNormInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StopRxNormInferenceJob 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
-
stopSNOMEDCTInferenceJob
default StopSnomedctInferenceJobResponse stopSNOMEDCTInferenceJob(StopSnomedctInferenceJobRequest stopSnomedctInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferSNOMEDCT inference job in progress.
- Parameters:
stopSnomedctInferenceJobRequest-- Returns:
- Result of the StopSNOMEDCTInferenceJob 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.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
-
stopSNOMEDCTInferenceJob
default StopSnomedctInferenceJobResponse stopSNOMEDCTInferenceJob(Consumer<StopSnomedctInferenceJobRequest.Builder> stopSnomedctInferenceJobRequest) throws InvalidRequestException, ResourceNotFoundException, TooManyRequestsException, InternalServerException, AwsServiceException, SdkClientException, ComprehendMedicalException
Stops an InferSNOMEDCT inference job in progress.
This is a convenience which creates an instance of the
StopSnomedctInferenceJobRequest.Builderavoiding the need to create one manually viaStopSnomedctInferenceJobRequest.builder()- Parameters:
stopSnomedctInferenceJobRequest- AConsumerthat will call methods onStopSnomedctInferenceJobRequest.Builderto create a request.- Returns:
- Result of the StopSNOMEDCTInferenceJob 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.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
-
create
static ComprehendMedicalClient create()
Create aComprehendMedicalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ComprehendMedicalClientBuilder builder()
Create a builder that can be used to configure and create aComprehendMedicalClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ComprehendMedicalServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-