ComprehendMedicalClient

Index > ComprehendMedical > ComprehendMedicalClient

Auto-generated documentation for ComprehendMedical type annotations stubs module types-aiobotocore-comprehendmedical.

ComprehendMedicalClient

Type annotations and code completion for session.client("comprehendmedical") boto3 documentation

Usage example

from aioboto3.session import Session
from types_aiobotocore_comprehendmedical.client import ComprehendMedicalClient

session = Session()
async with session.client("comprehendmedical") as client:
    client: ComprehendMedicalClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("comprehendmedical").exceptions structure.

Usage example

async with session.client("comprehendmedical") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.InternalServerException,
        client.InvalidEncodingException,
        client.InvalidRequestException,
        client.ResourceNotFoundException,
        client.ServiceUnavailableException,
        client.TextSizeLimitExceededException,
        client.TooManyRequestsException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("comprehendmedical").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.client("comprehendmedical").close method. boto3 documentation

Method definition

await 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 session.client("comprehendmedical").describe_entities_detection_v2_job method. boto3 documentation

Method definition

await def describe_entities_detection_v2_job(
    self,
    *,
    JobId: str,
) -> DescribeEntitiesDetectionV2JobResponseTypeDef:  # (1)
    ...

1. See DescribeEntitiesDetectionV2JobResponseTypeDef

Usage example with kwargs

kwargs: DescribeEntitiesDetectionV2JobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_entities_detection_v2_job(**kwargs)

1. See DescribeEntitiesDetectionV2JobRequestRequestTypeDef

describe_icd10_cm_inference_job

Gets the properties associated with an InferICD10CM job.

Type annotations and code completion for session.client("comprehendmedical").describe_icd10_cm_inference_job method. boto3 documentation

Method definition

await def describe_icd10_cm_inference_job(
    self,
    *,
    JobId: str,
) -> DescribeICD10CMInferenceJobResponseTypeDef:  # (1)
    ...

1. See DescribeICD10CMInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeICD10CMInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_icd10_cm_inference_job(**kwargs)

1. See DescribeICD10CMInferenceJobRequestRequestTypeDef

describe_phi_detection_job

Gets the properties associated with a protected health information (PHI) detection job.

Type annotations and code completion for session.client("comprehendmedical").describe_phi_detection_job method. boto3 documentation

Method definition

await def describe_phi_detection_job(
    self,
    *,
    JobId: str,
) -> DescribePHIDetectionJobResponseTypeDef:  # (1)
    ...

1. See DescribePHIDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: DescribePHIDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_phi_detection_job(**kwargs)

1. See DescribePHIDetectionJobRequestRequestTypeDef

describe_rx_norm_inference_job

Gets the properties associated with an InferRxNorm job.

Type annotations and code completion for session.client("comprehendmedical").describe_rx_norm_inference_job method. boto3 documentation

Method definition

await def describe_rx_norm_inference_job(
    self,
    *,
    JobId: str,
) -> DescribeRxNormInferenceJobResponseTypeDef:  # (1)
    ...

1. See DescribeRxNormInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeRxNormInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_rx_norm_inference_job(**kwargs)

1. See DescribeRxNormInferenceJobRequestRequestTypeDef

describe_snomedct_inference_job

Gets the properties associated with an InferSNOMEDCT job.

Type annotations and code completion for session.client("comprehendmedical").describe_snomedct_inference_job method. boto3 documentation

Method definition

await def describe_snomedct_inference_job(
    self,
    *,
    JobId: str,
) -> DescribeSNOMEDCTInferenceJobResponseTypeDef:  # (1)
    ...

1. See DescribeSNOMEDCTInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeSNOMEDCTInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_snomedct_inference_job(**kwargs)

1. See DescribeSNOMEDCTInferenceJobRequestRequestTypeDef

detect_entities

The DetectEntities operation is deprecated.

Type annotations and code completion for session.client("comprehendmedical").detect_entities method. boto3 documentation

Method definition

await def detect_entities(
    self,
    *,
    Text: str,
) -> DetectEntitiesResponseTypeDef:  # (1)
    ...

1. See DetectEntitiesResponseTypeDef

Usage example with kwargs

kwargs: DetectEntitiesRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.detect_entities(**kwargs)

1. See DetectEntitiesRequestRequestTypeDef

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 session.client("comprehendmedical").detect_entities_v2 method. boto3 documentation

Method definition

await def detect_entities_v2(
    self,
    *,
    Text: str,
) -> DetectEntitiesV2ResponseTypeDef:  # (1)
    ...

1. See DetectEntitiesV2ResponseTypeDef

Usage example with kwargs

kwargs: DetectEntitiesV2RequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.detect_entities_v2(**kwargs)

1. See DetectEntitiesV2RequestRequestTypeDef

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 session.client("comprehendmedical").detect_phi method. boto3 documentation

Method definition

await def detect_phi(
    self,
    *,
    Text: str,
) -> DetectPHIResponseTypeDef:  # (1)
    ...

1. See DetectPHIResponseTypeDef

Usage example with kwargs

