ComprehendMedicalClient#
Index > ComprehendMedical > ComprehendMedicalClient
Auto-generated documentation for ComprehendMedical type annotations stubs module mypy-boto3-comprehendmedical.
ComprehendMedicalClient#
Type annotations and code completion for boto3.client("comprehendmedical")
.
boto3 documentation
# ComprehendMedicalClient usage example
from boto3.session import Session
from mypy_boto3_comprehendmedical.client import ComprehendMedicalClient
def get_comprehendmedical_client() -> ComprehendMedicalClient:
return Session().client("comprehendmedical")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("comprehendmedical").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("comprehendmedical")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.InvalidEncodingException,
client.exceptions.InvalidRequestException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
client.exceptions.TextSizeLimitExceededException,
client.exceptions.TooManyRequestsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_comprehendmedical.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("comprehendmedical").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("comprehendmedical").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
describe_entities_detection_v2_job#
Gets the properties associated with a medical entities detection job.
Type annotations and code completion for boto3.client("comprehendmedical").describe_entities_detection_v2_job
method.
boto3 documentation
# describe_entities_detection_v2_job method definition
def describe_entities_detection_v2_job(
self,
*,
JobId: str,
) -> DescribeEntitiesDetectionV2JobResponseTypeDef: # (1)
...
# describe_entities_detection_v2_job method usage example with argument unpacking
kwargs: DescribeEntitiesDetectionV2JobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_entities_detection_v2_job(**kwargs)
describe_icd10_cm_inference_job#
Gets the properties associated with an InferICD10CM job.
Type annotations and code completion for boto3.client("comprehendmedical").describe_icd10_cm_inference_job
method.
boto3 documentation
# describe_icd10_cm_inference_job method definition
def describe_icd10_cm_inference_job(
self,
*,
JobId: str,
) -> DescribeICD10CMInferenceJobResponseTypeDef: # (1)
...
# describe_icd10_cm_inference_job method usage example with argument unpacking
kwargs: DescribeICD10CMInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_icd10_cm_inference_job(**kwargs)
describe_phi_detection_job#
Gets the properties associated with a protected health information (PHI) detection job.
Type annotations and code completion for boto3.client("comprehendmedical").describe_phi_detection_job
method.
boto3 documentation
# describe_phi_detection_job method definition
def describe_phi_detection_job(
self,
*,
JobId: str,
) -> DescribePHIDetectionJobResponseTypeDef: # (1)
...
# describe_phi_detection_job method usage example with argument unpacking
kwargs: DescribePHIDetectionJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_phi_detection_job(**kwargs)
describe_rx_norm_inference_job#
Gets the properties associated with an InferRxNorm job.
Type annotations and code completion for boto3.client("comprehendmedical").describe_rx_norm_inference_job
method.
boto3 documentation
# describe_rx_norm_inference_job method definition
def describe_rx_norm_inference_job(
self,
*,
JobId: str,
) -> DescribeRxNormInferenceJobResponseTypeDef: # (1)
...
# describe_rx_norm_inference_job method usage example with argument unpacking
kwargs: DescribeRxNormInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_rx_norm_inference_job(**kwargs)
describe_snomedct_inference_job#
Gets the properties associated with an InferSNOMEDCT job.
Type annotations and code completion for boto3.client("comprehendmedical").describe_snomedct_inference_job
method.
boto3 documentation
# describe_snomedct_inference_job method definition
def describe_snomedct_inference_job(
self,
*,
JobId: str,
) -> DescribeSNOMEDCTInferenceJobResponseTypeDef: # (1)
...
# describe_snomedct_inference_job method usage example with argument unpacking
kwargs: DescribeSNOMEDCTInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_snomedct_inference_job(**kwargs)
detect_entities#
The DetectEntities
operation is deprecated.
Type annotations and code completion for boto3.client("comprehendmedical").detect_entities
method.
boto3 documentation
# detect_entities method definition
def detect_entities(
self,
*,
Text: str,
) -> DetectEntitiesResponseTypeDef: # (1)
...
# detect_entities method usage example with argument unpacking
kwargs: DetectEntitiesRequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.detect_entities(**kwargs)
detect_entities_v2#
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.
Type annotations and code completion for boto3.client("comprehendmedical").detect_entities_v2
method.
boto3 documentation
# detect_entities_v2 method definition
def detect_entities_v2(
self,
*,
Text: str,
) -> DetectEntitiesV2ResponseTypeDef: # (1)
...
# detect_entities_v2 method usage example with argument unpacking
kwargs: DetectEntitiesV2RequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.detect_entities_v2(**kwargs)
detect_phi#
Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.
Type annotations and code completion for boto3.client("comprehendmedical").detect_phi
method.
boto3 documentation
# detect_phi method definition
def detect_phi(
self,
*,
Text: str,
) -> DetectPHIResponseTypeDef: # (1)
...
# detect_phi method usage example with argument unpacking
kwargs: DetectPHIRequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.detect_phi(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("comprehendmedical").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
infer_icd10_cm#
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.
Type annotations and code completion for boto3.client("comprehendmedical").infer_icd10_cm
method.
boto3 documentation
# infer_icd10_cm method definition
def infer_icd10_cm(
self,
*,
Text: str,
) -> InferICD10CMResponseTypeDef: # (1)
...
# infer_icd10_cm method usage example with argument unpacking
kwargs: InferICD10CMRequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.infer_icd10_cm(**kwargs)
infer_rx_norm#
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.
Type annotations and code completion for boto3.client("comprehendmedical").infer_rx_norm
method.
boto3 documentation
# infer_rx_norm method definition
def infer_rx_norm(
self,
*,
Text: str,
) -> InferRxNormResponseTypeDef: # (1)
...
# infer_rx_norm method usage example with argument unpacking
kwargs: InferRxNormRequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.infer_rx_norm(**kwargs)
infer_snomedct#
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology See also: AWS API Documentation **Re...
Type annotations and code completion for boto3.client("comprehendmedical").infer_snomedct
method.
boto3 documentation
# infer_snomedct method definition
def infer_snomedct(
self,
*,
Text: str,
) -> InferSNOMEDCTResponseTypeDef: # (1)
...
# infer_snomedct method usage example with argument unpacking
kwargs: InferSNOMEDCTRequestRequestTypeDef = { # (1)
"Text": ...,
}
parent.infer_snomedct(**kwargs)
list_entities_detection_v2_jobs#
Gets a list of medical entity detection jobs that you have submitted.
Type annotations and code completion for boto3.client("comprehendmedical").list_entities_detection_v2_jobs
method.
boto3 documentation
# list_entities_detection_v2_jobs method definition
def list_entities_detection_v2_jobs(
self,
*,
Filter: ComprehendMedicalAsyncJobFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEntitiesDetectionV2JobsResponseTypeDef: # (2)
...
# list_entities_detection_v2_jobs method usage example with argument unpacking
kwargs: ListEntitiesDetectionV2JobsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_entities_detection_v2_jobs(**kwargs)
list_icd10_cm_inference_jobs#
Gets a list of InferICD10CM jobs that you have submitted.
Type annotations and code completion for boto3.client("comprehendmedical").list_icd10_cm_inference_jobs
method.
boto3 documentation
# list_icd10_cm_inference_jobs method definition
def list_icd10_cm_inference_jobs(
self,
*,
Filter: ComprehendMedicalAsyncJobFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListICD10CMInferenceJobsResponseTypeDef: # (2)
...
# list_icd10_cm_inference_jobs method usage example with argument unpacking
kwargs: ListICD10CMInferenceJobsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_icd10_cm_inference_jobs(**kwargs)
list_phi_detection_jobs#
Gets a list of protected health information (PHI) detection jobs you have submitted.
Type annotations and code completion for boto3.client("comprehendmedical").list_phi_detection_jobs
method.
boto3 documentation
# list_phi_detection_jobs method definition
def list_phi_detection_jobs(
self,
*,
Filter: ComprehendMedicalAsyncJobFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPHIDetectionJobsResponseTypeDef: # (2)
...
# list_phi_detection_jobs method usage example with argument unpacking
kwargs: ListPHIDetectionJobsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_phi_detection_jobs(**kwargs)
list_rx_norm_inference_jobs#
Gets a list of InferRxNorm jobs that you have submitted.
Type annotations and code completion for boto3.client("comprehendmedical").list_rx_norm_inference_jobs
method.
boto3 documentation
# list_rx_norm_inference_jobs method definition
def list_rx_norm_inference_jobs(
self,
*,
Filter: ComprehendMedicalAsyncJobFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRxNormInferenceJobsResponseTypeDef: # (2)
...
# list_rx_norm_inference_jobs method usage example with argument unpacking
kwargs: ListRxNormInferenceJobsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_rx_norm_inference_jobs(**kwargs)
list_snomedct_inference_jobs#
Gets a list of InferSNOMEDCT jobs a user has submitted.
Type annotations and code completion for boto3.client("comprehendmedical").list_snomedct_inference_jobs
method.
boto3 documentation
# list_snomedct_inference_jobs method definition
def list_snomedct_inference_jobs(
self,
*,
Filter: ComprehendMedicalAsyncJobFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSNOMEDCTInferenceJobsResponseTypeDef: # (2)
...
# list_snomedct_inference_jobs method usage example with argument unpacking
kwargs: ListSNOMEDCTInferenceJobsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_snomedct_inference_jobs(**kwargs)
start_entities_detection_v2_job#
Starts an asynchronous medical entity detection job for a collection of documents.
Type annotations and code completion for boto3.client("comprehendmedical").start_entities_detection_v2_job
method.
boto3 documentation
# start_entities_detection_v2_job method definition
def start_entities_detection_v2_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
LanguageCode: LanguageCodeType, # (3)
JobName: str = ...,
ClientRequestToken: str = ...,
KMSKey: str = ...,
) -> StartEntitiesDetectionV2JobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See LanguageCodeType
- See StartEntitiesDetectionV2JobResponseTypeDef
# start_entities_detection_v2_job method usage example with argument unpacking
kwargs: StartEntitiesDetectionV2JobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"LanguageCode": ...,
}
parent.start_entities_detection_v2_job(**kwargs)
start_icd10_cm_inference_job#
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
Type annotations and code completion for boto3.client("comprehendmedical").start_icd10_cm_inference_job
method.
boto3 documentation
# start_icd10_cm_inference_job method definition
def start_icd10_cm_inference_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
LanguageCode: LanguageCodeType, # (3)
JobName: str = ...,
ClientRequestToken: str = ...,
KMSKey: str = ...,
) -> StartICD10CMInferenceJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See LanguageCodeType
- See StartICD10CMInferenceJobResponseTypeDef
# start_icd10_cm_inference_job method usage example with argument unpacking
kwargs: StartICD10CMInferenceJobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"LanguageCode": ...,
}
parent.start_icd10_cm_inference_job(**kwargs)
start_phi_detection_job#
Starts an asynchronous job to detect protected health information (PHI).
Type annotations and code completion for boto3.client("comprehendmedical").start_phi_detection_job
method.
boto3 documentation
# start_phi_detection_job method definition
def start_phi_detection_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
LanguageCode: LanguageCodeType, # (3)
JobName: str = ...,
ClientRequestToken: str = ...,
KMSKey: str = ...,
) -> StartPHIDetectionJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See LanguageCodeType
- See StartPHIDetectionJobResponseTypeDef
# start_phi_detection_job method usage example with argument unpacking
kwargs: StartPHIDetectionJobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"LanguageCode": ...,
}
parent.start_phi_detection_job(**kwargs)
start_rx_norm_inference_job#
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
Type annotations and code completion for boto3.client("comprehendmedical").start_rx_norm_inference_job
method.
boto3 documentation
# start_rx_norm_inference_job method definition
def start_rx_norm_inference_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
LanguageCode: LanguageCodeType, # (3)
JobName: str = ...,
ClientRequestToken: str = ...,
KMSKey: str = ...,
) -> StartRxNormInferenceJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See LanguageCodeType
- See StartRxNormInferenceJobResponseTypeDef
# start_rx_norm_inference_job method usage example with argument unpacking
kwargs: StartRxNormInferenceJobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"LanguageCode": ...,
}
parent.start_rx_norm_inference_job(**kwargs)
start_snomedct_inference_job#
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.
Type annotations and code completion for boto3.client("comprehendmedical").start_snomedct_inference_job
method.
boto3 documentation
# start_snomedct_inference_job method definition
def start_snomedct_inference_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
LanguageCode: LanguageCodeType, # (3)
JobName: str = ...,
ClientRequestToken: str = ...,
KMSKey: str = ...,
) -> StartSNOMEDCTInferenceJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See LanguageCodeType
- See StartSNOMEDCTInferenceJobResponseTypeDef
# start_snomedct_inference_job method usage example with argument unpacking
kwargs: StartSNOMEDCTInferenceJobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"LanguageCode": ...,
}
parent.start_snomedct_inference_job(**kwargs)
stop_entities_detection_v2_job#
Stops a medical entities detection job in progress.
Type annotations and code completion for boto3.client("comprehendmedical").stop_entities_detection_v2_job
method.
boto3 documentation
# stop_entities_detection_v2_job method definition
def stop_entities_detection_v2_job(
self,
*,
JobId: str,
) -> StopEntitiesDetectionV2JobResponseTypeDef: # (1)
...
# stop_entities_detection_v2_job method usage example with argument unpacking
kwargs: StopEntitiesDetectionV2JobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.stop_entities_detection_v2_job(**kwargs)
stop_icd10_cm_inference_job#
Stops an InferICD10CM inference job in progress.
Type annotations and code completion for boto3.client("comprehendmedical").stop_icd10_cm_inference_job
method.
boto3 documentation
# stop_icd10_cm_inference_job method definition
def stop_icd10_cm_inference_job(
self,
*,
JobId: str,
) -> StopICD10CMInferenceJobResponseTypeDef: # (1)
...
# stop_icd10_cm_inference_job method usage example with argument unpacking
kwargs: StopICD10CMInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.stop_icd10_cm_inference_job(**kwargs)
stop_phi_detection_job#
Stops a protected health information (PHI) detection job in progress.
Type annotations and code completion for boto3.client("comprehendmedical").stop_phi_detection_job
method.
boto3 documentation
# stop_phi_detection_job method definition
def stop_phi_detection_job(
self,
*,
JobId: str,
) -> StopPHIDetectionJobResponseTypeDef: # (1)
...
# stop_phi_detection_job method usage example with argument unpacking
kwargs: StopPHIDetectionJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.stop_phi_detection_job(**kwargs)
stop_rx_norm_inference_job#
Stops an InferRxNorm inference job in progress.
Type annotations and code completion for boto3.client("comprehendmedical").stop_rx_norm_inference_job
method.
boto3 documentation
# stop_rx_norm_inference_job method definition
def stop_rx_norm_inference_job(
self,
*,
JobId: str,
) -> StopRxNormInferenceJobResponseTypeDef: # (1)
...
# stop_rx_norm_inference_job method usage example with argument unpacking
kwargs: StopRxNormInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.stop_rx_norm_inference_job(**kwargs)
stop_snomedct_inference_job#
Stops an InferSNOMEDCT inference job in progress.
Type annotations and code completion for boto3.client("comprehendmedical").stop_snomedct_inference_job
method.
boto3 documentation
# stop_snomedct_inference_job method definition
def stop_snomedct_inference_job(
self,
*,
JobId: str,
) -> StopSNOMEDCTInferenceJobResponseTypeDef: # (1)
...
# stop_snomedct_inference_job method usage example with argument unpacking
kwargs: StopSNOMEDCTInferenceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.stop_snomedct_inference_job(**kwargs)