Typed dictionaries

Index > ComprehendMedical > Typed dictionaries

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

TraitTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import TraitTypeDef

def get_value() -> TraitTypeDef:
    return {
        "Name": ...,
    }

Definition

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

1. See AttributeNameType

CharactersTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import CharactersTypeDef

def get_value() -> CharactersTypeDef:
    return {
        "OriginalTextCharacters": ...,
    }

Definition

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

ComprehendMedicalAsyncJobFilterTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ComprehendMedicalAsyncJobFilterTypeDef

def get_value() -> ComprehendMedicalAsyncJobFilterTypeDef:
    return {
        "JobName": ...,
    }

Definition

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

1. See JobStatusType

InputDataConfigTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InputDataConfigTypeDef

def get_value() -> InputDataConfigTypeDef:
    return {
        "S3Bucket": ...,
    }

Definition

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

OutputDataConfigTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import OutputDataConfigTypeDef

def get_value() -> OutputDataConfigTypeDef:
    return {
        "S3Bucket": ...,
    }

Definition

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

DescribeEntitiesDetectionV2JobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeEntitiesDetectionV2JobRequestRequestTypeDef

def get_value() -> DescribeEntitiesDetectionV2JobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class DescribeEntitiesDetectionV2JobRequestRequestTypeDef(TypedDict):
    JobId: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

DescribeICD10CMInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeICD10CMInferenceJobRequestRequestTypeDef

def get_value() -> DescribeICD10CMInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class DescribeICD10CMInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePHIDetectionJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribePHIDetectionJobRequestRequestTypeDef

def get_value() -> DescribePHIDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class DescribePHIDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeRxNormInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeRxNormInferenceJobRequestRequestTypeDef

def get_value() -> DescribeRxNormInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class DescribeRxNormInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeSNOMEDCTInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeSNOMEDCTInferenceJobRequestRequestTypeDef

def get_value() -> DescribeSNOMEDCTInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class DescribeSNOMEDCTInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DetectEntitiesRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectEntitiesRequestRequestTypeDef

def get_value() -> DetectEntitiesRequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class DetectEntitiesRequestRequestTypeDef(TypedDict):
    Text: str,

DetectEntitiesV2RequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectEntitiesV2RequestRequestTypeDef

def get_value() -> DetectEntitiesV2RequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class DetectEntitiesV2RequestRequestTypeDef(TypedDict):
    Text: str,

DetectPHIRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectPHIRequestRequestTypeDef

def get_value() -> DetectPHIRequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class DetectPHIRequestRequestTypeDef(TypedDict):
    Text: str,

ICD10CMTraitTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ICD10CMTraitTypeDef

def get_value() -> ICD10CMTraitTypeDef:
    return {
        "Name": ...,
    }

Definition

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

1. See ICD10CMTraitNameType

ICD10CMConceptTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ICD10CMConceptTypeDef

def get_value() -> ICD10CMConceptTypeDef:
    return {
        "Description": ...,
    }

Definition

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

InferICD10CMRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferICD10CMRequestRequestTypeDef

def get_value() -> InferICD10CMRequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class InferICD10CMRequestRequestTypeDef(TypedDict):
    Text: str,

InferRxNormRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferRxNormRequestRequestTypeDef

def get_value() -> InferRxNormRequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class InferRxNormRequestRequestTypeDef(TypedDict):
    Text: str,

InferSNOMEDCTRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferSNOMEDCTRequestRequestTypeDef

def get_value() -> InferSNOMEDCTRequestRequestTypeDef:
    return {
        "Text": ...,
    }

Definition

class InferSNOMEDCTRequestRequestTypeDef(TypedDict):
    Text: str,

SNOMEDCTDetailsTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import SNOMEDCTDetailsTypeDef

def get_value() -> SNOMEDCTDetailsTypeDef:
    return {
        "Edition": ...,
    }

Definition

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

RxNormTraitTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import RxNormTraitTypeDef

def get_value() -> RxNormTraitTypeDef:
    return {
        "Name": ...,
    }

Definition

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

1. See RxNormTraitNameType

RxNormConceptTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import RxNormConceptTypeDef

def get_value() -> RxNormConceptTypeDef:
    return {
        "Description": ...,
    }

Definition

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

SNOMEDCTConceptTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import SNOMEDCTConceptTypeDef

def get_value() -> SNOMEDCTConceptTypeDef:
    return {
        "Description": ...,
    }

Definition

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

SNOMEDCTTraitTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import SNOMEDCTTraitTypeDef

def get_value() -> SNOMEDCTTraitTypeDef:
    return {
        "Name": ...,
    }

Definition

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

1. See SNOMEDCTTraitNameType

StopEntitiesDetectionV2JobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopEntitiesDetectionV2JobRequestRequestTypeDef

