Skip to content

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)
    ...
  1. See DescribeEntitiesDetectionV2JobResponseTypeDef
# describe_entities_detection_v2_job method usage example with argument unpacking

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 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)
    ...
  1. See DescribeICD10CMInferenceJobResponseTypeDef
# describe_icd10_cm_inference_job method usage example with argument unpacking

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 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)
    ...
  1. See DescribePHIDetectionJobResponseTypeDef
# describe_phi_detection_job method usage example with argument unpacking

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 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)
    ...
  1. See DescribeRxNormInferenceJobResponseTypeDef
# describe_rx_norm_inference_job method usage example with argument unpacking

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 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)
    ...
  1. See DescribeSNOMEDCTInferenceJobResponseTypeDef
# describe_snomedct_inference_job method usage example with argument unpacking

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

# detect_entities method definition

def detect_entities(
    self,
    *,
    Text: str,
) -> DetectEntitiesResponseTypeDef:  # (1)
    ...
  1. See DetectEntitiesResponseTypeDef
# detect_entities method usage example with argument unpacking

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

# detect_entities_v2 method definition

def detect_entities_v2(
    self,
    *,
    Text: str,
) -> DetectEntitiesV2ResponseTypeDef:  # (1)
    ...
  1. See DetectEntitiesV2ResponseTypeDef
# detect_entities_v2 method usage example with argument unpacking

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

# detect_phi method definition

def detect_phi(
    self,
    *,
    Text: str,
) -> DetectPHIResponseTypeDef:  # (1)
    ...
  1. See DetectPHIResponseTypeDef
# detect_phi method usage example with argument unpacking

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