AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Chime StartMeetingTranscription API operation.

Syntax

Start-CHMMeetingTranscription
-MeetingId <String>
-EngineTranscribeMedicalSettings_ContentIdentificationType <TranscribeMedicalContentIdentificationType>
-EngineTranscribeSettings_ContentIdentificationType <TranscribeContentIdentificationType>
-EngineTranscribeSettings_ContentRedactionType <TranscribeContentRedactionType>
-EngineTranscribeSettings_EnablePartialResultsStabilization <Boolean>
-EngineTranscribeSettings_IdentifyLanguage <Boolean>
-EngineTranscribeMedicalSettings_LanguageCode <TranscribeMedicalLanguageCode>
-EngineTranscribeSettings_LanguageCode <TranscribeLanguageCode>
-EngineTranscribeSettings_LanguageModelName <String>
-EngineTranscribeSettings_LanguageOption <String>
-EngineTranscribeSettings_PartialResultsStability <TranscribePartialResultsStability>
-EngineTranscribeSettings_PiiEntityType <String>
-EngineTranscribeSettings_PreferredLanguage <TranscribeLanguageCode>
-EngineTranscribeMedicalSettings_Region <TranscribeMedicalRegion>
-EngineTranscribeSettings_Region <TranscribeRegion>
-EngineTranscribeMedicalSettings_Specialty <TranscribeMedicalSpecialty>
-EngineTranscribeMedicalSettings_Type <TranscribeMedicalType>
-EngineTranscribeSettings_VocabularyFilterMethod <TranscribeVocabularyFilterMethod>
-EngineTranscribeSettings_VocabularyFilterName <String>
-TranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterNames <String>
-EngineTranscribeMedicalSettings_VocabularyName <String>
-EngineTranscribeSettings_VocabularyName <String>
-TranscriptionConfiguration_EngineTranscribeSettings_VocabularyNames <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonChimeConfig>

Description

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide. Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services. This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

This operation is deprecated.

Parameters

-ClientConfig <AmazonChimeConfig>
Amazon.PowerShell.Cmdlets.CHM.AmazonChimeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineTranscribeMedicalSettings_ContentIdentificationType <TranscribeMedicalContentIdentificationType>
Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.You can’t set ContentIdentificationType and ContentRedactionType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_ContentIdentificationType
-EngineTranscribeMedicalSettings_LanguageCode <TranscribeMedicalLanguageCode>
The language code specified for the Amazon Transcribe Medical engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_LanguageCode
-EngineTranscribeMedicalSettings_Region <TranscribeMedicalRegion>
The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_Region
-EngineTranscribeMedicalSettings_Specialty <TranscribeMedicalSpecialty>
The specialty specified for the Amazon Transcribe Medical engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_Specialty
-EngineTranscribeMedicalSettings_Type <TranscribeMedicalType>
The type of transcription.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_Type
-EngineTranscribeMedicalSettings_VocabularyName <String>
The name of the vocabulary passed to Amazon Transcribe Medical.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeMedicalSettings_VocabularyName
-EngineTranscribeSettings_ContentIdentificationType <TranscribeContentIdentificationType>
Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.You can’t set ContentIdentificationType and ContentRedactionType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_ContentIdentificationType
-EngineTranscribeSettings_ContentRedactionType <TranscribeContentRedactionType>
Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.You can’t set ContentIdentificationType and ContentRedactionType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_ContentRedactionType
-EngineTranscribeSettings_EnablePartialResultsStabilization <Boolean>
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_EnablePartialResultsStabilization
-EngineTranscribeSettings_IdentifyLanguage <Boolean>
Enables automatic language identification for your transcription.If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.You must include either LanguageCode or IdentifyLanguage.Language identification can't be combined with custom language models or redaction.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_IdentifyLanguage
-EngineTranscribeSettings_LanguageCode <TranscribeLanguageCode>
Specify the language code that represents the language spoken.If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_LanguageCode
-EngineTranscribeSettings_LanguageModelName <String>
Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_LanguageModelName
-EngineTranscribeSettings_LanguageOption <String>
Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.Including language options can improve the accuracy of language identification.If you include LanguageOptions, you must also include IdentifyLanguage.You can only include one language dialect per language. For example, you cannot include en-US and en-AU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_LanguageOptions
-EngineTranscribeSettings_PartialResultsStability <TranscribePartialResultsStability>
Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_PartialResultsStability
-EngineTranscribeSettings_PiiEntityType <String>
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRYCREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_PiiEntityTypes
-EngineTranscribeSettings_PreferredLanguage <TranscribeLanguageCode>
Specify a preferred language from the subset of languages codes you specified in LanguageOptions.You can only use this parameter if you include IdentifyLanguage and LanguageOptions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_PreferredLanguage
-EngineTranscribeSettings_Region <TranscribeRegion>
The AWS Region in which to use Amazon Transcribe.If you don't specify a Region, then the MediaRegion parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_Region
-EngineTranscribeSettings_VocabularyFilterMethod <TranscribeVocabularyFilterMethod>
Specify how you want your vocabulary filter applied to your transcript. To replace words with ***, choose mask.To delete words, choose remove.To flag words without changing them, choose tag.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterMethod
-EngineTranscribeSettings_VocabularyFilterName <String>
Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterName
-EngineTranscribeSettings_VocabularyName <String>
Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyName
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MeetingId <String>
The unique ID of the meeting being transcribed.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Chime.Model.StartMeetingTranscriptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterNames <String>
Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region. If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEngineTranscribeSettings_VocabularyFilterNames
-TranscriptionConfiguration_EngineTranscribeSettings_VocabularyNames <String>
Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEngineTranscribeSettings_VocabularyNames

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet does not generate any output.The service response (type Amazon.Chime.Model.StartMeetingTranscriptionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z