Skip to content

Type definitions#

Index > TranscribeService > Type definitions

Auto-generated documentation for TranscribeService type annotations stubs module mypy-boto3-transcribe.

ContentRedactionUnionTypeDef#

# ContentRedactionUnionTypeDef definition

ContentRedactionUnionTypeDef = Union[
    ContentRedactionTypeDef,  # (1)
    ContentRedactionOutputTypeDef,  # (2)
]
  1. See ContentRedactionTypeDef
  2. See ContentRedactionOutputTypeDef

ToxicityDetectionSettingsUnionTypeDef#

# ToxicityDetectionSettingsUnionTypeDef definition

ToxicityDetectionSettingsUnionTypeDef = Union[
    ToxicityDetectionSettingsTypeDef,  # (1)
    ToxicityDetectionSettingsOutputTypeDef,  # (2)
]
  1. See ToxicityDetectionSettingsTypeDef
  2. See ToxicityDetectionSettingsOutputTypeDef

SentimentFilterUnionTypeDef#

# SentimentFilterUnionTypeDef definition

SentimentFilterUnionTypeDef = Union[
    SentimentFilterTypeDef,  # (1)
    SentimentFilterOutputTypeDef,  # (2)
]
  1. See SentimentFilterTypeDef
  2. See SentimentFilterOutputTypeDef

TranscriptFilterUnionTypeDef#

# TranscriptFilterUnionTypeDef definition

TranscriptFilterUnionTypeDef = Union[
    TranscriptFilterTypeDef,  # (1)
    TranscriptFilterOutputTypeDef,  # (2)
]
  1. See TranscriptFilterTypeDef
  2. See TranscriptFilterOutputTypeDef

RuleUnionTypeDef#

# RuleUnionTypeDef definition

RuleUnionTypeDef = Union[
    RuleTypeDef,  # (1)
    RuleOutputTypeDef,  # (2)
]
  1. See RuleTypeDef
  2. See RuleOutputTypeDef

AbsoluteTimeRangeTypeDef#

# AbsoluteTimeRangeTypeDef definition

class AbsoluteTimeRangeTypeDef(TypedDict):
    StartTime: NotRequired[int],
    EndTime: NotRequired[int],
    First: NotRequired[int],
    Last: NotRequired[int],

CallAnalyticsSkippedFeatureTypeDef#

# CallAnalyticsSkippedFeatureTypeDef definition

class CallAnalyticsSkippedFeatureTypeDef(TypedDict):
    Feature: NotRequired[CallAnalyticsFeatureType],  # (1)
    ReasonCode: NotRequired[CallAnalyticsSkippedReasonCodeType],  # (2)
    Message: NotRequired[str],
  1. See CallAnalyticsFeatureType
  2. See CallAnalyticsSkippedReasonCodeType

ContentRedactionOutputTypeDef#

# ContentRedactionOutputTypeDef definition

class ContentRedactionOutputTypeDef(TypedDict):
    RedactionType: RedactionTypeType,  # (1)
    RedactionOutput: RedactionOutputType,  # (2)
    PiiEntityTypes: NotRequired[List[PiiEntityTypeType]],  # (3)
  1. See RedactionTypeType
  2. See RedactionOutputType
  3. See PiiEntityTypeType

LanguageIdSettingsTypeDef#

# LanguageIdSettingsTypeDef definition

class LanguageIdSettingsTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    VocabularyFilterName: NotRequired[str],
    LanguageModelName: NotRequired[str],

SummarizationTypeDef#

# SummarizationTypeDef definition

class SummarizationTypeDef(TypedDict):
    GenerateAbstractiveSummary: bool,

ChannelDefinitionTypeDef#

# ChannelDefinitionTypeDef definition

class ChannelDefinitionTypeDef(TypedDict):
    ChannelId: NotRequired[int],
    ParticipantRole: NotRequired[ParticipantRoleType],  # (1)
  1. See ParticipantRoleType

MediaTypeDef#

# MediaTypeDef definition

class MediaTypeDef(TypedDict):
    MediaFileUri: NotRequired[str],
    RedactedMediaFileUri: NotRequired[str],

TranscriptTypeDef#

# TranscriptTypeDef definition

class TranscriptTypeDef(TypedDict):
    TranscriptFileUri: NotRequired[str],
    RedactedTranscriptFileUri: NotRequired[str],

ContentRedactionTypeDef#

# ContentRedactionTypeDef definition

class ContentRedactionTypeDef(TypedDict):
    RedactionType: RedactionTypeType,  # (1)
    RedactionOutput: RedactionOutputType,  # (2)
    PiiEntityTypes: NotRequired[Sequence[PiiEntityTypeType]],  # (3)
  1. See RedactionTypeType
  2. See RedactionOutputType
  3. See PiiEntityTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

InputDataConfigTypeDef#

# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    S3Uri: str,
    DataAccessRoleArn: str,
    TuningDataS3Uri: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteCallAnalyticsCategoryRequestRequestTypeDef#

# DeleteCallAnalyticsCategoryRequestRequestTypeDef definition

class DeleteCallAnalyticsCategoryRequestRequestTypeDef(TypedDict):
    CategoryName: str,

DeleteCallAnalyticsJobRequestRequestTypeDef#

# DeleteCallAnalyticsJobRequestRequestTypeDef definition

class DeleteCallAnalyticsJobRequestRequestTypeDef(TypedDict):
    CallAnalyticsJobName: str,

DeleteLanguageModelRequestRequestTypeDef#

# DeleteLanguageModelRequestRequestTypeDef definition

class DeleteLanguageModelRequestRequestTypeDef(TypedDict):
    ModelName: str,

DeleteMedicalScribeJobRequestRequestTypeDef#

# DeleteMedicalScribeJobRequestRequestTypeDef definition

class DeleteMedicalScribeJobRequestRequestTypeDef(TypedDict):
    MedicalScribeJobName: str,

DeleteMedicalTranscriptionJobRequestRequestTypeDef#

# DeleteMedicalTranscriptionJobRequestRequestTypeDef definition

class DeleteMedicalTranscriptionJobRequestRequestTypeDef(TypedDict):
    MedicalTranscriptionJobName: str,

DeleteMedicalVocabularyRequestRequestTypeDef#

# DeleteMedicalVocabularyRequestRequestTypeDef definition

class DeleteMedicalVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,

DeleteTranscriptionJobRequestRequestTypeDef#

# DeleteTranscriptionJobRequestRequestTypeDef definition

class DeleteTranscriptionJobRequestRequestTypeDef(TypedDict):
    TranscriptionJobName: str,

DeleteVocabularyFilterRequestRequestTypeDef#

