TranscribeServiceClient

Index > TranscribeService > TranscribeServiceClient

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

TranscribeServiceClient

Type annotations and code completion for boto3.client("transcribe"). boto3 documentation

# TranscribeServiceClient usage example

from boto3.session import Session
from types_boto3_transcribe.client import TranscribeServiceClient

def get_transcribe_client() -> TranscribeServiceClient:
    return Session().client("transcribe")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("transcribe").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("transcribe")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalFailureException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_transcribe.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("transcribe").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("transcribe").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_call_analytics_category

Creates a new Call Analytics category.

Type annotations and code completion for boto3.client("transcribe").create_call_analytics_category method. boto3 documentation

# create_call_analytics_category method definition

def create_call_analytics_category(
    self,
    *,
    CategoryName: str,
    Rules: Sequence[RuleUnionTypeDef],  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    InputType: InputTypeType = ...,  # (3)
) -> CreateCallAnalyticsCategoryResponseTypeDef:  # (4)
    ...

1. See Sequence[RuleUnionTypeDef]
2. See Sequence[TagTypeDef]
3. See InputTypeType
4. See CreateCallAnalyticsCategoryResponseTypeDef

# create_call_analytics_category method usage example with argument unpacking

kwargs: CreateCallAnalyticsCategoryRequestTypeDef = {  # (1)
    "CategoryName": ...,
    "Rules": ...,
}

parent.create_call_analytics_category(**kwargs)

1. See CreateCallAnalyticsCategoryRequestTypeDef

create_language_model

Creates a new custom language model.

Type annotations and code completion for boto3.client("transcribe").create_language_model method. boto3 documentation

# create_language_model method definition

def create_language_model(
    self,
    *,
    LanguageCode: CLMLanguageCodeType,  # (1)
    BaseModelName: BaseModelNameType,  # (2)
    ModelName: str,
    InputDataConfig: InputDataConfigTypeDef,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateLanguageModelResponseTypeDef:  # (5)
    ...

1. See CLMLanguageCodeType
2. See BaseModelNameType
3. See InputDataConfigTypeDef
4. See Sequence[TagTypeDef]
5. See CreateLanguageModelResponseTypeDef

# create_language_model method usage example with argument unpacking

kwargs: CreateLanguageModelRequestTypeDef = {  # (1)
    "LanguageCode": ...,
    "BaseModelName": ...,
    "ModelName": ...,
    "InputDataConfig": ...,
}

parent.create_language_model(**kwargs)

1. See CreateLanguageModelRequestTypeDef

create_medical_vocabulary

Creates a new custom medical vocabulary.

Type annotations and code completion for boto3.client("transcribe").create_medical_vocabulary method. boto3 documentation

# create_medical_vocabulary method definition

def create_medical_vocabulary(
    self,
    *,
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyFileUri: str,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMedicalVocabularyResponseTypeDef:  # (3)
    ...

1. See LanguageCodeType
2. See Sequence[TagTypeDef]
3. See CreateMedicalVocabularyResponseTypeDef

# create_medical_vocabulary method usage example with argument unpacking

kwargs: CreateMedicalVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
    "LanguageCode": ...,
    "VocabularyFileUri": ...,
}

parent.create_medical_vocabulary(**kwargs)

1. See CreateMedicalVocabularyRequestTypeDef

create_vocabulary

Creates a new custom vocabulary.

Type annotations and code completion for boto3.client("transcribe").create_vocabulary method. boto3 documentation

# create_vocabulary method definition

def create_vocabulary(
    self,
    *,
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Phrases: Sequence[str] = ...,
    VocabularyFileUri: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    DataAccessRoleArn: str = ...,
) -> CreateVocabularyResponseTypeDef:  # (3)
    ...

1. See LanguageCodeType
2. See Sequence[TagTypeDef]
3. See CreateVocabularyResponseTypeDef

# create_vocabulary method usage example with argument unpacking

kwargs: CreateVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
    "LanguageCode": ...,
}

parent.create_vocabulary(**kwargs)

1. See CreateVocabularyRequestTypeDef

create_vocabulary_filter

Creates a new custom vocabulary filter.