kwargs: DetectPHIRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.detect_phi(**kwargs)

1. See DetectPHIRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.client("comprehendmedical").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("comprehendmedical").infer_icd10_cm method. boto3 documentation

Method definition

await def infer_icd10_cm(
    self,
    *,
    Text: str,
) -> InferICD10CMResponseTypeDef:  # (1)
    ...

1. See InferICD10CMResponseTypeDef

Usage example with kwargs

kwargs: InferICD10CMRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.infer_icd10_cm(**kwargs)

1. See InferICD10CMRequestRequestTypeDef

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 session.client("comprehendmedical").infer_rx_norm method. boto3 documentation

Method definition

await def infer_rx_norm(
    self,
    *,
    Text: str,
) -> InferRxNormResponseTypeDef:  # (1)
    ...

1. See InferRxNormResponseTypeDef

Usage example with kwargs

kwargs: InferRxNormRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.infer_rx_norm(**kwargs)

1. See InferRxNormRequestRequestTypeDef

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 session.client("comprehendmedical").infer_snomedct method. boto3 documentation

Method definition

await def infer_snomedct(
    self,
    *,
    Text: str,
) -> InferSNOMEDCTResponseTypeDef:  # (1)
    ...

1. See InferSNOMEDCTResponseTypeDef

Usage example with kwargs

kwargs: InferSNOMEDCTRequestRequestTypeDef = {  # (1)
    "Text": ...,
}

parent.infer_snomedct(**kwargs)

1. See InferSNOMEDCTRequestRequestTypeDef

list_entities_detection_v2_jobs

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

Type annotations and code completion for session.client("comprehendmedical").list_entities_detection_v2_jobs method. boto3 documentation

Method definition

