Skip to content

Type definitions#

Index > ComprehendMedical > Type definitions

Auto-generated documentation for ComprehendMedical type annotations stubs module mypy-boto3-comprehendmedical.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TraitTypeDef#

# TraitTypeDef definition

class TraitTypeDef(TypedDict):
    Name: NotRequired[AttributeNameType],  # (1)
    Score: NotRequired[float],
  1. See AttributeNameType

CharactersTypeDef#

# CharactersTypeDef definition

class CharactersTypeDef(TypedDict):
    OriginalTextCharacters: NotRequired[int],

InputDataConfigTypeDef#

# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    S3Bucket: str,
    S3Key: NotRequired[str],

OutputDataConfigTypeDef#

# OutputDataConfigTypeDef definition

class OutputDataConfigTypeDef(TypedDict):
    S3Bucket: str,
    S3Key: NotRequired[str],

DescribeEntitiesDetectionV2JobRequestRequestTypeDef#

# DescribeEntitiesDetectionV2JobRequestRequestTypeDef definition

class DescribeEntitiesDetectionV2JobRequestRequestTypeDef(TypedDict):
    JobId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DescribeICD10CMInferenceJobRequestRequestTypeDef#

# DescribeICD10CMInferenceJobRequestRequestTypeDef definition

class DescribeICD10CMInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePHIDetectionJobRequestRequestTypeDef#

# DescribePHIDetectionJobRequestRequestTypeDef definition

class DescribePHIDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeRxNormInferenceJobRequestRequestTypeDef#

# DescribeRxNormInferenceJobRequestRequestTypeDef definition

class DescribeRxNormInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeSNOMEDCTInferenceJobRequestRequestTypeDef#

# DescribeSNOMEDCTInferenceJobRequestRequestTypeDef definition

class DescribeSNOMEDCTInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectEntitiesRequestRequestTypeDef#

# DetectEntitiesRequestRequestTypeDef definition

class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,

DetectEntitiesV2RequestRequestTypeDef#

# DetectEntitiesV2RequestRequestTypeDef definition

class DetectEntitiesV2RequestRequestTypeDef(TypedDict):
    Text: str,

DetectPHIRequestRequestTypeDef#

# DetectPHIRequestRequestTypeDef definition

class DetectPHIRequestRequestTypeDef(TypedDict):
    Text: str,

ICD10CMTraitTypeDef#

# ICD10CMTraitTypeDef definition

class ICD10CMTraitTypeDef(TypedDict):
    Name: NotRequired[ICD10CMTraitNameType],  # (1)
    Score: NotRequired[float],
  1. See ICD10CMTraitNameType

ICD10CMConceptTypeDef#

# ICD10CMConceptTypeDef definition

class ICD10CMConceptTypeDef(TypedDict):
    Description: NotRequired[str],
    Code: NotRequired[str],
    Score: NotRequired[float],

InferICD10CMRequestRequestTypeDef#

# InferICD10CMRequestRequestTypeDef definition

class InferICD10CMRequestRequestTypeDef(TypedDict):
    Text: str,

InferRxNormRequestRequestTypeDef#

# InferRxNormRequestRequestTypeDef definition

class InferRxNormRequestRequestTypeDef(TypedDict):
    Text: str,

InferSNOMEDCTRequestRequestTypeDef#

# InferSNOMEDCTRequestRequestTypeDef definition

class InferSNOMEDCTRequestRequestTypeDef(TypedDict):
    Text: str,

SNOMEDCTDetailsTypeDef#

# SNOMEDCTDetailsTypeDef definition

class SNOMEDCTDetailsTypeDef(TypedDict):
    Edition: NotRequired[str],
    Language: NotRequired[str],
    VersionDate: NotRequired[str],

RxNormTraitTypeDef#

# RxNormTraitTypeDef definition

class RxNormTraitTypeDef(TypedDict):
    Name: NotRequired[RxNormTraitNameType],  # (1)
    Score: NotRequired[float],
  1. See RxNormTraitNameType

RxNormConceptTypeDef#

# RxNormConceptTypeDef definition

class RxNormConceptTypeDef(TypedDict):
    Description: NotRequired[str],
    Code: NotRequired[str],
    Score: NotRequired[float],

SNOMEDCTConceptTypeDef#

# SNOMEDCTConceptTypeDef definition

class SNOMEDCTConceptTypeDef(TypedDict):
    Description: NotRequired[str],
    Code: NotRequired[str],
    Score: NotRequired[float],

SNOMEDCTTraitTypeDef#