# DeleteVocabularyFilterRequestRequestTypeDef definition

class DeleteVocabularyFilterRequestRequestTypeDef(TypedDict):
    VocabularyFilterName: str,

DeleteVocabularyRequestRequestTypeDef#

# DeleteVocabularyRequestRequestTypeDef definition

class DeleteVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,

DescribeLanguageModelRequestRequestTypeDef#

# DescribeLanguageModelRequestRequestTypeDef definition

class DescribeLanguageModelRequestRequestTypeDef(TypedDict):
    ModelName: str,

GetCallAnalyticsCategoryRequestRequestTypeDef#

# GetCallAnalyticsCategoryRequestRequestTypeDef definition

class GetCallAnalyticsCategoryRequestRequestTypeDef(TypedDict):
    CategoryName: str,

GetCallAnalyticsJobRequestRequestTypeDef#

# GetCallAnalyticsJobRequestRequestTypeDef definition

class GetCallAnalyticsJobRequestRequestTypeDef(TypedDict):
    CallAnalyticsJobName: str,

GetMedicalScribeJobRequestRequestTypeDef#

# GetMedicalScribeJobRequestRequestTypeDef definition

class GetMedicalScribeJobRequestRequestTypeDef(TypedDict):
    MedicalScribeJobName: str,

GetMedicalTranscriptionJobRequestRequestTypeDef#

# GetMedicalTranscriptionJobRequestRequestTypeDef definition

class GetMedicalTranscriptionJobRequestRequestTypeDef(TypedDict):
    MedicalTranscriptionJobName: str,

GetMedicalVocabularyRequestRequestTypeDef#

# GetMedicalVocabularyRequestRequestTypeDef definition

class GetMedicalVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,

GetTranscriptionJobRequestRequestTypeDef#

# GetTranscriptionJobRequestRequestTypeDef definition

class GetTranscriptionJobRequestRequestTypeDef(TypedDict):
    TranscriptionJobName: str,

GetVocabularyFilterRequestRequestTypeDef#

# GetVocabularyFilterRequestRequestTypeDef definition

class GetVocabularyFilterRequestRequestTypeDef(TypedDict):
    VocabularyFilterName: str,

GetVocabularyRequestRequestTypeDef#

# GetVocabularyRequestRequestTypeDef definition

class GetVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,

RelativeTimeRangeTypeDef#

# RelativeTimeRangeTypeDef definition

class RelativeTimeRangeTypeDef(TypedDict):
    StartPercentage: NotRequired[int],
    EndPercentage: NotRequired[int],
    First: NotRequired[int],
    Last: NotRequired[int],

JobExecutionSettingsTypeDef#

# JobExecutionSettingsTypeDef definition

class JobExecutionSettingsTypeDef(TypedDict):
    AllowDeferredExecution: NotRequired[bool],
    DataAccessRoleArn: NotRequired[str],

LanguageCodeItemTypeDef#

# LanguageCodeItemTypeDef definition

class LanguageCodeItemTypeDef(TypedDict):
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    DurationInSeconds: NotRequired[float],
  1. See LanguageCodeType

ListCallAnalyticsCategoriesRequestRequestTypeDef#

# ListCallAnalyticsCategoriesRequestRequestTypeDef definition

class ListCallAnalyticsCategoriesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListCallAnalyticsJobsRequestRequestTypeDef#

# ListCallAnalyticsJobsRequestRequestTypeDef definition

class ListCallAnalyticsJobsRequestRequestTypeDef(TypedDict):
    Status: NotRequired[CallAnalyticsJobStatusType],  # (1)
    JobNameContains: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See CallAnalyticsJobStatusType

ListLanguageModelsRequestRequestTypeDef#

# ListLanguageModelsRequestRequestTypeDef definition

class ListLanguageModelsRequestRequestTypeDef(TypedDict):
    StatusEquals: NotRequired[ModelStatusType],  # (1)
    NameContains: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ModelStatusType

ListMedicalScribeJobsRequestRequestTypeDef#

# ListMedicalScribeJobsRequestRequestTypeDef definition

class ListMedicalScribeJobsRequestRequestTypeDef(TypedDict):
    Status: NotRequired[MedicalScribeJobStatusType],  # (1)
    JobNameContains: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See MedicalScribeJobStatusType

MedicalScribeJobSummaryTypeDef#

# MedicalScribeJobSummaryTypeDef definition

class MedicalScribeJobSummaryTypeDef(TypedDict):
    MedicalScribeJobName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    LanguageCode: NotRequired[MedicalScribeLanguageCodeType],  # (1)
    MedicalScribeJobStatus: NotRequired[MedicalScribeJobStatusType],  # (2)
    FailureReason: NotRequired[str],
  1. See MedicalScribeLanguageCodeType
  2. See MedicalScribeJobStatusType

ListMedicalTranscriptionJobsRequestRequestTypeDef#

# ListMedicalTranscriptionJobsRequestRequestTypeDef definition

class ListMedicalTranscriptionJobsRequestRequestTypeDef(TypedDict):
    Status: NotRequired[TranscriptionJobStatusType],  # (1)
    JobNameContains: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See TranscriptionJobStatusType

MedicalTranscriptionJobSummaryTypeDef#

# MedicalTranscriptionJobSummaryTypeDef definition

class MedicalTranscriptionJobSummaryTypeDef(TypedDict):
    MedicalTranscriptionJobName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    TranscriptionJobStatus: NotRequired[TranscriptionJobStatusType],  # (2)
    FailureReason: NotRequired[str],
    OutputLocationType: NotRequired[OutputLocationTypeType],  # (3)
    Specialty: NotRequired[SpecialtyType],  # (4)
    ContentIdentificationType: NotRequired[MedicalContentIdentificationTypeType],  # (5)
    Type: NotRequired[TypeType],  # (6)
  1. See LanguageCodeType
  2. See TranscriptionJobStatusType
  3. See OutputLocationTypeType
  4. See SpecialtyType
  5. See MedicalContentIdentificationTypeType
  6. See TypeType

ListMedicalVocabulariesRequestRequestTypeDef#

# ListMedicalVocabulariesRequestRequestTypeDef definition

class ListMedicalVocabulariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StateEquals: NotRequired[VocabularyStateType],  # (1)
    NameContains: NotRequired[str],
  1. See VocabularyStateType

VocabularyInfoTypeDef#

# VocabularyInfoTypeDef definition

class VocabularyInfoTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    LastModifiedTime: NotRequired[datetime],
    VocabularyState: NotRequired[VocabularyStateType],  # (2)
  1. See LanguageCodeType
  2. See VocabularyStateType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTranscriptionJobsRequestRequestTypeDef#