await def list_entities_detection_v2_jobs(
    self,
    *,
    Filter: ComprehendMedicalAsyncJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntitiesDetectionV2JobsResponseTypeDef:  # (2)
    ...

1. See ComprehendMedicalAsyncJobFilterTypeDef
2. See ListEntitiesDetectionV2JobsResponseTypeDef

Usage example with kwargs

kwargs: ListEntitiesDetectionV2JobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_entities_detection_v2_jobs(**kwargs)

1. See ListEntitiesDetectionV2JobsRequestRequestTypeDef

list_icd10_cm_inference_jobs

Gets a list of InferICD10CM jobs that you have submitted.

Type annotations and code completion for session.client("comprehendmedical").list_icd10_cm_inference_jobs method. boto3 documentation

Method definition

await def list_icd10_cm_inference_jobs(
    self,
    *,
    Filter: ComprehendMedicalAsyncJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListICD10CMInferenceJobsResponseTypeDef:  # (2)
    ...

1. See ComprehendMedicalAsyncJobFilterTypeDef
2. See ListICD10CMInferenceJobsResponseTypeDef

Usage example with kwargs

kwargs: ListICD10CMInferenceJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_icd10_cm_inference_jobs(**kwargs)

1. See ListICD10CMInferenceJobsRequestRequestTypeDef

list_phi_detection_jobs

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

Type annotations and code completion for session.client("comprehendmedical").list_phi_detection_jobs method. boto3 documentation

Method definition

await def list_phi_detection_jobs(
    self,
    *,
    Filter: ComprehendMedicalAsyncJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPHIDetectionJobsResponseTypeDef:  # (2)
    ...

1. See ComprehendMedicalAsyncJobFilterTypeDef
2. See ListPHIDetectionJobsResponseTypeDef

Usage example with kwargs

kwargs: ListPHIDetectionJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_phi_detection_jobs(**kwargs)

1. See ListPHIDetectionJobsRequestRequestTypeDef

list_rx_norm_inference_jobs

Gets a list of InferRxNorm jobs that you have submitted.

Type annotations and code completion for session.client("comprehendmedical").list_rx_norm_inference_jobs method. boto3 documentation

Method definition

await def list_rx_norm_inference_jobs(
    self,
    *,
    Filter: ComprehendMedicalAsyncJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRxNormInferenceJobsResponseTypeDef:  # (2)
    ...

1. See ComprehendMedicalAsyncJobFilterTypeDef
2. See ListRxNormInferenceJobsResponseTypeDef

Usage example with kwargs

kwargs: ListRxNormInferenceJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_rx_norm_inference_jobs(**kwargs)

1. See ListRxNormInferenceJobsRequestRequestTypeDef

list_snomedct_inference_jobs

Gets a list of InferSNOMEDCT jobs a user has submitted.

Type annotations and code completion for session.client("comprehendmedical").list_snomedct_inference_jobs method. boto3 documentation

Method definition

await def list_snomedct_inference_jobs(
    self,
    *,
    Filter: ComprehendMedicalAsyncJobFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSNOMEDCTInferenceJobsResponseTypeDef:  # (2)
    ...

1. See ComprehendMedicalAsyncJobFilterTypeDef
2. See ListSNOMEDCTInferenceJobsResponseTypeDef

Usage example with kwargs

kwargs: ListSNOMEDCTInferenceJobsRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_snomedct_inference_jobs(**kwargs)

1. See ListSNOMEDCTInferenceJobsRequestRequestTypeDef

start_entities_detection_v2_job

Starts an asynchronous medical entity detection job for a collection of documents.

Type annotations and code completion for session.client("comprehendmedical").start_entities_detection_v2_job method. boto3 documentation

Method definition

await 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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See StartEntitiesDetectionV2JobResponseTypeDef

Usage example with kwargs

kwargs: StartEntitiesDetectionV2JobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_entities_detection_v2_job(**kwargs)

1. See StartEntitiesDetectionV2JobRequestRequestTypeDef

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 session.client("comprehendmedical").start_icd10_cm_inference_job method. boto3 documentation

Method definition

await 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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See StartICD10CMInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StartICD10CMInferenceJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_icd10_cm_inference_job(**kwargs)

1. See StartICD10CMInferenceJobRequestRequestTypeDef

start_phi_detection_job

Starts an asynchronous job to detect protected health information (PHI).

Type annotations and code completion for session.client("comprehendmedical").start_phi_detection_job method. boto3 documentation

Method definition

await 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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See StartPHIDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StartPHIDetectionJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_phi_detection_job(**kwargs)

1. See StartPHIDetectionJobRequestRequestTypeDef

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 session.client("comprehendmedical").start_rx_norm_inference_job method. boto3 documentation

Method definition

await 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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See StartRxNormInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StartRxNormInferenceJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_rx_norm_inference_job(**kwargs)

1. See StartRxNormInferenceJobRequestRequestTypeDef

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 session.client("comprehendmedical").start_snomedct_inference_job method. boto3 documentation

Method definition

await 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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See LanguageCodeType
4. See StartSNOMEDCTInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StartSNOMEDCTInferenceJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "DataAccessRoleArn": ...,
    "LanguageCode": ...,
}

parent.start_snomedct_inference_job(**kwargs)

1. See StartSNOMEDCTInferenceJobRequestRequestTypeDef

stop_entities_detection_v2_job

Stops a medical entities detection job in progress.

Type annotations and code completion for session.client("comprehendmedical").stop_entities_detection_v2_job method. boto3 documentation

Method definition

await def stop_entities_detection_v2_job(
    self,
    *,
    JobId: str,
) -> StopEntitiesDetectionV2JobResponseTypeDef:  # (1)
    ...

1. See StopEntitiesDetectionV2JobResponseTypeDef

Usage example with kwargs

kwargs: StopEntitiesDetectionV2JobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_entities_detection_v2_job(**kwargs)

1. See StopEntitiesDetectionV2JobRequestRequestTypeDef

stop_icd10_cm_inference_job

Stops an InferICD10CM inference job in progress.

Type annotations and code completion for session.client("comprehendmedical").stop_icd10_cm_inference_job method. boto3 documentation

Method definition

await def stop_icd10_cm_inference_job(
    self,
    *,
    JobId: str,
) -> StopICD10CMInferenceJobResponseTypeDef:  # (1)
    ...

1. See StopICD10CMInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StopICD10CMInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_icd10_cm_inference_job(**kwargs)

1. See StopICD10CMInferenceJobRequestRequestTypeDef

stop_phi_detection_job

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

Type annotations and code completion for session.client("comprehendmedical").stop_phi_detection_job method. boto3 documentation

Method definition

await def stop_phi_detection_job(
    self,
    *,
    JobId: str,
) -> StopPHIDetectionJobResponseTypeDef:  # (1)
    ...

1. See StopPHIDetectionJobResponseTypeDef

Usage example with kwargs

kwargs: StopPHIDetectionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_phi_detection_job(**kwargs)

1. See StopPHIDetectionJobRequestRequestTypeDef

stop_rx_norm_inference_job

Stops an InferRxNorm inference job in progress.

Type annotations and code completion for session.client("comprehendmedical").stop_rx_norm_inference_job method. boto3 documentation

Method definition

await def stop_rx_norm_inference_job(
    self,
    *,
    JobId: str,
) -> StopRxNormInferenceJobResponseTypeDef:  # (1)
    ...

1. See StopRxNormInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StopRxNormInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_rx_norm_inference_job(**kwargs)

1. See StopRxNormInferenceJobRequestRequestTypeDef

stop_snomedct_inference_job

Stops an InferSNOMEDCT inference job in progress.

Type annotations and code completion for session.client("comprehendmedical").stop_snomedct_inference_job method. boto3 documentation

Method definition

await def stop_snomedct_inference_job(
    self,
    *,
    JobId: str,
) -> StopSNOMEDCTInferenceJobResponseTypeDef:  # (1)
    ...

1. See StopSNOMEDCTInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: StopSNOMEDCTInferenceJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.stop_snomedct_inference_job(**kwargs)

1. See StopSNOMEDCTInferenceJobRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("comprehendmedical").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> ComprehendMedicalClient:
    ...

__aexit__

Type annotations and code completion for session.client("comprehendmedical").__aexit__ method. boto3 documentation

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...