Skip to content

Type definitions#

Index > TranscribeService > Type definitions

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

AbsoluteTimeRangeTypeDef#

# AbsoluteTimeRangeTypeDef definition

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

ContentRedactionTypeDef#

# ContentRedactionTypeDef definition

class ContentRedactionTypeDef(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,

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)
    FailureReason: NotRequired[str],
  1. See LanguageCodeType
  2. See CallAnalyticsJobStatusType

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],

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

ToxicityDetectionSettingsTypeDef#

# ToxicityDetectionSettingsTypeDef definition

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

SubtitlesOutputTypeDef#

# SubtitlesOutputTypeDef definition

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

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

CallAnalyticsJobSettingsTypeDef#

# CallAnalyticsJobSettingsTypeDef definition

class CallAnalyticsJobSettingsTypeDef(TypedDict):
    VocabularyName: NotRequired[str],
    VocabularyFilterName: NotRequired[str],
    VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType],  # (1)
    LanguageModelName: NotRequired[str],
    ContentRedaction: NotRequired[ContentRedactionTypeDef],  # (2)
    LanguageOptions: NotRequired[List[LanguageCodeType]],  # (3)
    LanguageIdSettings: NotRequired[Dict[LanguageCodeType, LanguageI