# ListTranscriptionJobsRequestRequestTypeDef definition

class ListTranscriptionJobsRequestRequestTypeDef(TypedDict):
    Status: NotRequired[TranscriptionJobStatusType],  # (1)
    JobNameContains: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See TranscriptionJobStatusType

ListVocabulariesRequestRequestTypeDef#

# ListVocabulariesRequestRequestTypeDef definition

class ListVocabulariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StateEquals: NotRequired[VocabularyStateType],  # (1)
    NameContains: NotRequired[str],
  1. See VocabularyStateType

ListVocabularyFiltersRequestRequestTypeDef#

# ListVocabularyFiltersRequestRequestTypeDef definition

class ListVocabularyFiltersRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    NameContains: NotRequired[str],

VocabularyFilterInfoTypeDef#

# VocabularyFilterInfoTypeDef definition

class VocabularyFilterInfoTypeDef(TypedDict):
    VocabularyFilterName: NotRequired[str],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    LastModifiedTime: NotRequired[datetime],
  1. See LanguageCodeType

MedicalScribeChannelDefinitionTypeDef#

# MedicalScribeChannelDefinitionTypeDef definition

class MedicalScribeChannelDefinitionTypeDef(TypedDict):
    ChannelId: int,
    ParticipantRole: MedicalScribeParticipantRoleType,  # (1)
  1. See MedicalScribeParticipantRoleType

MedicalScribeOutputTypeDef#

# MedicalScribeOutputTypeDef definition

class MedicalScribeOutputTypeDef(TypedDict):
    TranscriptFileUri: str,
    ClinicalDocumentUri: str,

MedicalScribeSettingsTypeDef#

# MedicalScribeSettingsTypeDef definition

class MedicalScribeSettingsTypeDef(TypedDict):
    ShowSpeakerLabels: NotRequired[bool],
    MaxSpeakerLabels: NotRequired[int],
    ChannelIdentification: NotRequired[bool],
    VocabularyName: NotRequired[str],
    VocabularyFilterName: NotRequired[str],
    VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType],  # (1)
  1. See VocabularyFilterMethodType

MedicalTranscriptTypeDef#

# MedicalTranscriptTypeDef definition

class MedicalTranscriptTypeDef(TypedDict):
    TranscriptFileUri: NotRequired[str],

MedicalTranscriptionSettingTypeDef#

# MedicalTranscriptionSettingTypeDef definition

class MedicalTranscriptionSettingTypeDef(TypedDict):
    ShowSpeakerLabels: NotRequired[bool],
    MaxSpeakerLabels: NotRequired[int],
    ChannelIdentification: NotRequired[bool],
    ShowAlternatives: NotRequired[bool],
    MaxAlternatives: NotRequired[int],
    VocabularyName: NotRequired[str],

ModelSettingsTypeDef#

# ModelSettingsTypeDef definition

class ModelSettingsTypeDef(TypedDict):
    LanguageModelName: NotRequired[str],

SettingsTypeDef#

# SettingsTypeDef definition

class SettingsTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    ShowSpeakerLabels: NotRequired[bool],
    MaxSpeakerLabels: NotRequired[int],
    ChannelIdentification: NotRequired[bool],
    ShowAlternatives: NotRequired[bool],
    MaxAlternatives: NotRequired[int],
    VocabularyFilterName: NotRequired[str],
    VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType],  # (1)
  1. See VocabularyFilterMethodType

SubtitlesTypeDef#

# SubtitlesTypeDef definition

class SubtitlesTypeDef(TypedDict):
    Formats: NotRequired[Sequence[SubtitleFormatType]],  # (1)
    OutputStartIndex: NotRequired[int],
  1. See SubtitleFormatType

SubtitlesOutputTypeDef#

# SubtitlesOutputTypeDef definition

class SubtitlesOutputTypeDef(TypedDict):
    Formats: NotRequired[List[SubtitleFormatType]],  # (1)
    SubtitleFileUris: NotRequired[List[str]],
    OutputStartIndex: NotRequired[int],
  1. See SubtitleFormatType

ToxicityDetectionSettingsOutputTypeDef#

# ToxicityDetectionSettingsOutputTypeDef definition

class ToxicityDetectionSettingsOutputTypeDef(TypedDict):
    ToxicityCategories: List[ToxicityCategoryType],  # (1)
  1. See ToxicityCategoryType

ToxicityDetectionSettingsTypeDef#

# ToxicityDetectionSettingsTypeDef definition

class ToxicityDetectionSettingsTypeDef(TypedDict):
    ToxicityCategories: Sequence[ToxicityCategoryType],  # (1)
  1. See ToxicityCategoryType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateMedicalVocabularyRequestRequestTypeDef#

# UpdateMedicalVocabularyRequestRequestTypeDef definition

class UpdateMedicalVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyFileUri: str,
  1. See LanguageCodeType

UpdateVocabularyFilterRequestRequestTypeDef#

# UpdateVocabularyFilterRequestRequestTypeDef definition

class UpdateVocabularyFilterRequestRequestTypeDef(TypedDict):
    VocabularyFilterName: str,
    Words: NotRequired[Sequence[str]],
    VocabularyFilterFileUri: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],

UpdateVocabularyRequestRequestTypeDef#

# UpdateVocabularyRequestRequestTypeDef definition

class UpdateVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Phrases: NotRequired[Sequence[str]],
    VocabularyFileUri: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
  1. See LanguageCodeType

CallAnalyticsJobDetailsTypeDef#

# CallAnalyticsJobDetailsTypeDef definition

class CallAnalyticsJobDetailsTypeDef(TypedDict):
    Skipped: NotRequired[List[CallAnalyticsSkippedFeatureTypeDef]],  # (1)
  1. See CallAnalyticsSkippedFeatureTypeDef

CallAnalyticsJobSettingsOutputTypeDef#

# CallAnalyticsJobSettingsOutputTypeDef definition

class CallAnalyticsJobSettingsOutputTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    VocabularyFilterName: NotRequired[str],
    VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType],  # (1)
    LanguageModelName: NotRequired[str],
    ContentRedaction: NotRequired[ContentRedactionOutputTypeDef],  # (2)
    LanguageOptions: NotRequired[List[LanguageCodeType]],  # (3)
    LanguageIdSettings: NotRequired[Dict[LanguageCodeType, LanguageIdSettingsTypeDef]],  # (4)
    Summarization: NotRequired[SummarizationTypeDef],  # (5)
  1. See VocabularyFilterMethodType
  2. See ContentRedactionOutputTypeDef
  3. See LanguageCodeType
  4. See LanguageCodeType LanguageIdSettingsTypeDef
  5. See SummarizationTypeDef