Type annotations and code completion for boto3.client("transcribe").create_vocabulary_filter method. boto3 documentation

# create_vocabulary_filter method definition

def create_vocabulary_filter(
    self,
    *,
    VocabularyFilterName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Words: Sequence[str] = ...,
    VocabularyFilterFileUri: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    DataAccessRoleArn: str = ...,
) -> CreateVocabularyFilterResponseTypeDef:  # (3)
    ...

1. See LanguageCodeType
2. See Sequence[TagTypeDef]
3. See CreateVocabularyFilterResponseTypeDef

# create_vocabulary_filter method usage example with argument unpacking

kwargs: CreateVocabularyFilterRequestTypeDef = {  # (1)
    "VocabularyFilterName": ...,
    "LanguageCode": ...,
}

parent.create_vocabulary_filter(**kwargs)

1. See CreateVocabularyFilterRequestTypeDef

delete_call_analytics_category

Deletes a Call Analytics category.

Type annotations and code completion for boto3.client("transcribe").delete_call_analytics_category method. boto3 documentation

# delete_call_analytics_category method definition

def delete_call_analytics_category(
    self,
    *,
    CategoryName: str,
) -> Dict[str, Any]:
    ...

# delete_call_analytics_category method usage example with argument unpacking

kwargs: DeleteCallAnalyticsCategoryRequestTypeDef = {  # (1)
    "CategoryName": ...,
}

parent.delete_call_analytics_category(**kwargs)

1. See DeleteCallAnalyticsCategoryRequestTypeDef

delete_call_analytics_job

Deletes a Call Analytics job.

Type annotations and code completion for boto3.client("transcribe").delete_call_analytics_job method. boto3 documentation

# delete_call_analytics_job method definition

def delete_call_analytics_job(
    self,
    *,
    CallAnalyticsJobName: str,
) -> Dict[str, Any]:
    ...

# delete_call_analytics_job method usage example with argument unpacking

kwargs: DeleteCallAnalyticsJobRequestTypeDef = {  # (1)
    "CallAnalyticsJobName": ...,
}

parent.delete_call_analytics_job(**kwargs)

1. See DeleteCallAnalyticsJobRequestTypeDef

delete_language_model

Deletes a custom language model.

Type annotations and code completion for boto3.client("transcribe").delete_language_model method. boto3 documentation

# delete_language_model method definition