# SNOMEDCTTraitTypeDef definition

class SNOMEDCTTraitTypeDef(TypedDict):
    Name: NotRequired[SNOMEDCTTraitNameType],  # (1)
    Score: NotRequired[float],
  1. See SNOMEDCTTraitNameType

StopEntitiesDetectionV2JobRequestRequestTypeDef#

# StopEntitiesDetectionV2JobRequestRequestTypeDef definition

class StopEntitiesDetectionV2JobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopICD10CMInferenceJobRequestRequestTypeDef#

# StopICD10CMInferenceJobRequestRequestTypeDef definition

class StopICD10CMInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPHIDetectionJobRequestRequestTypeDef#

# StopPHIDetectionJobRequestRequestTypeDef definition

class StopPHIDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopRxNormInferenceJobRequestRequestTypeDef#

# StopRxNormInferenceJobRequestRequestTypeDef definition

class StopRxNormInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSNOMEDCTInferenceJobRequestRequestTypeDef#

# StopSNOMEDCTInferenceJobRequestRequestTypeDef definition

class StopSNOMEDCTInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    Type: NotRequired[EntitySubTypeType],  # (1)
    Score: NotRequired[float],
    RelationshipScore: NotRequired[float],
    RelationshipType: NotRequired[RelationshipTypeType],  # (2)
    Id: NotRequired[int],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Text: NotRequired[str],
    Category: NotRequired[EntityTypeType],  # (3)
    Traits: NotRequired[List[TraitTypeDef]],  # (4)
  1. See EntitySubTypeType
  2. See RelationshipTypeType
  3. See EntityTypeType
  4. See TraitTypeDef

ComprehendMedicalAsyncJobFilterTypeDef#

# ComprehendMedicalAsyncJobFilterTypeDef definition

class ComprehendMedicalAsyncJobFilterTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    SubmitTimeBefore: NotRequired[Union[datetime, str]],
    SubmitTimeAfter: NotRequired[Union[datetime, str]],
  1. See JobStatusType

ComprehendMedicalAsyncJobPropertiesTypeDef#

# ComprehendMedicalAsyncJobPropertiesTypeDef definition

class ComprehendMedicalAsyncJobPropertiesTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobName: NotRequired[str],
    JobStatus: NotRequired[JobStatusType],  # (1)
    Message: NotRequired[str],
    SubmitTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    ExpirationTime: NotRequired[datetime],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (2)
    OutputDataConfig: NotRequired[OutputDataConfigTypeDef],  # (3)
    LanguageCode: NotRequired[LanguageCodeType],  # (4)
    DataAccessRoleArn: NotRequired[str],
    ManifestFilePath: NotRequired[str],
    KMSKey: NotRequired[str],
    ModelVersion: NotRequired[str],
  1. See JobStatusType
  2. See InputDataConfigTypeDef
  3. See OutputDataConfigTypeDef
  4. See LanguageCodeType

StartEntitiesDetectionV2JobRequestRequestTypeDef#

# StartEntitiesDetectionV2JobRequestRequestTypeDef definition

class StartEntitiesDetectionV2JobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    KMSKey: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType

StartICD10CMInferenceJobRequestRequestTypeDef#

# StartICD10CMInferenceJobRequestRequestTypeDef definition

class StartICD10CMInferenceJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    KMSKey: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType

StartPHIDetectionJobRequestRequestTypeDef#

# StartPHIDetectionJobRequestRequestTypeDef definition

class StartPHIDetectionJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    KMSKey: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType

StartRxNormInferenceJobRequestRequestTypeDef#

# StartRxNormInferenceJobRequestRequestTypeDef definition

class StartRxNormInferenceJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    KMSKey: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType

StartSNOMEDCTInferenceJobRequestRequestTypeDef#

# StartSNOMEDCTInferenceJobRequestRequestTypeDef definition

class StartSNOMEDCTInferenceJobRequestRequestTypeDef(TypedDict):
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DataAccessRoleArn: str,
    LanguageCode: LanguageCodeType,  # (3)
    JobName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    KMSKey: NotRequired[str],
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See LanguageCodeType

StartEntitiesDetectionV2JobResponseTypeDef#

# StartEntitiesDetectionV2JobResponseTypeDef definition

class StartEntitiesDetectionV2JobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartICD10CMInferenceJobResponseTypeDef#

# StartICD10CMInferenceJobResponseTypeDef definition

class StartICD10CMInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPHIDetectionJobResponseTypeDef#

# StartPHIDetectionJobResponseTypeDef definition

class StartPHIDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartRxNormInferenceJobResponseTypeDef#

# StartRxNormInferenceJobResponseTypeDef definition

class StartRxNormInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSNOMEDCTInferenceJobResponseTypeDef#

# StartSNOMEDCTInferenceJobResponseTypeDef definition

class StartSNOMEDCTInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopEntitiesDetectionV2JobResponseTypeDef#

# StopEntitiesDetectionV2JobResponseTypeDef definition

class StopEntitiesDetectionV2JobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopICD10CMInferenceJobResponseTypeDef#

# StopICD10CMInferenceJobResponseTypeDef definition

class StopICD10CMInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopPHIDetectionJobResponseTypeDef#

# StopPHIDetectionJobResponseTypeDef definition

class StopPHIDetectionJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopRxNormInferenceJobResponseTypeDef#

# StopRxNormInferenceJobResponseTypeDef definition

class StopRxNormInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopSNOMEDCTInferenceJobResponseTypeDef#

# StopSNOMEDCTInferenceJobResponseTypeDef definition

class StopSNOMEDCTInferenceJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ICD10CMAttributeTypeDef#

# ICD10CMAttributeTypeDef definition

class ICD10CMAttributeTypeDef(TypedDict):
    Type: NotRequired[ICD10CMAttributeTypeType],  # (1)
    Score: NotRequired[float],
    RelationshipScore: NotRequired[float],
    Id: NotRequired[int],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Text: NotRequired[str],
    Traits: NotRequired[List[ICD10CMTraitTypeDef]],  # (2)
    Category: NotRequired[ICD10CMEntityTypeType],  # (3)
    RelationshipType: NotRequired[ICD10CMRelationshipTypeType],  # (4)
  1. See ICD10CMAttributeTypeType
  2. See ICD10CMTraitTypeDef
  3. See ICD10CMEntityTypeType
  4. See ICD10CMRelationshipTypeType

RxNormAttributeTypeDef#

# RxNormAttributeTypeDef definition

class RxNormAttributeTypeDef(TypedDict):
    Type: NotRequired[RxNormAttributeTypeType],  # (1)
    Score: NotRequired[float],
    RelationshipScore: NotRequired[float],
    Id: NotRequired[int],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Text: NotRequired[str],
    Traits: NotRequired[List[RxNormTraitTypeDef]],  # (2)
  1. See RxNormAttributeTypeType
  2. See RxNormTraitTypeDef

SNOMEDCTAttributeTypeDef#

# SNOMEDCTAttributeTypeDef definition

class SNOMEDCTAttributeTypeDef(TypedDict):
    Category: NotRequired[SNOMEDCTEntityCategoryType],  # (1)
    Type: NotRequired[SNOMEDCTAttributeTypeType],  # (2)
    Score: NotRequired[float],
    RelationshipScore: NotRequired[float],
    RelationshipType: NotRequired[SNOMEDCTRelationshipTypeType],  # (3)
    Id: NotRequired[int],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Text: NotRequired[str],
    Traits: NotRequired[List[SNOMEDCTTraitTypeDef]],  # (4)
    SNOMEDCTConcepts: NotRequired[List[SNOMEDCTConceptTypeDef]],  # (5)
  1. See SNOMEDCTEntityCategoryType
  2. See SNOMEDCTAttributeTypeType
  3. See SNOMEDCTRelationshipTypeType
  4. See SNOMEDCTTraitTypeDef
  5. See SNOMEDCTConceptTypeDef

EntityTypeDef#

# EntityTypeDef definition

class EntityTypeDef(TypedDict):
    Id: NotRequired[int],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Score: NotRequired[float],
    Text: NotRequired[str],
    Category: NotRequired[EntityTypeType],  # (1)
    Type: NotRequired[EntitySubTypeType],  # (2)
    Traits: NotRequired[List[TraitTypeDef]],  # (3)
    Attributes: NotRequired[List[AttributeTypeDef]],  # (4)
  1. See EntityTypeType
  2. See EntitySubTypeType
  3. See TraitTypeDef
  4. See AttributeTypeDef

UnmappedAttributeTypeDef#

# UnmappedAttributeTypeDef definition

class UnmappedAttributeTypeDef(TypedDict):
    Type: NotRequired[EntityTypeType],  # (1)
    Attribute: NotRequired[AttributeTypeDef],  # (2)
  1. See EntityTypeType
  2. See AttributeTypeDef

ListEntitiesDetectionV2JobsRequestRequestTypeDef#