CreateMedicalVocabularyResponseTypeDef#

# CreateMedicalVocabularyResponseTypeDef definition

class CreateMedicalVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyState: VocabularyStateType,  # (2)
    LastModifiedTime: datetime,
    FailureReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

CreateVocabularyFilterResponseTypeDef#

# CreateVocabularyFilterResponseTypeDef definition

class CreateVocabularyFilterResponseTypeDef(TypedDict):
    VocabularyFilterName: str,
    LanguageCode: LanguageCodeType,  # (1)
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LanguageCodeType
  2. See ResponseMetadataTypeDef

CreateVocabularyResponseTypeDef#

# CreateVocabularyResponseTypeDef definition

class CreateVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyState: VocabularyStateType,  # (2)
    LastModifiedTime: datetime,
    FailureReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMedicalVocabularyResponseTypeDef#

# GetMedicalVocabularyResponseTypeDef definition

class GetMedicalVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyState: VocabularyStateType,  # (2)
    LastModifiedTime: datetime,
    FailureReason: str,
    DownloadUri: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

GetVocabularyFilterResponseTypeDef#

# GetVocabularyFilterResponseTypeDef definition

class GetVocabularyFilterResponseTypeDef(TypedDict):
    VocabularyFilterName: str,
    LanguageCode: LanguageCodeType,  # (1)
    LastModifiedTime: datetime,
    DownloadUri: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LanguageCodeType
  2. See ResponseMetadataTypeDef

GetVocabularyResponseTypeDef#

# GetVocabularyResponseTypeDef definition

class GetVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyState: VocabularyStateType,  # (2)
    LastModifiedTime: datetime,
    FailureReason: str,
    DownloadUri: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

UpdateMedicalVocabularyResponseTypeDef#

# UpdateMedicalVocabularyResponseTypeDef definition

class UpdateMedicalVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    LastModifiedTime: datetime,
    VocabularyState: VocabularyStateType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

UpdateVocabularyFilterResponseTypeDef#

# UpdateVocabularyFilterResponseTypeDef definition

class UpdateVocabularyFilterResponseTypeDef(TypedDict):
    VocabularyFilterName: str,
    LanguageCode: LanguageCodeType,  # (1)
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LanguageCodeType
  2. See ResponseMetadataTypeDef

UpdateVocabularyResponseTypeDef#

# UpdateVocabularyResponseTypeDef definition

class UpdateVocabularyResponseTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    LastModifiedTime: datetime,
    VocabularyState: VocabularyStateType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LanguageCodeType
  2. See VocabularyStateType
  3. See ResponseMetadataTypeDef

CreateLanguageModelResponseTypeDef#

# CreateLanguageModelResponseTypeDef definition

class CreateLanguageModelResponseTypeDef(TypedDict):
    LanguageCode: CLMLanguageCodeType,  # (1)
    BaseModelName: BaseModelNameType,  # (2)
    ModelName: str,
    InputDataConfig: InputDataConfigTypeDef,  # (3)
    ModelStatus: ModelStatusType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See CLMLanguageCodeType
  2. See BaseModelNameType
  3. See InputDataConfigTypeDef
  4. See ModelStatusType
  5. See ResponseMetadataTypeDef

LanguageModelTypeDef#

# LanguageModelTypeDef definition

class LanguageModelTypeDef(TypedDict):
    ModelName: NotRequired[str],
    CreateTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    LanguageCode: NotRequired[CLMLanguageCodeType],  # (1)
    BaseModelName: NotRequired[BaseModelNameType],  # (2)
    ModelStatus: NotRequired[ModelStatusType],  # (3)
    UpgradeAvailability: NotRequired[bool],
    FailureReason: NotRequired[str],
    InputDataConfig: NotRequired[InputDataConfigTypeDef],  # (4)
  1. See CLMLanguageCodeType
  2. See BaseModelNameType
  3. See ModelStatusType
  4. See InputDataConfigTypeDef

CreateLanguageModelRequestRequestTypeDef#

# CreateLanguageModelRequestRequestTypeDef definition

class CreateLanguageModelRequestRequestTypeDef(TypedDict):
    LanguageCode: CLMLanguageCodeType,  # (1)
    BaseModelName: BaseModelNameType,  # (2)
    ModelName: str,
    InputDataConfig: InputDataConfigTypeDef,  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See CLMLanguageCodeType
  2. See BaseModelNameType
  3. See InputDataConfigTypeDef
  4. See TagTypeDef

CreateMedicalVocabularyRequestRequestTypeDef#

# CreateMedicalVocabularyRequestRequestTypeDef definition

class CreateMedicalVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyFileUri: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See LanguageCodeType
  2. See TagTypeDef

CreateVocabularyFilterRequestRequestTypeDef#

# CreateVocabularyFilterRequestRequestTypeDef definition

class CreateVocabularyFilterRequestRequestTypeDef(TypedDict):
    VocabularyFilterName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Words: NotRequired[Sequence[str]],
    VocabularyFilterFileUri: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    DataAccessRoleArn: NotRequired[str],
  1. See LanguageCodeType
  2. See TagTypeDef

CreateVocabularyRequestRequestTypeDef#

# CreateVocabularyRequestRequestTypeDef definition

class CreateVocabularyRequestRequestTypeDef(TypedDict):
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Phrases: NotRequired[Sequence[str]],
    VocabularyFileUri: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    DataAccessRoleArn: NotRequired[str],
  1. See LanguageCodeType
  2. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    ResourceArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

InterruptionFilterTypeDef#

# InterruptionFilterTypeDef definition

class InterruptionFilterTypeDef(TypedDict):
    Threshold: NotRequired[int],
    ParticipantRole: NotRequired[ParticipantRoleType],  # (1)
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (2)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (3)
    Negate: NotRequired[bool],
  1. See ParticipantRoleType
  2. See AbsoluteTimeRangeTypeDef
  3. See RelativeTimeRangeTypeDef

NonTalkTimeFilterTypeDef#

# NonTalkTimeFilterTypeDef definition

class NonTalkTimeFilterTypeDef(TypedDict):
    Threshold: NotRequired[int],
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (1)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (2)
    Negate: NotRequired[bool],
  1. See AbsoluteTimeRangeTypeDef
  2. See RelativeTimeRangeTypeDef

SentimentFilterOutputTypeDef#

# SentimentFilterOutputTypeDef definition

class SentimentFilterOutputTypeDef(TypedDict):
    Sentiments: List[SentimentValueType],  # (1)
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (2)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (3)
    ParticipantRole: NotRequired[ParticipantRoleType],  # (4)
    Negate: NotRequired[bool],
  1. See SentimentValueType
  2. See AbsoluteTimeRangeTypeDef
  3. See RelativeTimeRangeTypeDef
  4. See ParticipantRoleType