def delete_language_model(
    self,
    *,
    ModelName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_language_model method usage example with argument unpacking

kwargs: DeleteLanguageModelRequestTypeDef = {  # (1)
    "ModelName": ...,
}

parent.delete_language_model(**kwargs)

1. See DeleteLanguageModelRequestTypeDef

delete_medical_scribe_job

Deletes a Medical Scribe job.

Type annotations and code completion for boto3.client("transcribe").delete_medical_scribe_job method. boto3 documentation

# delete_medical_scribe_job method definition

def delete_medical_scribe_job(
    self,
    *,
    MedicalScribeJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_medical_scribe_job method usage example with argument unpacking

kwargs: DeleteMedicalScribeJobRequestTypeDef = {  # (1)
    "MedicalScribeJobName": ...,
}

parent.delete_medical_scribe_job(**kwargs)

1. See DeleteMedicalScribeJobRequestTypeDef

delete_medical_transcription_job

Deletes a medical transcription job.

Type annotations and code completion for boto3.client("transcribe").delete_medical_transcription_job method. boto3 documentation

# delete_medical_transcription_job method definition

def delete_medical_transcription_job(
    self,
    *,
    MedicalTranscriptionJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_medical_transcription_job method usage example with argument unpacking

kwargs: DeleteMedicalTranscriptionJobRequestTypeDef = {  # (1)
    "MedicalTranscriptionJobName": ...,
}

parent.delete_medical_transcription_job(**kwargs)

1. See DeleteMedicalTranscriptionJobRequestTypeDef

delete_medical_vocabulary

Deletes a custom medical vocabulary.

Type annotations and code completion for boto3.client("transcribe").delete_medical_vocabulary method. boto3 documentation

# delete_medical_vocabulary method definition

def delete_medical_vocabulary(
    self,
    *,
    VocabularyName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_medical_vocabulary method usage example with argument unpacking

kwargs: DeleteMedicalVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
}

parent.delete_medical_vocabulary(**kwargs)

1. See DeleteMedicalVocabularyRequestTypeDef

delete_transcription_job

Deletes a transcription job.

Type annotations and code completion for boto3.client("transcribe").delete_transcription_job method. boto3 documentation

# delete_transcription_job method definition

def delete_transcription_job(
    self,
    *,
    TranscriptionJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_transcription_job method usage example with argument unpacking

kwargs: DeleteTranscriptionJobRequestTypeDef = {  # (1)
    "TranscriptionJobName": ...,
}

parent.delete_transcription_job(**kwargs)

1. See DeleteTranscriptionJobRequestTypeDef

delete_vocabulary

Deletes a custom vocabulary.

Type annotations and code completion for boto3.client("transcribe").delete_vocabulary method. boto3 documentation

# delete_vocabulary method definition

def delete_vocabulary(
    self,
    *,
    VocabularyName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_vocabulary method usage example with argument unpacking

kwargs: DeleteVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
}

parent.delete_vocabulary(**kwargs)

1. See DeleteVocabularyRequestTypeDef

delete_vocabulary_filter

Deletes a custom vocabulary filter.

Type annotations and code completion for boto3.client("transcribe").delete_vocabulary_filter method. boto3 documentation

# delete_vocabulary_filter method definition

def delete_vocabulary_filter(
    self,
    *,
    VocabularyFilterName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_vocabulary_filter method usage example with argument unpacking

kwargs: DeleteVocabularyFilterRequestTypeDef = {  # (1)
    "VocabularyFilterName": ...,
}

parent.delete_vocabulary_filter(**kwargs)

1. See DeleteVocabularyFilterRequestTypeDef

describe_language_model

Provides information about the specified custom language model.

Type annotations and code completion for boto3.client("transcribe").describe_language_model method. boto3 documentation

# describe_language_model method definition

def describe_language_model(
    self,
    *,
    ModelName: str,
) -> DescribeLanguageModelResponseTypeDef:  # (1)
    ...

1. See DescribeLanguageModelResponseTypeDef

# describe_language_model method usage example with argument unpacking

kwargs: DescribeLanguageModelRequestTypeDef = {  # (1)
    "ModelName": ...,
}

parent.describe_language_model(**kwargs)

1. See DescribeLanguageModelRequestTypeDef

get_call_analytics_category

Provides information about the specified Call Analytics category.

Type annotations and code completion for boto3.client("transcribe").get_call_analytics_category method. boto3 documentation

# get_call_analytics_category method definition

def get_call_analytics_category(
    self,
    *,
    CategoryName: str,
) -> GetCallAnalyticsCategoryResponseTypeDef:  # (1)
    ...

1. See GetCallAnalyticsCategoryResponseTypeDef

# get_call_analytics_category method usage example with argument unpacking

kwargs: GetCallAnalyticsCategoryRequestTypeDef = {  # (1)
    "CategoryName": ...,
}

parent.get_call_analytics_category(**kwargs)

1. See GetCallAnalyticsCategoryRequestTypeDef

get_call_analytics_job

Provides information about the specified Call Analytics job.

Type annotations and code completion for boto3.client("transcribe").get_call_analytics_job method. boto3 documentation

# get_call_analytics_job method definition

def get_call_analytics_job(
    self,
    *,
    CallAnalyticsJobName: str,
) -> GetCallAnalyticsJobResponseTypeDef:  # (1)
    ...

1. See GetCallAnalyticsJobResponseTypeDef

# get_call_analytics_job method usage example with argument unpacking

kwargs: GetCallAnalyticsJobRequestTypeDef = {  # (1)
    "CallAnalyticsJobName": ...,
}

parent.get_call_analytics_job(**kwargs)

1. See GetCallAnalyticsJobRequestTypeDef

get_medical_scribe_job

Provides information about the specified Medical Scribe job.

Type annotations and code completion for boto3.client("transcribe").get_medical_scribe_job method. boto3 documentation

# get_medical_scribe_job method definition

def get_medical_scribe_job(
    self,
    *,
    MedicalScribeJobName: str,
) -> GetMedicalScribeJobResponseTypeDef:  # (1)
    ...

1. See GetMedicalScribeJobResponseTypeDef

# get_medical_scribe_job method usage example with argument unpacking

kwargs: GetMedicalScribeJobRequestTypeDef = {  # (1)
    "MedicalScribeJobName": ...,
}

parent.get_medical_scribe_job(**kwargs)

1. See GetMedicalScribeJobRequestTypeDef

get_medical_transcription_job

Provides information about the specified medical transcription job.

Type annotations and code completion for boto3.client("transcribe").get_medical_transcription_job method. boto3 documentation

# get_medical_transcription_job method definition

def get_medical_transcription_job(
    self,
    *,
    MedicalTranscriptionJobName: str,
) -> GetMedicalTranscriptionJobResponseTypeDef:  # (1)
    ...

1. See GetMedicalTranscriptionJobResponseTypeDef

# get_medical_transcription_job method usage example with argument unpacking

kwargs: GetMedicalTranscriptionJobRequestTypeDef = {  # (1)
    "MedicalTranscriptionJobName": ...,
}

parent.get_medical_transcription_job(**kwargs)

1. See GetMedicalTranscriptionJobRequestTypeDef

get_medical_vocabulary

Provides information about the specified custom medical vocabulary.

Type annotations and code completion for boto3.client("transcribe").get_medical_vocabulary method. boto3 documentation

# get_medical_vocabulary method definition

def get_medical_vocabulary(
    self,
    *,
    VocabularyName: str,
) -> GetMedicalVocabularyResponseTypeDef:  # (1)
    ...

1. See GetMedicalVocabularyResponseTypeDef

# get_medical_vocabulary method usage example with argument unpacking

kwargs: GetMedicalVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
}

parent.get_medical_vocabulary(**kwargs)

1. See GetMedicalVocabularyRequestTypeDef

get_transcription_job

Provides information about the specified transcription job.

Type annotations and code completion for boto3.client("transcribe").get_transcription_job method. boto3 documentation

# get_transcription_job method definition

def get_transcription_job(
    self,
    *,
    TranscriptionJobName: str,
) -> GetTranscriptionJobResponseTypeDef:  # (1)
    ...

1. See GetTranscriptionJobResponseTypeDef

# get_transcription_job method usage example with argument unpacking

kwargs: GetTranscriptionJobRequestTypeDef = {  # (1)
    "TranscriptionJobName": ...,
}

parent.get_transcription_job(**kwargs)

1. See GetTranscriptionJobRequestTypeDef

get_vocabulary

Provides information about the specified custom vocabulary.

Type annotations and code completion for boto3.client("transcribe").get_vocabulary method. boto3 documentation

# get_vocabulary method definition

def get_vocabulary(
    self,
    *,
    VocabularyName: str,
) -> GetVocabularyResponseTypeDef:  # (1)
    ...

1. See GetVocabularyResponseTypeDef

# get_vocabulary method usage example with argument unpacking

kwargs: GetVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
}

parent.get_vocabulary(**kwargs)

1. See GetVocabularyRequestTypeDef

get_vocabulary_filter

Provides information about the specified custom vocabulary filter.

Type annotations and code completion for boto3.client("transcribe").get_vocabulary_filter method. boto3 documentation

# get_vocabulary_filter method definition

def get_vocabulary_filter(
    self,
    *,
    VocabularyFilterName: str,
) -> GetVocabularyFilterResponseTypeDef:  # (1)
    ...

1. See GetVocabularyFilterResponseTypeDef

# get_vocabulary_filter method usage example with argument unpacking

kwargs: GetVocabularyFilterRequestTypeDef = {  # (1)
    "VocabularyFilterName": ...,
}

parent.get_vocabulary_filter(**kwargs)

1. See GetVocabularyFilterRequestTypeDef

list_call_analytics_categories

Provides a list of Call Analytics categories, including all rules that make up each category.

Type annotations and code completion for boto3.client("transcribe").list_call_analytics_categories method. boto3 documentation

# list_call_analytics_categories method definition

def list_call_analytics_categories(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCallAnalyticsCategoriesResponseTypeDef:  # (1)
    ...

1. See ListCallAnalyticsCategoriesResponseTypeDef

# list_call_analytics_categories method usage example with argument unpacking

kwargs: ListCallAnalyticsCategoriesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_call_analytics_categories(**kwargs)

1. See ListCallAnalyticsCategoriesRequestTypeDef

list_call_analytics_jobs

Provides a list of Call Analytics jobs that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_call_analytics_jobs method. boto3 documentation

# list_call_analytics_jobs method definition

def list_call_analytics_jobs(
    self,
    *,
    Status: CallAnalyticsJobStatusType = ...,  # (1)
    JobNameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCallAnalyticsJobsResponseTypeDef:  # (2)
    ...

1. See CallAnalyticsJobStatusType
2. See ListCallAnalyticsJobsResponseTypeDef

# list_call_analytics_jobs method usage example with argument unpacking

kwargs: ListCallAnalyticsJobsRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_call_analytics_jobs(**kwargs)

1. See ListCallAnalyticsJobsRequestTypeDef

list_language_models

Provides a list of custom language models that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_language_models method. boto3 documentation

# list_language_models method definition

def list_language_models(
    self,
    *,
    StatusEquals: ModelStatusType = ...,  # (1)
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLanguageModelsResponseTypeDef:  # (2)
    ...

1. See ModelStatusType
2. See ListLanguageModelsResponseTypeDef

# list_language_models method usage example with argument unpacking

kwargs: ListLanguageModelsRequestTypeDef = {  # (1)
    "StatusEquals": ...,
}

parent.list_language_models(**kwargs)

1. See ListLanguageModelsRequestTypeDef

list_medical_scribe_jobs

Provides a list of Medical Scribe jobs that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_medical_scribe_jobs method. boto3 documentation

# list_medical_scribe_jobs method definition

def list_medical_scribe_jobs(
    self,
    *,
    Status: MedicalScribeJobStatusType = ...,  # (1)
    JobNameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMedicalScribeJobsResponseTypeDef:  # (2)
    ...

1. See MedicalScribeJobStatusType
2. See ListMedicalScribeJobsResponseTypeDef

# list_medical_scribe_jobs method usage example with argument unpacking

kwargs: ListMedicalScribeJobsRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_medical_scribe_jobs(**kwargs)

1. See ListMedicalScribeJobsRequestTypeDef

list_medical_transcription_jobs

Provides a list of medical transcription jobs that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_medical_transcription_jobs method. boto3 documentation

# list_medical_transcription_jobs method definition

def list_medical_transcription_jobs(
    self,
    *,
    Status: TranscriptionJobStatusType = ...,  # (1)
    JobNameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMedicalTranscriptionJobsResponseTypeDef:  # (2)
    ...

1. See TranscriptionJobStatusType
2. See ListMedicalTranscriptionJobsResponseTypeDef

# list_medical_transcription_jobs method usage example with argument unpacking

kwargs: ListMedicalTranscriptionJobsRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_medical_transcription_jobs(**kwargs)

1. See ListMedicalTranscriptionJobsRequestTypeDef

list_medical_vocabularies

Provides a list of custom medical vocabularies that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_medical_vocabularies method. boto3 documentation

# list_medical_vocabularies method definition

def list_medical_vocabularies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    StateEquals: VocabularyStateType = ...,  # (1)
    NameContains: str = ...,
) -> ListMedicalVocabulariesResponseTypeDef:  # (2)
    ...

1. See VocabularyStateType
2. See ListMedicalVocabulariesResponseTypeDef

# list_medical_vocabularies method usage example with argument unpacking

kwargs: ListMedicalVocabulariesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_medical_vocabularies(**kwargs)

1. See ListMedicalVocabulariesRequestTypeDef

list_tags_for_resource

Lists all tags associated with the specified transcription job, vocabulary, model, or resource.

Type annotations and code completion for boto3.client("transcribe").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_transcription_jobs

Provides a list of transcription jobs that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_transcription_jobs method. boto3 documentation

# list_transcription_jobs method definition

def list_transcription_jobs(
    self,
    *,
    Status: TranscriptionJobStatusType = ...,  # (1)
    JobNameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTranscriptionJobsResponseTypeDef:  # (2)
    ...

1. See TranscriptionJobStatusType
2. See ListTranscriptionJobsResponseTypeDef

# list_transcription_jobs method usage example with argument unpacking

kwargs: ListTranscriptionJobsRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_transcription_jobs(**kwargs)

1. See ListTranscriptionJobsRequestTypeDef

list_vocabularies

Provides a list of custom vocabularies that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_vocabularies method. boto3 documentation

# list_vocabularies method definition

def list_vocabularies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    StateEquals: VocabularyStateType = ...,  # (1)
    NameContains: str = ...,
) -> ListVocabulariesResponseTypeDef:  # (2)
    ...

1. See VocabularyStateType
2. See ListVocabulariesResponseTypeDef

# list_vocabularies method usage example with argument unpacking

kwargs: ListVocabulariesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_vocabularies(**kwargs)

1. See ListVocabulariesRequestTypeDef

list_vocabulary_filters

Provides a list of custom vocabulary filters that match the specified criteria.

Type annotations and code completion for boto3.client("transcribe").list_vocabulary_filters method. boto3 documentation

# list_vocabulary_filters method definition

def list_vocabulary_filters(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
) -> ListVocabularyFiltersResponseTypeDef:  # (1)
    ...

1. See ListVocabularyFiltersResponseTypeDef

# list_vocabulary_filters method usage example with argument unpacking

kwargs: ListVocabularyFiltersRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_vocabulary_filters(**kwargs)

1. See ListVocabularyFiltersRequestTypeDef

start_call_analytics_job

Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

Type annotations and code completion for boto3.client("transcribe").start_call_analytics_job method. boto3 documentation

# start_call_analytics_job method definition

def start_call_analytics_job(
    self,
    *,
    CallAnalyticsJobName: str,
    Media: MediaTypeDef,  # (1)
    OutputLocation: str = ...,
    OutputEncryptionKMSKeyId: str = ...,
    DataAccessRoleArn: str = ...,
    Settings: CallAnalyticsJobSettingsUnionTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ChannelDefinitions: Sequence[ChannelDefinitionTypeDef] = ...,  # (4)
) -> StartCallAnalyticsJobResponseTypeDef:  # (5)
    ...

1. See MediaTypeDef
2. See CallAnalyticsJobSettingsUnionTypeDef
3. See Sequence[TagTypeDef]
4. See Sequence[ChannelDefinitionTypeDef]
5. See StartCallAnalyticsJobResponseTypeDef

# start_call_analytics_job method usage example with argument unpacking

kwargs: StartCallAnalyticsJobRequestTypeDef = {  # (1)
    "CallAnalyticsJobName": ...,
    "Media": ...,
}

parent.start_call_analytics_job(**kwargs)

1. See StartCallAnalyticsJobRequestTypeDef

start_medical_scribe_job

Transcribes patient-clinician conversations and generates clinical notes.

Type annotations and code completion for boto3.client("transcribe").start_medical_scribe_job method. boto3 documentation

# start_medical_scribe_job method definition

def start_medical_scribe_job(
    self,
    *,
    MedicalScribeJobName: str,
    Media: MediaTypeDef,  # (1)
    OutputBucketName: str,
    DataAccessRoleArn: str,
    Settings: MedicalScribeSettingsTypeDef,  # (2)
    OutputEncryptionKMSKeyId: str = ...,
    KMSEncryptionContext: Mapping[str, str] = ...,
    ChannelDefinitions: Sequence[MedicalScribeChannelDefinitionTypeDef] = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    MedicalScribeContext: MedicalScribeContextTypeDef = ...,  # (5)
) -> StartMedicalScribeJobResponseTypeDef:  # (6)
    ...

1. See MediaTypeDef
2. See MedicalScribeSettingsTypeDef
3. See Sequence[MedicalScribeChannelDefinitionTypeDef]
4. See Sequence[TagTypeDef]
5. See MedicalScribeContextTypeDef
6. See StartMedicalScribeJobResponseTypeDef

# start_medical_scribe_job method usage example with argument unpacking

kwargs: StartMedicalScribeJobRequestTypeDef = {  # (1)
    "MedicalScribeJobName": ...,
    "Media": ...,
    "OutputBucketName": ...,
    "DataAccessRoleArn": ...,
    "Settings": ...,
}

parent.start_medical_scribe_job(**kwargs)

1. See StartMedicalScribeJobRequestTypeDef

start_medical_transcription_job

Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

Type annotations and code completion for boto3.client("transcribe").start_medical_transcription_job method. boto3 documentation

# start_medical_transcription_job method definition

def start_medical_transcription_job(
    self,
    *,
    MedicalTranscriptionJobName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Media: MediaTypeDef,  # (2)
    OutputBucketName: str,
    Specialty: SpecialtyType,  # (3)
    Type: TypeType,  # (4)
    MediaSampleRateHertz: int = ...,
    MediaFormat: MediaFormatType = ...,  # (5)
    OutputKey: str = ...,
    OutputEncryptionKMSKeyId: str = ...,
    KMSEncryptionContext: Mapping[str, str] = ...,
    Settings: MedicalTranscriptionSettingTypeDef = ...,  # (6)
    ContentIdentificationType: MedicalContentIdentificationTypeType = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> StartMedicalTranscriptionJobResponseTypeDef:  # (9)
    ...

1. See LanguageCodeType
2. See MediaTypeDef
3. See SpecialtyType
4. See TypeType
5. See MediaFormatType
6. See MedicalTranscriptionSettingTypeDef
7. See MedicalContentIdentificationTypeType
8. See Sequence[TagTypeDef]
9. See StartMedicalTranscriptionJobResponseTypeDef

# start_medical_transcription_job method usage example with argument unpacking

kwargs: StartMedicalTranscriptionJobRequestTypeDef = {  # (1)
    "MedicalTranscriptionJobName": ...,
    "LanguageCode": ...,
    "Media": ...,
    "OutputBucketName": ...,
    "Specialty": ...,
    "Type": ...,
}

parent.start_medical_transcription_job(**kwargs)

1. See StartMedicalTranscriptionJobRequestTypeDef

start_transcription_job

Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

Type annotations and code completion for boto3.client("transcribe").start_transcription_job method. boto3 documentation

# start_transcription_job method definition

def start_transcription_job(
    self,
    *,
    TranscriptionJobName: str,
    Media: MediaTypeDef,  # (1)
    LanguageCode: LanguageCodeType = ...,  # (2)
    MediaSampleRateHertz: int = ...,
    MediaFormat: MediaFormatType = ...,  # (3)
    OutputBucketName: str = ...,
    OutputKey: str = ...,
    OutputEncryptionKMSKeyId: str = ...,
    KMSEncryptionContext: Mapping[str, str] = ...,
    Settings: SettingsTypeDef = ...,  # (4)
    ModelSettings: ModelSettingsTypeDef = ...,  # (5)
    JobExecutionSettings: JobExecutionSettingsTypeDef = ...,  # (6)
    ContentRedaction: ContentRedactionUnionTypeDef = ...,  # (7)
    IdentifyLanguage: bool = ...,
    IdentifyMultipleLanguages: bool = ...,
    LanguageOptions: Sequence[LanguageCodeType] = ...,  # (8)
    Subtitles: SubtitlesTypeDef = ...,  # (9)
    Tags: Sequence[TagTypeDef] = ...,  # (10)
    LanguageIdSettings: Mapping[LanguageCodeType, LanguageIdSettingsTypeDef] = ...,  # (11)
    ToxicityDetection: Sequence[ToxicityDetectionSettingsUnionTypeDef] = ...,  # (12)
) -> StartTranscriptionJobResponseTypeDef:  # (13)
    ...

1. See MediaTypeDef
2. See LanguageCodeType
3. See MediaFormatType
4. See SettingsTypeDef
5. See ModelSettingsTypeDef
6. See JobExecutionSettingsTypeDef
7. See ContentRedactionUnionTypeDef
8. See Sequence[LanguageCodeType]
9. See SubtitlesTypeDef
10. See Sequence[TagTypeDef]
11. See Mapping[LanguageCodeType, LanguageIdSettingsTypeDef]
12. See Sequence[ToxicityDetectionSettingsUnionTypeDef]
13. See StartTranscriptionJobResponseTypeDef

# start_transcription_job method usage example with argument unpacking

kwargs: StartTranscriptionJobRequestTypeDef = {  # (1)
    "TranscriptionJobName": ...,
    "Media": ...,
}

parent.start_transcription_job(**kwargs)

1. See StartTranscriptionJobRequestTypeDef

tag_resource

Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

Type annotations and code completion for boto3.client("transcribe").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes the specified tags from the specified Amazon Transcribe resource.

Type annotations and code completion for boto3.client("transcribe").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_call_analytics_category

Updates the specified Call Analytics category with new rules.

Type annotations and code completion for boto3.client("transcribe").update_call_analytics_category method. boto3 documentation

# update_call_analytics_category method definition

def update_call_analytics_category(
    self,
    *,
    CategoryName: str,
    Rules: Sequence[RuleUnionTypeDef],  # (1)
    InputType: InputTypeType = ...,  # (2)
) -> UpdateCallAnalyticsCategoryResponseTypeDef:  # (3)
    ...

1. See Sequence[RuleUnionTypeDef]
2. See InputTypeType
3. See UpdateCallAnalyticsCategoryResponseTypeDef

# update_call_analytics_category method usage example with argument unpacking

kwargs: UpdateCallAnalyticsCategoryRequestTypeDef = {  # (1)
    "CategoryName": ...,
    "Rules": ...,
}

parent.update_call_analytics_category(**kwargs)

1. See UpdateCallAnalyticsCategoryRequestTypeDef

update_medical_vocabulary

Updates an existing custom medical vocabulary with new values.

Type annotations and code completion for boto3.client("transcribe").update_medical_vocabulary method. boto3 documentation

# update_medical_vocabulary method definition

def update_medical_vocabulary(
    self,
    *,
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    VocabularyFileUri: str,
) -> UpdateMedicalVocabularyResponseTypeDef:  # (2)
    ...

1. See LanguageCodeType
2. See UpdateMedicalVocabularyResponseTypeDef

# update_medical_vocabulary method usage example with argument unpacking

kwargs: UpdateMedicalVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
    "LanguageCode": ...,
    "VocabularyFileUri": ...,
}

parent.update_medical_vocabulary(**kwargs)

1. See UpdateMedicalVocabularyRequestTypeDef

update_vocabulary

Updates an existing custom vocabulary with new values.

Type annotations and code completion for boto3.client("transcribe").update_vocabulary method. boto3 documentation

# update_vocabulary method definition

def update_vocabulary(
    self,
    *,
    VocabularyName: str,
    LanguageCode: LanguageCodeType,  # (1)
    Phrases: Sequence[str] = ...,
    VocabularyFileUri: str = ...,
    DataAccessRoleArn: str = ...,
) -> UpdateVocabularyResponseTypeDef:  # (2)
    ...

1. See LanguageCodeType
2. See UpdateVocabularyResponseTypeDef

# update_vocabulary method usage example with argument unpacking

kwargs: UpdateVocabularyRequestTypeDef = {  # (1)
    "VocabularyName": ...,
    "LanguageCode": ...,
}

parent.update_vocabulary(**kwargs)

1. See UpdateVocabularyRequestTypeDef

update_vocabulary_filter

Updates an existing custom vocabulary filter with a new list of words.

Type annotations and code completion for boto3.client("transcribe").update_vocabulary_filter method. boto3 documentation

# update_vocabulary_filter method definition

def update_vocabulary_filter(
    self,
    *,
    VocabularyFilterName: str,
    Words: Sequence[str] = ...,
    VocabularyFilterFileUri: str = ...,
    DataAccessRoleArn: str = ...,
) -> UpdateVocabularyFilterResponseTypeDef:  # (1)
    ...

1. See UpdateVocabularyFilterResponseTypeDef

# update_vocabulary_filter method usage example with argument unpacking

kwargs: UpdateVocabularyFilterRequestTypeDef = {  # (1)
    "VocabularyFilterName": ...,
}

parent.update_vocabulary_filter(**kwargs)

1. See UpdateVocabularyFilterRequestTypeDef