def get_value() -> StopEntitiesDetectionV2JobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class StopEntitiesDetectionV2JobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopICD10CMInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopICD10CMInferenceJobRequestRequestTypeDef

def get_value() -> StopICD10CMInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class StopICD10CMInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopPHIDetectionJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopPHIDetectionJobRequestRequestTypeDef

def get_value() -> StopPHIDetectionJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class StopPHIDetectionJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopRxNormInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopRxNormInferenceJobRequestRequestTypeDef

def get_value() -> StopRxNormInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class StopRxNormInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

StopSNOMEDCTInferenceJobRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopSNOMEDCTInferenceJobRequestRequestTypeDef

def get_value() -> StopSNOMEDCTInferenceJobRequestRequestTypeDef:
    return {
        "JobId": ...,
    }

Definition

class StopSNOMEDCTInferenceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

AttributeTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import AttributeTypeDef

def get_value() -> AttributeTypeDef:
    return {
        "Type": ...,
    }

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

ListEntitiesDetectionV2JobsRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListEntitiesDetectionV2JobsRequestRequestTypeDef

def get_value() -> ListEntitiesDetectionV2JobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

class ListEntitiesDetectionV2JobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[ComprehendMedicalAsyncJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

1. See ComprehendMedicalAsyncJobFilterTypeDef

ListICD10CMInferenceJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListICD10CMInferenceJobsRequestRequestTypeDef

def get_value() -> ListICD10CMInferenceJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

class ListICD10CMInferenceJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[ComprehendMedicalAsyncJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

1. See ComprehendMedicalAsyncJobFilterTypeDef

ListPHIDetectionJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListPHIDetectionJobsRequestRequestTypeDef

def get_value() -> ListPHIDetectionJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

class ListPHIDetectionJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[ComprehendMedicalAsyncJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

1. See ComprehendMedicalAsyncJobFilterTypeDef

ListRxNormInferenceJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListRxNormInferenceJobsRequestRequestTypeDef

def get_value() -> ListRxNormInferenceJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

class ListRxNormInferenceJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[ComprehendMedicalAsyncJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

1. See ComprehendMedicalAsyncJobFilterTypeDef

ListSNOMEDCTInferenceJobsRequestRequestTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListSNOMEDCTInferenceJobsRequestRequestTypeDef

def get_value() -> ListSNOMEDCTInferenceJobsRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

class ListSNOMEDCTInferenceJobsRequestRequestTypeDef(TypedDict):
    Filter: NotRequired[ComprehendMedicalAsyncJobFilterTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

1. See ComprehendMedicalAsyncJobFilterTypeDef

ComprehendMedicalAsyncJobPropertiesTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ComprehendMedicalAsyncJobPropertiesTypeDef

def get_value() -> ComprehendMedicalAsyncJobPropertiesTypeDef:
    return {
        "JobId": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartEntitiesDetectionV2JobRequestRequestTypeDef

def get_value() -> StartEntitiesDetectionV2JobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartICD10CMInferenceJobRequestRequestTypeDef

def get_value() -> StartICD10CMInferenceJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartPHIDetectionJobRequestRequestTypeDef

def get_value() -> StartPHIDetectionJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartRxNormInferenceJobRequestRequestTypeDef

def get_value() -> StartRxNormInferenceJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartSNOMEDCTInferenceJobRequestRequestTypeDef

def get_value() -> StartSNOMEDCTInferenceJobRequestRequestTypeDef:
    return {
        "InputDataConfig": ...,
        "OutputDataConfig": ...,
        "DataAccessRoleArn": ...,
        "LanguageCode": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartEntitiesDetectionV2JobResponseTypeDef

def get_value() -> StartEntitiesDetectionV2JobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StartICD10CMInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartICD10CMInferenceJobResponseTypeDef

def get_value() -> StartICD10CMInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StartPHIDetectionJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartPHIDetectionJobResponseTypeDef

def get_value() -> StartPHIDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StartRxNormInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartRxNormInferenceJobResponseTypeDef

def get_value() -> StartRxNormInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StartSNOMEDCTInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StartSNOMEDCTInferenceJobResponseTypeDef

def get_value() -> StartSNOMEDCTInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StopEntitiesDetectionV2JobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopEntitiesDetectionV2JobResponseTypeDef

def get_value() -> StopEntitiesDetectionV2JobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StopICD10CMInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopICD10CMInferenceJobResponseTypeDef

def get_value() -> StopICD10CMInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StopPHIDetectionJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopPHIDetectionJobResponseTypeDef

def get_value() -> StopPHIDetectionJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StopRxNormInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopRxNormInferenceJobResponseTypeDef

def get_value() -> StopRxNormInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

StopSNOMEDCTInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import StopSNOMEDCTInferenceJobResponseTypeDef

def get_value() -> StopSNOMEDCTInferenceJobResponseTypeDef:
    return {
        "JobId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

ICD10CMAttributeTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ICD10CMAttributeTypeDef

def get_value() -> ICD10CMAttributeTypeDef:
    return {
        "Type": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import RxNormAttributeTypeDef

def get_value() -> RxNormAttributeTypeDef:
    return {
        "Type": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import SNOMEDCTAttributeTypeDef

def get_value() -> SNOMEDCTAttributeTypeDef:
    return {
        "Category": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import EntityTypeDef

def get_value() -> EntityTypeDef:
    return {
        "Id": ...,
    }

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

Usage Example

from mypy_boto3_comprehendmedical.type_defs import UnmappedAttributeTypeDef

def get_value() -> UnmappedAttributeTypeDef:
    return {
        "Type": ...,
    }

Definition

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

1. See EntityTypeType
2. See AttributeTypeDef

DescribeEntitiesDetectionV2JobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeEntitiesDetectionV2JobResponseTypeDef

def get_value() -> DescribeEntitiesDetectionV2JobResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeEntitiesDetectionV2JobResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

DescribeICD10CMInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeICD10CMInferenceJobResponseTypeDef

def get_value() -> DescribeICD10CMInferenceJobResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeICD10CMInferenceJobResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

DescribePHIDetectionJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribePHIDetectionJobResponseTypeDef

def get_value() -> DescribePHIDetectionJobResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribePHIDetectionJobResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

DescribeRxNormInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeRxNormInferenceJobResponseTypeDef

def get_value() -> DescribeRxNormInferenceJobResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeRxNormInferenceJobResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

DescribeSNOMEDCTInferenceJobResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DescribeSNOMEDCTInferenceJobResponseTypeDef

def get_value() -> DescribeSNOMEDCTInferenceJobResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobProperties": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeSNOMEDCTInferenceJobResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobProperties: ComprehendMedicalAsyncJobPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ListEntitiesDetectionV2JobsResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListEntitiesDetectionV2JobsResponseTypeDef

def get_value() -> ListEntitiesDetectionV2JobsResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListEntitiesDetectionV2JobsResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobPropertiesList: List[ComprehendMedicalAsyncJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ListICD10CMInferenceJobsResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListICD10CMInferenceJobsResponseTypeDef

def get_value() -> ListICD10CMInferenceJobsResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListICD10CMInferenceJobsResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobPropertiesList: List[ComprehendMedicalAsyncJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ListPHIDetectionJobsResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListPHIDetectionJobsResponseTypeDef

def get_value() -> ListPHIDetectionJobsResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListPHIDetectionJobsResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobPropertiesList: List[ComprehendMedicalAsyncJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ListRxNormInferenceJobsResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListRxNormInferenceJobsResponseTypeDef

def get_value() -> ListRxNormInferenceJobsResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListRxNormInferenceJobsResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobPropertiesList: List[ComprehendMedicalAsyncJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ListSNOMEDCTInferenceJobsResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ListSNOMEDCTInferenceJobsResponseTypeDef

def get_value() -> ListSNOMEDCTInferenceJobsResponseTypeDef:
    return {
        "ComprehendMedicalAsyncJobPropertiesList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListSNOMEDCTInferenceJobsResponseTypeDef(TypedDict):
    ComprehendMedicalAsyncJobPropertiesList: List[ComprehendMedicalAsyncJobPropertiesTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComprehendMedicalAsyncJobPropertiesTypeDef
2. See ResponseMetadataTypeDef

ICD10CMEntityTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import ICD10CMEntityTypeDef

def get_value() -> ICD10CMEntityTypeDef:
    return {
        "Id": ...,
    }

Definition

class ICD10CMEntityTypeDef(TypedDict):
    Id: NotRequired[int],
    Text: NotRequired[str],
    Category: NotRequired[ICD10CMEntityCategoryType],  # (1)
    Type: NotRequired[ICD10CMEntityTypeType],  # (2)
    Score: NotRequired[float],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Attributes: NotRequired[List[ICD10CMAttributeTypeDef]],  # (3)
    Traits: NotRequired[List[ICD10CMTraitTypeDef]],  # (4)
    ICD10CMConcepts: NotRequired[List[ICD10CMConceptTypeDef]],  # (5)

1. See ICD10CMEntityCategoryType
2. See ICD10CMEntityTypeType
3. See ICD10CMAttributeTypeDef
4. See ICD10CMTraitTypeDef
5. See ICD10CMConceptTypeDef

RxNormEntityTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import RxNormEntityTypeDef

def get_value() -> RxNormEntityTypeDef:
    return {
        "Id": ...,
    }

Definition

class RxNormEntityTypeDef(TypedDict):
    Id: NotRequired[int],
    Text: NotRequired[str],
    Category: NotRequired[RxNormEntityCategoryType],  # (1)
    Type: NotRequired[RxNormEntityTypeType],  # (2)
    Score: NotRequired[float],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Attributes: NotRequired[List[RxNormAttributeTypeDef]],  # (3)
    Traits: NotRequired[List[RxNormTraitTypeDef]],  # (4)
    RxNormConcepts: NotRequired[List[RxNormConceptTypeDef]],  # (5)

1. See RxNormEntityCategoryType
2. See RxNormEntityTypeType
3. See RxNormAttributeTypeDef
4. See RxNormTraitTypeDef
5. See RxNormConceptTypeDef

SNOMEDCTEntityTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import SNOMEDCTEntityTypeDef

def get_value() -> SNOMEDCTEntityTypeDef:
    return {
        "Id": ...,
    }

Definition

class SNOMEDCTEntityTypeDef(TypedDict):
    Id: NotRequired[int],
    Text: NotRequired[str],
    Category: NotRequired[SNOMEDCTEntityCategoryType],  # (1)
    Type: NotRequired[SNOMEDCTEntityTypeType],  # (2)
    Score: NotRequired[float],
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Attributes: NotRequired[List[SNOMEDCTAttributeTypeDef]],  # (3)
    Traits: NotRequired[List[SNOMEDCTTraitTypeDef]],  # (4)
    SNOMEDCTConcepts: NotRequired[List[SNOMEDCTConceptTypeDef]],  # (5)

1. See SNOMEDCTEntityCategoryType
2. See SNOMEDCTEntityTypeType
3. See SNOMEDCTAttributeTypeDef
4. See SNOMEDCTTraitTypeDef
5. See SNOMEDCTConceptTypeDef

DetectPHIResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectPHIResponseTypeDef

def get_value() -> DetectPHIResponseTypeDef:
    return {
        "Entities": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class DetectPHIResponseTypeDef(TypedDict):
    Entities: List[EntityTypeDef],  # (1)
    PaginationToken: str,
    ModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EntityTypeDef
2. See ResponseMetadataTypeDef

DetectEntitiesResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectEntitiesResponseTypeDef

def get_value() -> DetectEntitiesResponseTypeDef:
    return {
        "Entities": ...,
        "UnmappedAttributes": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class DetectEntitiesResponseTypeDef(TypedDict):
    Entities: List[EntityTypeDef],  # (1)
    UnmappedAttributes: List[UnmappedAttributeTypeDef],  # (2)
    PaginationToken: str,
    ModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See EntityTypeDef
2. See UnmappedAttributeTypeDef
3. See ResponseMetadataTypeDef

DetectEntitiesV2ResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import DetectEntitiesV2ResponseTypeDef

def get_value() -> DetectEntitiesV2ResponseTypeDef:
    return {
        "Entities": ...,
        "UnmappedAttributes": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class DetectEntitiesV2ResponseTypeDef(TypedDict):
    Entities: List[EntityTypeDef],  # (1)
    UnmappedAttributes: List[UnmappedAttributeTypeDef],  # (2)
    PaginationToken: str,
    ModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See EntityTypeDef
2. See UnmappedAttributeTypeDef
3. See ResponseMetadataTypeDef

InferICD10CMResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferICD10CMResponseTypeDef

def get_value() -> InferICD10CMResponseTypeDef:
    return {
        "Entities": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class InferICD10CMResponseTypeDef(TypedDict):
    Entities: List[ICD10CMEntityTypeDef],  # (1)
    PaginationToken: str,
    ModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ICD10CMEntityTypeDef
2. See ResponseMetadataTypeDef

InferRxNormResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferRxNormResponseTypeDef

def get_value() -> InferRxNormResponseTypeDef:
    return {
        "Entities": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class InferRxNormResponseTypeDef(TypedDict):
    Entities: List[RxNormEntityTypeDef],  # (1)
    PaginationToken: str,
    ModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RxNormEntityTypeDef
2. See ResponseMetadataTypeDef

InferSNOMEDCTResponseTypeDef

Usage Example

from mypy_boto3_comprehendmedical.type_defs import InferSNOMEDCTResponseTypeDef

def get_value() -> InferSNOMEDCTResponseTypeDef:
    return {
        "Entities": ...,
        "PaginationToken": ...,
        "ModelVersion": ...,
        "SNOMEDCTDetails": ...,
        "Characters": ...,
        "ResponseMetadata": ...,
    }

Definition

class InferSNOMEDCTResponseTypeDef(TypedDict):
    Entities: List[SNOMEDCTEntityTypeDef],  # (1)
    PaginationToken: str,
    ModelVersion: str,
    SNOMEDCTDetails: SNOMEDCTDetailsTypeDef,  # (2)
    Characters: CharactersTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See SNOMEDCTEntityTypeDef
2. See SNOMEDCTDetailsTypeDef
3. See CharactersTypeDef
4. See ResponseMetadataTypeDef