SentimentFilterTypeDef#

# SentimentFilterTypeDef definition

class SentimentFilterTypeDef(TypedDict):
    Sentiments: Sequence[SentimentValueType],  # (1)
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (2)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (3)
    ParticipantRole: NotRequired[ParticipantRoleType],  # (4)
    Negate: NotRequired[bool],
  1. See SentimentValueType
  2. See AbsoluteTimeRangeTypeDef
  3. See RelativeTimeRangeTypeDef
  4. See ParticipantRoleType

TranscriptFilterOutputTypeDef#

# TranscriptFilterOutputTypeDef definition

class TranscriptFilterOutputTypeDef(TypedDict):
    TranscriptFilterType: TranscriptFilterTypeType,  # (1)
    Targets: List[str],
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (2)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (3)
    ParticipantRole: NotRequired[ParticipantRoleType],  # (4)
    Negate: NotRequired[bool],
  1. See TranscriptFilterTypeType
  2. See AbsoluteTimeRangeTypeDef
  3. See RelativeTimeRangeTypeDef
  4. See ParticipantRoleType

TranscriptFilterTypeDef#

# TranscriptFilterTypeDef definition

class TranscriptFilterTypeDef(TypedDict):
    TranscriptFilterType: TranscriptFilterTypeType,  # (1)
    Targets: Sequence[str],
    AbsoluteTimeRange: NotRequired[AbsoluteTimeRangeTypeDef],  # (2)
    RelativeTimeRange: NotRequired[RelativeTimeRangeTypeDef],  # (3)
    ParticipantRole: NotRequired[ParticipantRoleType],  # (4)
    Negate: NotRequired[bool],
  1. See TranscriptFilterTypeType
  2. See AbsoluteTimeRangeTypeDef
  3. See RelativeTimeRangeTypeDef
  4. See ParticipantRoleType

ListMedicalScribeJobsResponseTypeDef#

# ListMedicalScribeJobsResponseTypeDef definition

