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>
-EngineTranscribeMedicalSettings_LanguageCode <TranscribeMedicalLanguageCode>
-EngineTranscribeSettings_LanguageCode <TranscribeLanguageCode>
-EngineTranscribeSettings_LanguageModelName <String>
-EngineTranscribeSettings_PartialResultsStability <TranscribePartialResultsStability>
-EngineTranscribeSettings_PiiEntityType <String>
-EngineTranscribeMedicalSettings_Region <TranscribeMedicalRegion>
-EngineTranscribeSettings_Region <TranscribeRegion>
-EngineTranscribeMedicalSettings_Specialty <TranscribeMedicalSpecialty>
-EngineTranscribeMedicalSettings_Type <TranscribeMedicalType>
-EngineTranscribeSettings_VocabularyFilterMethod <TranscribeVocabularyFilterMethod>
-EngineTranscribeSettings_VocabularyFilterName <String>
-EngineTranscribeMedicalSettings_VocabularyName <String>
-EngineTranscribeSettings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonChimeConfig>

Description

Starts transcription for the specified meetingId.

Parameters

-ClientConfig <AmazonChimeConfig>
Amazon.PowerShell.Cmdlets.CHM.AmazonChimeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineTranscribeMedicalSettings_ContentIdentificationType <TranscribeMedicalContentIdentificationType>
Set this field to PHI to identify personal health information in the transcription output.
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>
Set this field to PII to identify personally identifiable information in the transcription output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_ContentIdentificationType
-EngineTranscribeSettings_ContentRedactionType <TranscribeContentRedactionType>
Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_ContentRedactionType
-EngineTranscribeSettings_EnablePartialResultsStabilization <Boolean>
Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_EnablePartialResultsStabilization
-EngineTranscribeSettings_LanguageCode <TranscribeLanguageCode>
The language code specified for the Amazon Transcribe engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_LanguageCode
-EngineTranscribeSettings_LanguageModelName <String>
The name of the language model used during transcription.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_LanguageModelName
-EngineTranscribeSettings_PartialResultsStability <TranscribePartialResultsStability>
The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_PartialResultsStability
-EngineTranscribeSettings_PiiEntityType <String>
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.PiiEntityTypes is an optional parameter with a default value of ALL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_PiiEntityTypes
-EngineTranscribeSettings_Region <TranscribeRegion>
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_Region
-EngineTranscribeSettings_VocabularyFilterMethod <TranscribeVocabularyFilterMethod>
The filtering method passed to Amazon Transcribe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterMethod
-EngineTranscribeSettings_VocabularyFilterName <String>
The name of the vocabulary filter passed to Amazon Transcribe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterName
-EngineTranscribeSettings_VocabularyName <String>
The name of the vocabulary passed to Amazon Transcribe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTranscriptionConfiguration_EngineTranscribeSettings_VocabularyName
-Force <SwitchParameter>
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)

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

None or Amazon.Chime.Model.StartMeetingTranscriptionResponse
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.
User Guide
Administrator Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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