class ListMedicalScribeJobsResponseTypeDef(TypedDict):
    Status: MedicalScribeJobStatusType,  # (1)
    MedicalScribeJobSummaries: List[MedicalScribeJobSummaryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See MedicalScribeJobStatusType
  2. See MedicalScribeJobSummaryTypeDef
  3. See ResponseMetadataTypeDef

ListMedicalTranscriptionJobsResponseTypeDef#

# ListMedicalTranscriptionJobsResponseTypeDef definition

class ListMedicalTranscriptionJobsResponseTypeDef(TypedDict):
    Status: TranscriptionJobStatusType,  # (1)
    MedicalTranscriptionJobSummaries: List[MedicalTranscriptionJobSummaryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See TranscriptionJobStatusType
  2. See MedicalTranscriptionJobSummaryTypeDef
  3. See ResponseMetadataTypeDef

ListMedicalVocabulariesResponseTypeDef#

# ListMedicalVocabulariesResponseTypeDef definition

class ListMedicalVocabulariesResponseTypeDef(TypedDict):
    Status: VocabularyStateType,  # (1)
    Vocabularies: List[VocabularyInfoTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See VocabularyStateType
  2. See VocabularyInfoTypeDef
  3. See ResponseMetadataTypeDef

ListVocabulariesResponseTypeDef#

# ListVocabulariesResponseTypeDef definition

class ListVocabulariesResponseTypeDef(TypedDict):
    Status: VocabularyStateType,  # (1)
    Vocabularies: List[VocabularyInfoTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See VocabularyStateType
  2. See VocabularyInfoTypeDef
  3. See ResponseMetadataTypeDef

ListVocabularyFiltersResponseTypeDef#

# ListVocabularyFiltersResponseTypeDef definition

class ListVocabularyFiltersResponseTypeDef(TypedDict):
    VocabularyFilters: List[VocabularyFilterInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See VocabularyFilterInfoTypeDef
  2. See ResponseMetadataTypeDef

MedicalScribeJobTypeDef#

# MedicalScribeJobTypeDef definition

class MedicalScribeJobTypeDef(TypedDict):
    MedicalScribeJobName: NotRequired[str],
    MedicalScribeJobStatus: NotRequired[MedicalScribeJobStatusType],  # (1)
    LanguageCode: NotRequired[MedicalScribeLanguageCodeType],  # (2)
    Media: NotRequired[MediaTypeDef],  # (3)
    MedicalScribeOutput: NotRequired[MedicalScribeOutputTypeDef],  # (4)
    StartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    FailureReason: NotRequired[str],
    Settings: NotRequired[MedicalScribeSettingsTypeDef],  # (5)
    DataAccessRoleArn: NotRequired[str],
    ChannelDefinitions: NotRequired[List[MedicalScribeChannelDefinitionTypeDef]],  # (6)
    Tags: NotRequired[List[TagTypeDef]],  # (7)
  1. See MedicalScribeJobStatusType
  2. See MedicalScribeLanguageCodeType
  3. See MediaTypeDef
  4. See MedicalScribeOutputTypeDef
  5. See MedicalScribeSettingsTypeDef
  6. See MedicalScribeChannelDefinitionTypeDef
  7. See TagTypeDef

StartMedicalScribeJobRequestRequestTypeDef#

# StartMedicalScribeJobRequestRequestTypeDef definition

class StartMedicalScribeJobRequestRequestTypeDef(TypedDict):
    MedicalScribeJobName: str,
    Media: MediaTypeDef,  # (1)
    OutputBucketName: str,
    DataAccessRoleArn: str,
    Settings: MedicalScribeSettingsTypeDef,  # (2)
    OutputEncryptionKMSKeyId: NotRequired[str],
    KMSEncryptionContext: NotRequired[Mapping[str, str]],
    ChannelDefinitions: NotRequired[Sequence[MedicalScribeChannelDefinitionTypeDef]],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See MediaTypeDef
  2. See MedicalScribeSettingsTypeDef
  3. See MedicalScribeChannelDefinitionTypeDef
  4. See TagTypeDef

MedicalTranscriptionJobTypeDef#

# MedicalTranscriptionJobTypeDef definition

class MedicalTranscriptionJobTypeDef(TypedDict):
    MedicalTranscriptionJobName: NotRequired[str],
    TranscriptionJobStatus: NotRequired[TranscriptionJobStatusType],  # (1)
    LanguageCode: NotRequired[LanguageCodeType],  # (2)
    MediaSampleRateHertz: NotRequired[int],
    MediaFormat: NotRequired[MediaFormatType],  # (3)
    Media: NotRequired[MediaTypeDef],  # (4)
    Transcript: NotRequired[MedicalTranscriptTypeDef],  # (5)
    StartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    FailureReason: NotRequired[str],
    Settings: NotRequired[MedicalTranscriptionSettingTypeDef],  # (6)
    ContentIdentificationType: NotRequired[MedicalContentIdentificationTypeType],  # (7)
    Specialty: NotRequired[SpecialtyType],  # (8)
    Type: NotRequired[TypeType],  # (9)
    Tags: NotRequired[List[TagTypeDef]],  # (10)
  1. See TranscriptionJobStatusType
  2. See LanguageCodeType
  3. See MediaFormatType
  4. See MediaTypeDef
  5. See MedicalTranscriptTypeDef
  6. See MedicalTranscriptionSettingTypeDef
  7. See MedicalContentIdentificationTypeType
  8. See SpecialtyType
  9. See TypeType
  10. See TagTypeDef

StartMedicalTranscriptionJobRequestRequestTypeDef#

# StartMedicalTranscriptionJobRequestRequestTypeDef definition

class StartMedicalTranscriptionJobRequestRequestTypeDef(TypedDict):
    MedicalTranscriptionJobName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Media: MediaTypeDef,  # (2)
    OutputBucketName: str,
    Specialty: SpecialtyType,  # (3)
    Type: TypeType,  # (4)
    MediaSampleRateHertz: NotRequired[int],
    MediaFormat: NotRequired[MediaFormatType],  # (5)
    OutputKey: NotRequired[str],
    OutputEncryptionKMSKeyId: NotRequired[str],
    KMSEncryptionContext: NotRequired[Mapping[str, str]],
    Settings: NotRequired[MedicalTranscriptionSettingTypeDef],  # (6)
    ContentIdentificationType: NotRequired[MedicalContentIdentificationTypeType],  # (7)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (8)
  1. See LanguageCodeType
  2. See MediaTypeDef
  3. See SpecialtyType
  4. See TypeType
  5. See MediaFormatType
  6. See MedicalTranscriptionSettingTypeDef
  7. See MedicalContentIdentificationTypeType
  8. See TagTypeDef

TranscriptionJobSummaryTypeDef#

# TranscriptionJobSummaryTypeDef definition

class TranscriptionJobSummaryTypeDef(TypedDict):
    TranscriptionJobName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    TranscriptionJobStatus: NotRequired[TranscriptionJobStatusType],  # (2)
    FailureReason: NotRequired[str],
    OutputLocationType: NotRequired[OutputLocationTypeType],  # (3)
    ContentRedaction: NotRequired[ContentRedactionOutputTypeDef],  # (4)
    ModelSettings: NotRequired[ModelSettingsTypeDef],  # (5)
    IdentifyLanguage: NotRequired[bool],
    IdentifyMultipleLanguages: NotRequired[bool],
    IdentifiedLanguageScore: NotRequired[float],
    LanguageCodes: NotRequired[List[LanguageCodeItemTypeDef]],  # (6)
    ToxicityDetection: NotRequired[List[ToxicityDetectionSettingsOutputTypeDef]],  # (7)
  1. See LanguageCodeType
  2. See TranscriptionJobStatusType
  3. See OutputLocationTypeType
  4. See ContentRedactionOutputTypeDef
  5. See ModelSettingsTypeDef
  6. See LanguageCodeItemTypeDef
  7. See ToxicityDetectionSettingsOutputTypeDef

TranscriptionJobTypeDef#

# TranscriptionJobTypeDef definition

class TranscriptionJobTypeDef(TypedDict):
    TranscriptionJobName: NotRequired[str],
    TranscriptionJobStatus: NotRequired[TranscriptionJobStatusType],  # (1)
    LanguageCode: NotRequired[LanguageCodeType],  # (2)
    MediaSampleRateHertz: NotRequired[int],
    MediaFormat: NotRequired[MediaFormatType],  # (3)
    Media: NotRequired[MediaTypeDef],  # (4)
    Transcript: NotRequired[TranscriptTypeDef],  # (5)
    StartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    FailureReason: NotRequired[str],
    Settings: NotRequired[SettingsTypeDef],  # (6)
    ModelSettings: NotRequired[ModelSettingsTypeDef],  # (7)
    JobExecutionSettings: NotRequired[JobExecutionSettingsTypeDef],  # (8)
    ContentRedaction: NotRequired[ContentRedactionOutputTypeDef],  # (9)
    IdentifyLanguage: NotRequired[bool],
    IdentifyMultipleLanguages: NotRequired[bool],
    LanguageOptions: NotRequired[List[LanguageCodeType]],  # (10)
    IdentifiedLanguageScore: NotRequired[float],
    LanguageCodes: NotRequired[List[LanguageCodeItemTypeDef]],  # (11)
    Tags: NotRequired[List[TagTypeDef]],  # (12)
    Subtitles: NotRequired[SubtitlesOutputTypeDef],  # (13)
    LanguageIdSettings: NotRequired[Dict[LanguageCodeType, LanguageIdSettingsTypeDef]],  # (14)
    ToxicityDetection: NotRequired[List[ToxicityDetectionSettingsOutputTypeDef]],  # (15)
  1. See TranscriptionJobStatusType
  2. See LanguageCodeType
  3. See MediaFormatType
  4. See MediaTypeDef
  5. See TranscriptTypeDef
  6. See SettingsTypeDef
  7. See ModelSettingsTypeDef
  8. See JobExecutionSettingsTypeDef
  9. See ContentRedactionOutputTypeDef
  10. See LanguageCodeType
  11. See LanguageCodeItemTypeDef
  12. See TagTypeDef
  13. See SubtitlesOutputTypeDef
  14. See LanguageCodeType LanguageIdSettingsTypeDef
  15. See ToxicityDetectionSettingsOutputTypeDef

CallAnalyticsJobSummaryTypeDef#

# CallAnalyticsJobSummaryTypeDef definition

class CallAnalyticsJobSummaryTypeDef(TypedDict):
    CallAnalyticsJobName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    StartTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    LanguageCode: NotRequired[LanguageCodeType],  # (1)
    CallAnalyticsJobStatus: NotRequired[CallAnalyticsJobStatusType],  # (2)
    CallAnalyticsJobDetails: NotRequired[CallAnalyticsJobDetailsTypeDef],  # (3)
    FailureReason: NotRequired[str],
  1. See LanguageCodeType
  2. See CallAnalyticsJobStatusType
  3. See CallAnalyticsJobDetailsTypeDef

CallAnalyticsJobTypeDef#

# CallAnalyticsJobTypeDef definition

class CallAnalyticsJobTypeDef(TypedDict):
    CallAnalyticsJobName: NotRequired[str],
    CallAnalyticsJobStatus: NotRequired[CallAnalyticsJobStatusType],  # (1)
    CallAnalyticsJobDetails: NotRequired[CallAnalyticsJobDetailsTypeDef],  # (2)
    LanguageCode: NotRequired[LanguageCodeType],  # (3)
    MediaSampleRateHertz: NotRequired[int],
    MediaFormat: NotRequired[MediaFormatType],  # (4)
    Media: NotRequired[MediaTypeDef],  # (5)
    Transcript: NotRequired[TranscriptTypeDef],  # (6)
    StartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    FailureReason: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
    IdentifiedLanguageScore: NotRequired[float],
    Settings: NotRequired[CallAnalyticsJobSettingsOutputTypeDef],  # (7)
    ChannelDefinitions: NotRequired[List[ChannelDefinitionTypeDef]],  # (8)
  1. See CallAnalyticsJobStatusType
  2. See CallAnalyticsJobDetailsTypeDef
  3. See LanguageCodeType
  4. See MediaFormatType
  5. See MediaTypeDef
  6. See TranscriptTypeDef
  7. See CallAnalyticsJobSettingsOutputTypeDef
  8. See ChannelDefinitionTypeDef

CallAnalyticsJobSettingsTypeDef#

# CallAnalyticsJobSettingsTypeDef definition

class CallAnalyticsJobSettingsTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    VocabularyFilterName: NotRequired[str],
    VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType],  # (1)
    LanguageModelName: NotRequired[str],
    ContentRedaction: NotRequired[ContentRedactionUnionTypeDef],  # (2)
    LanguageOptions: NotRequired[Sequence[LanguageCodeType]],  # (3)
    LanguageIdSettings: NotRequired[Mapping[LanguageCodeType, LanguageIdSettingsTypeDef]],  # (4)
    Summarization: NotRequired[SummarizationTypeDef],  # (5)
  1. See VocabularyFilterMethodType
  2. See ContentRedactionTypeDef ContentRedactionOutputTypeDef
  3. See LanguageCodeType
  4. See LanguageCodeType LanguageIdSettingsTypeDef
  5. See SummarizationTypeDef

DescribeLanguageModelResponseTypeDef#

# DescribeLanguageModelResponseTypeDef definition

class DescribeLanguageModelResponseTypeDef(TypedDict):
    LanguageModel: LanguageModelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LanguageModelTypeDef
  2. See ResponseMetadataTypeDef

ListLanguageModelsResponseTypeDef#

# ListLanguageModelsResponseTypeDef definition

class ListLanguageModelsResponseTypeDef(TypedDict):
    Models: List[LanguageModelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See LanguageModelTypeDef
  2. See ResponseMetadataTypeDef

RuleOutputTypeDef#

# RuleOutputTypeDef definition

class RuleOutputTypeDef(TypedDict):
    NonTalkTimeFilter: NotRequired[NonTalkTimeFilterTypeDef],  # (1)
    InterruptionFilter: NotRequired[InterruptionFilterTypeDef],  # (2)
    TranscriptFilter: NotRequired[TranscriptFilterOutputTypeDef],  # (3)
    SentimentFilter: NotRequired[SentimentFilterOutputTypeDef],  # (4)
  1. See NonTalkTimeFilterTypeDef
  2. See InterruptionFilterTypeDef
  3. See TranscriptFilterOutputTypeDef
  4. See SentimentFilterOutputTypeDef

GetMedicalScribeJobResponseTypeDef#

# GetMedicalScribeJobResponseTypeDef definition

class GetMedicalScribeJobResponseTypeDef(TypedDict):
    MedicalScribeJob: MedicalScribeJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MedicalScribeJobTypeDef
  2. See ResponseMetadataTypeDef

StartMedicalScribeJobResponseTypeDef#

# StartMedicalScribeJobResponseTypeDef definition

class StartMedicalScribeJobResponseTypeDef(TypedDict):
    MedicalScribeJob: MedicalScribeJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MedicalScribeJobTypeDef
  2. See ResponseMetadataTypeDef

GetMedicalTranscriptionJobResponseTypeDef#

# GetMedicalTranscriptionJobResponseTypeDef definition

class GetMedicalTranscriptionJobResponseTypeDef(TypedDict):
    MedicalTranscriptionJob: MedicalTranscriptionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MedicalTranscriptionJobTypeDef
  2. See ResponseMetadataTypeDef

StartMedicalTranscriptionJobResponseTypeDef#

# StartMedicalTranscriptionJobResponseTypeDef definition

class StartMedicalTranscriptionJobResponseTypeDef(TypedDict):
    MedicalTranscriptionJob: MedicalTranscriptionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MedicalTranscriptionJobTypeDef
  2. See ResponseMetadataTypeDef

ListTranscriptionJobsResponseTypeDef#

# ListTranscriptionJobsResponseTypeDef definition

class ListTranscriptionJobsResponseTypeDef(TypedDict):
    Status: TranscriptionJobStatusType,  # (1)
    TranscriptionJobSummaries: List[TranscriptionJobSummaryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See TranscriptionJobStatusType
  2. See TranscriptionJobSummaryTypeDef
  3. See ResponseMetadataTypeDef

GetTranscriptionJobResponseTypeDef#

# GetTranscriptionJobResponseTypeDef definition

class GetTranscriptionJobResponseTypeDef(TypedDict):
    TranscriptionJob: TranscriptionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TranscriptionJobTypeDef
  2. See ResponseMetadataTypeDef

StartTranscriptionJobResponseTypeDef#

# StartTranscriptionJobResponseTypeDef definition

class StartTranscriptionJobResponseTypeDef(TypedDict):
    TranscriptionJob: TranscriptionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TranscriptionJobTypeDef
  2. See ResponseMetadataTypeDef

StartTranscriptionJobRequestRequestTypeDef#

# StartTranscriptionJobRequestRequestTypeDef definition

class StartTranscriptionJobRequestRequestTypeDef(TypedDict):
    TranscriptionJobName: str,
    Media: MediaTypeDef,  # (1)
    LanguageCode: NotRequired[LanguageCodeType],  # (2)
    MediaSampleRateHertz: NotRequired[int],
    MediaFormat: NotRequired[MediaFormatType],  # (3)
    OutputBucketName: NotRequired[str],
    OutputKey: NotRequired[str],
    OutputEncryptionKMSKeyId: NotRequired[str],
    KMSEncryptionContext: NotRequired[Mapping[str, str]],
    Settings: NotRequired[SettingsTypeDef],  # (4)
    ModelSettings: NotRequired[ModelSettingsTypeDef],  # (5)
    JobExecutionSettings: NotRequired[JobExecutionSettingsTypeDef],  # (6)
    ContentRedaction: NotRequired[ContentRedactionTypeDef],  # (7)
    IdentifyLanguage: NotRequired[bool],
    IdentifyMultipleLanguages: NotRequired[bool],
    LanguageOptions: NotRequired[Sequence[LanguageCodeType]],  # (8)
    Subtitles: NotRequired[SubtitlesTypeDef],  # (9)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (10)
    LanguageIdSettings: NotRequired[Mapping[LanguageCodeType, LanguageIdSettingsTypeDef]],  # (11)
    ToxicityDetection: NotRequired[Sequence[ToxicityDetectionSettingsUnionTypeDef]],  # (12)
  1. See MediaTypeDef
  2. See LanguageCodeType
  3. See MediaFormatType
  4. See SettingsTypeDef
  5. See ModelSettingsTypeDef
  6. See JobExecutionSettingsTypeDef
  7. See ContentRedactionTypeDef
  8. See LanguageCodeType
  9. See SubtitlesTypeDef
  10. See TagTypeDef
  11. See LanguageCodeType LanguageIdSettingsTypeDef
  12. See ToxicityDetectionSettingsTypeDef ToxicityDetectionSettingsOutputTypeDef

ListCallAnalyticsJobsResponseTypeDef#

# ListCallAnalyticsJobsResponseTypeDef definition

class ListCallAnalyticsJobsResponseTypeDef(TypedDict):
    Status: CallAnalyticsJobStatusType,  # (1)
    CallAnalyticsJobSummaries: List[CallAnalyticsJobSummaryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  1. See CallAnalyticsJobStatusType
  2. See CallAnalyticsJobSummaryTypeDef
  3. See ResponseMetadataTypeDef

GetCallAnalyticsJobResponseTypeDef#

# GetCallAnalyticsJobResponseTypeDef definition

class GetCallAnalyticsJobResponseTypeDef(TypedDict):
    CallAnalyticsJob: CallAnalyticsJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CallAnalyticsJobTypeDef
  2. See ResponseMetadataTypeDef

StartCallAnalyticsJobResponseTypeDef#

# StartCallAnalyticsJobResponseTypeDef definition

class StartCallAnalyticsJobResponseTypeDef(TypedDict):
    CallAnalyticsJob: CallAnalyticsJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CallAnalyticsJobTypeDef
  2. See ResponseMetadataTypeDef

StartCallAnalyticsJobRequestRequestTypeDef#

# StartCallAnalyticsJobRequestRequestTypeDef definition

class StartCallAnalyticsJobRequestRequestTypeDef(TypedDict):
    CallAnalyticsJobName: str,
    Media: MediaTypeDef,  # (1)
    OutputLocation: NotRequired[str],
    OutputEncryptionKMSKeyId: NotRequired[str],
    DataAccessRoleArn: NotRequired[str],
    Settings: NotRequired[CallAnalyticsJobSettingsTypeDef],  # (2)
    ChannelDefinitions: NotRequired[Sequence[ChannelDefinitionTypeDef]],  # (3)
  1. See MediaTypeDef
  2. See CallAnalyticsJobSettingsTypeDef
  3. See ChannelDefinitionTypeDef

CategoryPropertiesTypeDef#

# CategoryPropertiesTypeDef definition

class CategoryPropertiesTypeDef(TypedDict):
    CategoryName: NotRequired[str],
    Rules: NotRequired[List[RuleOutputTypeDef]],  # (1)
    CreateTime: NotRequired[datetime],
    LastUpdateTime: NotRequired[datetime],
    InputType: NotRequired[InputTypeType],  # (2)
  1. See RuleOutputTypeDef
  2. See InputTypeType

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    NonTalkTimeFilter: NotRequired[NonTalkTimeFilterTypeDef],  # (1)
    InterruptionFilter: NotRequired[InterruptionFilterTypeDef],  # (2)
    TranscriptFilter: NotRequired[TranscriptFilterUnionTypeDef],  # (3)
    SentimentFilter: NotRequired[SentimentFilterUnionTypeDef],  # (4)
  1. See NonTalkTimeFilterTypeDef
  2. See InterruptionFilterTypeDef
  3. See TranscriptFilterTypeDef TranscriptFilterOutputTypeDef
  4. See SentimentFilterTypeDef SentimentFilterOutputTypeDef

CreateCallAnalyticsCategoryResponseTypeDef#

# CreateCallAnalyticsCategoryResponseTypeDef definition

class CreateCallAnalyticsCategoryResponseTypeDef(TypedDict):
    CategoryProperties: CategoryPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryPropertiesTypeDef
  2. See ResponseMetadataTypeDef

GetCallAnalyticsCategoryResponseTypeDef#

# GetCallAnalyticsCategoryResponseTypeDef definition

class GetCallAnalyticsCategoryResponseTypeDef(TypedDict):
    CategoryProperties: CategoryPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryPropertiesTypeDef
  2. See ResponseMetadataTypeDef

ListCallAnalyticsCategoriesResponseTypeDef#

# ListCallAnalyticsCategoriesResponseTypeDef definition

class ListCallAnalyticsCategoriesResponseTypeDef(TypedDict):
    Categories: List[CategoryPropertiesTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CategoryPropertiesTypeDef
  2. See ResponseMetadataTypeDef

UpdateCallAnalyticsCategoryResponseTypeDef#

# UpdateCallAnalyticsCategoryResponseTypeDef definition

class UpdateCallAnalyticsCategoryResponseTypeDef(TypedDict):
    CategoryProperties: CategoryPropertiesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryPropertiesTypeDef
  2. See ResponseMetadataTypeDef

UpdateCallAnalyticsCategoryRequestRequestTypeDef#

# UpdateCallAnalyticsCategoryRequestRequestTypeDef definition

class UpdateCallAnalyticsCategoryRequestRequestTypeDef(TypedDict):
    CategoryName: str,
    Rules: Sequence[RuleTypeDef],  # (1)
    InputType: NotRequired[InputTypeType],  # (2)
  1. See RuleTypeDef
  2. See InputTypeType

CreateCallAnalyticsCategoryRequestRequestTypeDef#

# CreateCallAnalyticsCategoryRequestRequestTypeDef definition

class CreateCallAnalyticsCategoryRequestRequestTypeDef(TypedDict):
    CategoryName: str,
    Rules: Sequence[RuleUnionTypeDef],  # (1)
    InputType: NotRequired[InputTypeType],  # (2)
  1. See RuleTypeDef RuleOutputTypeDef
  2. See InputTypeType