AWS.Tools.TranscribeService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.TranscribeService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet"> <summary> Tags an Amazon Transcribe resource with the given list of tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have the format <code>arn:partition:service:region:account-id:resource-type/resource-id</code> (for example, <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>). Valid values for <code>resource-type</code> are: <code>transcription-job</code>, <code>medical-transcription-job</code>, <code>vocabulary</code>, <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and <code>language-model</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.Tag"> <summary> <para> <para>The tags you are assigning to a given Amazon Transcribe resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.Select"> <summary> 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.TranscribeService.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryCmdlet"> <summary> Retrieves information about a call analytics category. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>The name of the category you want information about. Category names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CategoryProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetCallAnalyticsCategoryResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetCallAnalyticsCategoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CategoryName parameter. The -PassThru parameter is deprecated, use -Select '^CategoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet"> <summary> Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet.NextToken"> <summary> <para> <para>When included, <code>NextToken</code>fetches the next set of categories if the result of the previous request was truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Categories'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListCallAnalyticsCategoriesResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListCallAnalyticsCategoriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobCmdlet"> <summary> Retrieves information about a call analytics job. <para> To view the job's status, refer to the <code>CallAnalyticsJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished. You can then find your transcript at the URI specified in the <code>TranscriptFileUri</code> field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the <code>RedactedTranscriptFileUri</code> field. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobCmdlet.CallAnalyticsJobName"> <summary> <para> <para>The name of the analytics job you want information about. This value is case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CallAnalyticsJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetCallAnalyticsJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetCallAnalyticsJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CallAnalyticsJobName parameter. The -PassThru parameter is deprecated, use -Select '^CallAnalyticsJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet"> <summary> List call analytics jobs with a specified status or substring that matches their names.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.JobNameContain"> <summary> <para> <para>When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.NextToken"> <summary> <para> <para>If you receive a truncated result in the previous request of , include <code>NextToken</code> to fetch the next set of jobs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.Status"> <summary> <para> <para>When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CallAnalyticsJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListCallAnalyticsJobsResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListCallAnalyticsJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobNameContain parameter. The -PassThru parameter is deprecated, use -Select '^JobNameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelCmdlet"> <summary> Provides information about a specific custom language model in your Amazon Web Services account. <para> This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. </para><para> If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>The name of the custom language model you want described. Model names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LanguageModel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.DescribeLanguageModelResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.DescribeLanguageModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelName parameter. The -PassThru parameter is deprecated, use -Select '^ModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet"> <summary> Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.NameContain"> <summary> <para> <para>When specified, the custom language model names returned contain the substring you've specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.StatusEqual"> <summary> <para> <para>When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.NextToken"> <summary> <para> <para>When included, fetches the next set of jobs if the result of the previous request was truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Models'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListLanguageModelsResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListLanguageModelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobCmdlet"> <summary> Retrieves information about a medical transcription job. <para> To view the job's status, refer to the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished. You can then find your transcript at the URI specified in the <code>TranscriptFileUri</code> field. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobCmdlet.MedicalTranscriptionJobName"> <summary> <para> <para>The name of the medical transcription job you want information about. This value is case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalTranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetMedicalTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetMedicalTranscriptionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalTranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalTranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet"> <summary> Lists medical transcription jobs with a specified status or substring that matches their names.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.JobNameContain"> <summary> <para> <para>When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.NextToken"> <summary> <para> <para>If you a receive a truncated result in the previous request of <code>ListMedicalTranscriptionJobs</code>, include <code>NextToken</code> to fetch the next set of jobs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.Status"> <summary> <para> <para>When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalTranscriptionJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobNameContain parameter. The -PassThru parameter is deprecated, use -Select '^JobNameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyCmdlet"> <summary> Retrieves information about a medical vocabulary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the medical vocabulary you want information about. This value is case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetMedicalVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetMedicalVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet"> <summary> Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.NameContain"> <summary> <para> <para>Returns vocabularies whose names contain the specified string. The search is not case sensitive. <code>ListMedicalVocabularies</code> returns both "<code>vocabularyname</code>" and "<code>VocabularyName</code>".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.StateEqual"> <summary> <para> <para>When specified, returns only vocabularies with the <code>VocabularyState</code> equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.NextToken"> <summary> <para> <para>If the result of your previous request to <code>ListMedicalVocabularies</code> was truncated, include the <code>NextToken</code> to fetch the next set of vocabularies.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vocabularies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListMedicalVocabulariesResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListMedicalVocabulariesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSResourceTagCmdlet"> <summary> Lists all tags associated with a given transcription job, vocabulary, or resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the format <code>arn:partition:service:region:account-id:resource-type/resource-id</code> (for example, <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>). Valid values for <code>resource-type</code> are: <code>transcription-job</code>, <code>medical-transcription-job</code>, <code>vocabulary</code>, <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and <code>language-model</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet"> <summary> Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet.TranscriptionJobName"> <summary> <para> <para>The name of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetTranscriptionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^TranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet"> <summary> Lists transcription jobs with the specified status.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.JobNameContain"> <summary> <para> <para>When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request to <code>ListTranscriptionJobs</code> is truncated, include the <code>NextToken</code> to fetch the next set of jobs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.Status"> <summary> <para> <para>When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TranscriptionJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListTranscriptionJobsResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListTranscriptionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet"> <summary> Gets information about a vocabulary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the vocabulary to return information about. The name is case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterCmdlet"> <summary> Returns information about a vocabulary filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the vocabulary filter for which to return information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetVocabularyFilterResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetVocabularyFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyFilterName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyFilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet"> <summary> Gets information about vocabulary filters.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.NameContain"> <summary> <para> <para>Filters the response so that it only contains vocabulary filters whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request to <code>ListVocabularyFilters</code> was truncated, include the <code>NextToken</code> to fetch the next set of collections.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VocabularyFilters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListVocabularyFiltersResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListVocabularyFiltersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet"> <summary> Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.NameContain"> <summary> <para> <para>When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, <code>ListVocabularies</code> returns both "vocabularyname" and "VocabularyName" in the response list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.StateEqual"> <summary> <para> <para>When specified, only returns vocabularies with the <code>VocabularyState</code> field equal to the specified state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request to <code>ListVocabularies</code> was truncated, include the <code>NextToken</code> to fetch the next set of jobs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vocabularies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListVocabulariesResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListVocabulariesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet"> <summary> Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>A unique name, chosen by you, for your call analytics category. For example, <code>sentiment-positive-last30seconds</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.Rule"> <summary> <para> <para>Rules make up a call analytics category. When creating a call analytics category, you must create between 1 and 20 rules for your category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CategoryProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.CreateCallAnalyticsCategoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CategoryName parameter. The -PassThru parameter is deprecated, use -Select '^CategoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet"> <summary> Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.BaseModelName"> <summary> <para> <para>The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.</para><para>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose <code>WideBand</code>. To transcribe audio with a sample rate less than 16,000 Hz, choose <code>NarrowBand</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.InputDataConfig_DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.LanguageCode"> <summary> <para> <para>The language of your custom language model; note that the language code you select must match the language of your training and tuning data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>The name of your new custom language model.</para><para>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a language model with the same name as a previous language model, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.InputDataConfig_S3Uri"> <summary> <para> <para>The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.Tag"> <summary> <para> <para>Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.InputDataConfig_TuningDataS3Uri"> <summary> <para> <para>The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateLanguageModelResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.CreateLanguageModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelName parameter. The -PassThru parameter is deprecated, use -Select '^ModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet"> <summary> Creates a new custom medical vocabulary. <para> When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the <code>Phrases</code> flag, as <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code> flag. </para><para> For more information on creating a custom vocabulary text file, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom vocabulary</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of the entries in your custom vocabulary. Note that U.S. English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.Tag"> <summary> <para> <para>Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create the new vocabulary.</para><para>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The Amazon S3 location (URI) of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling.</para><para>Here's an example URI path:</para><para><code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of your new vocabulary.</para><para>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateMedicalVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.CreateMedicalVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet"> <summary> Creates a new custom vocabulary. <para> When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the <code>Phrases</code> flag. </para><para> For more information on creating a custom vocabulary, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom vocabulary</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Phrase"> <summary> <para> <para>Use this flag to include a list of terms within your request.</para><para>Note that if you include <code>Phrases</code> in your request, you cannot use <code>VocabularyFileUri</code>; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Tag"> <summary> <para> <para>Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.</para><para>Here's an example URI path:</para><para><code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code></para><para>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot use the <code>Phrases</code> flag; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of your new vocabulary.</para><para>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.CreateVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet"> <summary> Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.LanguageCode"> <summary> <para> <para>The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Tag"> <summary> <para> <para>Adds one or more tags, each in the form of a key:value pair, to a new vocabulary filter at the time you create this new vocabulary filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.VocabularyFilterFileUri"> <summary> <para> <para>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a>.</para><para>Your vocabulary filter file must be less than 50 KB in size.</para><para>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you cannot use <code>Words</code>; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of your new vocabulary filter.</para><para>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary filter with the same name as a previous vocabulary filter, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Word"> <summary> <para> <para>The words you want in your vocabulary filter. Only use characters specified in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character sets</a> for the language you're transcribing.</para><para>Note that if you include <code>Words</code> in your request, you cannot use <code>VocabularyFilterFileUri</code>; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.CreateVocabularyFilterResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.CreateVocabularyFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyFilterName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyFilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsCategoryCmdlet"> <summary> Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using <code>CategoryName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>The name of the call analytics category you want to delete. Category names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsCategoryCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteCallAnalyticsCategoryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsCategoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CategoryName parameter. The -PassThru parameter is deprecated, use -Select '^CategoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsCategoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsJobCmdlet"> <summary> Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using <code>CallAnalyticsJobName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsJobCmdlet.CallAnalyticsJobName"> <summary> <para> <para>The name of the call analytics job you want to delete. Job names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsJobCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteCallAnalyticsJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CallAnalyticsJobName parameter. The -PassThru parameter is deprecated, use -Select '^CallAnalyticsJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSCallAnalyticsJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet"> <summary> Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using <code>ModelName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>The name of the model you want to delete. Model names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteLanguageModelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelName parameter. The -PassThru parameter is deprecated, use -Select '^ModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalTranscriptionJobCmdlet"> <summary> Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using <code>MedicalTranscriptionJobName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalTranscriptionJobCmdlet.MedicalTranscriptionJobName"> <summary> <para> <para>The name of the medical transcription job you want to delete. Job names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalTranscriptionJobCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteMedicalTranscriptionJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalTranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalTranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalTranscriptionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet"> <summary> Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using <code>VocabularyName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the vocabulary that you want to delete. Vocabulary names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteMedicalVocabularyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet"> <summary> Removes specified tags from a specified Amazon Transcribe resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format <code>arn:partition:service:region:account-id:resource-type/resource-id</code> (for example, <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>). Valid values for <code>resource-type</code> are: <code>transcription-job</code>, <code>medical-transcription-job</code>, <code>vocabulary</code>, <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and <code>language-model</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys you want to remove from a specified Amazon Transcribe resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.Select"> <summary> 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.TranscribeService.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet"> <summary> Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using <code>TranscriptionJobName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.TranscriptionJobName"> <summary> <para> <para>The name of the transcription job you want to delete. Job names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteTranscriptionJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^TranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet"> <summary> Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using <code>VocabularyName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the vocabulary you want to delete. Vocabulary names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteVocabularyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet"> <summary> Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using <code>VocabularyFilterName</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the vocabulary filter you want to delete. Vocabulary filter names are case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet.Select"> <summary> 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.TranscribeService.Model.DeleteVocabularyFilterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyFilterName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyFilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet"> <summary> Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.CallAnalyticsJobName"> <summary> <para> <para>The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ChannelDefinition"> <summary> <para> <para>When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageIdSetting"> <summary> <para> <para>The language identification settings associated with your call analytics job. These settings include <code>VocabularyName</code>, <code>VocabularyFilterName</code>, and <code>LanguageModelName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageModelName"> <summary> <para> <para>The structure used to describe a custom language model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageOption"> <summary> <para> <para>When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.</para><para>To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> for additional information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</para><para><code>s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey</code></para><para>For example:</para><para><code>s3://DOC-EXAMPLE-BUCKET/example.flac</code></para><para><code>s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac</code></para><para>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.</para><para>You use either of the following to identify an Amazon Web Services KMS key in the current account:</para><ul><li><para>KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"</para></li><li><para>KMS Key Alias: "alias/ExampleAlias"</para></li></ul><para> You can use either of the following to identify a KMS key in the current account or another account:</para><ul><li><para>Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"</para></li><li><para>ARN of a KMS Key Alias: "arn:aws:kms:region:accountID:alias/ExampleAlias"</para></li></ul><para>If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).</para><para>If you specify a KMS key to encrypt your output, you must also specify an output location in the <code>OutputLocation</code> parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.OutputLocation"> <summary> <para> <para>The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:</para><ul><li><para>s3://DOC-EXAMPLE-BUCKET1</para><para> If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.</para></li><li><para>s3://DOC-EXAMPLE-BUCKET1/folder/</para><para>f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.</para><para>If you specify a folder, you must provide a trailing slash.</para></li><li><para>s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.</para><para> If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.</para></li></ul><para>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_PiiEntityType"> <summary> <para> <para>The types of personally identifiable information (PII) you want to redact in your transcript.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The S3 object location for your redacted output media file. This is only supported for call analytics jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_RedactionOutput"> <summary> <para> <para>The output transcript file stored in either the default S3 bucket or in a bucket you specify.</para><para>When you choose <code>redacted</code> Amazon Transcribe outputs only the redacted transcript.</para><para>When you choose <code>redacted_and_unredacted</code> Amazon Transcribe outputs both the redacted and unredacted transcripts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_RedactionType"> <summary> <para> <para>Request parameter that defines the entities to be redacted. The only accepted value is <code>PII</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyFilterMethod"> <summary> <para> <para>Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to <code>remove</code> to remove filtered text from the transcript without using placeholder text. Set to <code>tag</code> to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to <code>tag</code>, the words matching your vocabulary filter are not masked or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyFilterName"> <summary> <para> <para>The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of a vocabulary to use when processing the call analytics job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CallAnalyticsJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CallAnalyticsJobName parameter. The -PassThru parameter is deprecated, use -Select '^CallAnalyticsJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet"> <summary> Starts a batch job to transcribe medical speech to text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ChannelIdentification"> <summary> <para> <para>Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.</para><para>Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.ContentIdentificationType"> <summary> <para> <para>You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify <code>PHI</code>, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.KMSEncryptionContext"> <summary> <para> <para>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.LanguageCode"> <summary> <para> <para>The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a <code>BadRequestException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_MaxAlternative"> <summary> <para> <para>The maximum number of alternatives that you tell the service to return. If you specify the <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_MaxSpeakerLabel"> <summary> <para> <para>The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</para><para><code>s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey</code></para><para>For example:</para><para><code>s3://DOC-EXAMPLE-BUCKET/example.flac</code></para><para><code>s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac</code></para><para>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.MediaFormat"> <summary> <para> <para>The audio format of the input media file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.MediaSampleRateHertz"> <summary> <para> <para>The sample rate, in Hertz, of the audio track in the input media file.</para><para>If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe Medical determine the sample rate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.MedicalTranscriptionJobName"> <summary> <para> <para>The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputBucketName"> <summary> <para> <para>The Amazon S3 location where the transcription is stored.</para><para>You must set <code>OutputBucketName</code> for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the <a>GetMedicalTranscriptionJob</a>, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</para><para>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the <a>StartMedicalTranscriptionJob</a> operation must have permission to use the specified KMS key.</para><para>You use either of the following to identify a KMS key in the current account:</para><ul><li><para>KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"</para></li><li><para>KMS Key Alias: "alias/ExampleAlias"</para></li></ul><para>You can use either of the following to identify a KMS key in the current account or another account:</para><ul><li><para>Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</para></li><li><para>ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</para></li></ul><para>If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).</para><para>If you specify a KMS key to encrypt your output, you must also specify an output location in the <code>OutputBucketName</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputKey"> <summary> <para> <para>You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.</para><para>If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".</para><para>You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".</para><para>If you specify an output key, you must also specify an S3 bucket in the <code>OutputBucketName</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The S3 object location for your redacted output media file. This is only supported for call analytics jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ShowAlternative"> <summary> <para> <para>Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set <code>ShowAlternatives</code> field to true, you must also set the maximum number of alternatives to return in the <code>MaxAlternatives</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ShowSpeakerLabel"> <summary> <para> <para>Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels in the <code>MaxSpeakerLabels</code> field.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Specialty"> <summary> <para> <para>The medical specialty of any clinician speaking in the input media.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Tag"> <summary> <para> <para>Add tags to an Amazon Transcribe Medical transcription job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Type"> <summary> <para> <para>The type of speech in the input audio. <code>CONVERSATION</code> refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. <code>DICTATION</code> refers to single-speaker dictated speech, such as clinical notes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of the vocabulary to use when processing a medical transcription job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalTranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartMedicalTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartMedicalTranscriptionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalTranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalTranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet"> <summary> Starts an asynchronous job to transcribe speech to text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.JobExecutionSettings_AllowDeferredExecution"> <summary> <para> <para>Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the <code>AllowDeferredExecution</code> field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a <code>LimitExceededException</code> exception.</para><para>Note that job queuing is enabled by default for call analytics jobs.</para><para>If you specify the <code>AllowDeferredExecution</code> field, you must specify the <code>DataAccessRoleArn</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ChannelIdentification"> <summary> <para> <para>Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.</para><para>Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.JobExecutionSettings_DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN), in the form <code>arn:partition:service:region:account-id:resource-type/resource-id</code>, of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.</para><para>If you specify the <code>AllowDeferredExecution</code> field, you must specify the <code>DataAccessRoleArn</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Subtitles_Format"> <summary> <para> <para>Specify the output format for your subtitle file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.IdentifyLanguage"> <summary> <para> <para>Set this field to <code>true</code> to enable automatic language identification. Automatic language identification is disabled by default. You receive a <code>BadRequestException</code> error if you enter a value for a <code>LanguageCode</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.KMSEncryptionContext"> <summary> <para> <para>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageCode"> <summary> <para> <para>The language code for the language used in the input media file.</para><para>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageIdSetting"> <summary> <para> <para>The language identification settings associated with your transcription job. These settings include <code>VocabularyName</code>, <code>VocabularyFilterName</code>, and <code>LanguageModelName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ModelSettings_LanguageModelName"> <summary> <para> <para>The name of your custom language model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageOption"> <summary> <para> <para>An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.</para><para>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_MaxAlternative"> <summary> <para> <para>The number of alternative transcriptions that the service should return. If you specify the <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_MaxSpeakerLabel"> <summary> <para> <para>The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</para><para><code>s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey</code></para><para>For example:</para><para><code>s3://DOC-EXAMPLE-BUCKET/example.flac</code></para><para><code>s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac</code></para><para>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.MediaFormat"> <summary> <para> <para>The format of the input media file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.MediaSampleRateHertz"> <summary> <para> <para>The sample rate, in Hertz, of the audio track in the input media file. </para><para>If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe determine the sample rate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputBucketName"> <summary> <para> <para>The location where the transcription is stored.</para><para>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the <code>TranscriptFileUri</code>. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</para><para>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</para><para>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the <code>StartTranscriptionJob</code> operation must have permission to use the specified KMS key.</para><para>You can use either of the following to identify a KMS key in the current account:</para><ul><li><para>KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"</para></li><li><para>KMS Key Alias: "alias/ExampleAlias"</para></li></ul><para>You can use either of the following to identify a KMS key in the current account or another account:</para><ul><li><para>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</para></li><li><para>ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"</para></li></ul><para>If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).</para><para>If you specify a KMS key to encrypt your output, you must also specify an output location in the <code>OutputBucketName</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputKey"> <summary> <para> <para>You can specify a location in an Amazon S3 bucket to store the output of your transcription job.</para><para>If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".</para><para>You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".</para><para>If you specify an output key, you must also specify an S3 bucket in the <code>OutputBucketName</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_PiiEntityType"> <summary> <para> <para>The types of personally identifiable information (PII) you want to redact in your transcript.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The S3 object location for your redacted output media file. This is only supported for call analytics jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_RedactionOutput"> <summary> <para> <para>The output transcript file stored in either the default S3 bucket or in a bucket you specify.</para><para>When you choose <code>redacted</code> Amazon Transcribe outputs only the redacted transcript.</para><para>When you choose <code>redacted_and_unredacted</code> Amazon Transcribe outputs both the redacted and unredacted transcripts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_RedactionType"> <summary> <para> <para>Request parameter that defines the entities to be redacted. The only accepted value is <code>PII</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ShowAlternative"> <summary> <para> <para>Determines whether the transcription contains alternative transcriptions. If you set the <code>ShowAlternatives</code> field to true, you must also set the maximum number of alternatives to return in the <code>MaxAlternatives</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ShowSpeakerLabel"> <summary> <para> <para>Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Tag"> <summary> <para> <para>Add tags to an Amazon Transcribe transcription job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.TranscriptionJobName"> <summary> <para> <para>The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyFilterMethod"> <summary> <para> <para>Set to <code>mask</code> to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to <code>remove</code> to remove filtered text from the transcript without using placeholder text. Set to <code>tag</code> to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to <code>tag</code>, the words matching your vocabulary filter are not masked or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyFilterName"> <summary> <para> <para>The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of a vocabulary to use when processing the transcription job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartTranscriptionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^TranscriptionJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet"> <summary> Updates the call analytics category with new values. The <code>UpdateCallAnalyticsCategory</code> operation overwrites all of the existing information with the values that you provide in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.Rule"> <summary> <para> <para>The rules used for the updated analytics category. The rules that you provide in this field replace the ones that are currently being used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CategoryProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.UpdateCallAnalyticsCategoryResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.UpdateCallAnalyticsCategoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CategoryName parameter. The -PassThru parameter is deprecated, use -Select '^CategoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet"> <summary> Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The <code>UpdateMedicalVocabulary</code> operation overwrites all of the existing information with the values that you provide in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code of the language used for the entries in the updated vocabulary. U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:</para><para><code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code></para><para>For example:</para><para><code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code></para><para>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>For more information about custom vocabularies in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html">Medical Custom Vocabularies</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.UpdateMedicalVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.UpdateMedicalVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet"> <summary> Updates an existing vocabulary with new values. The <code>UpdateVocabulary</code> operation overwrites all of the existing information with the values that you provide in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.Phrase"> <summary> <para> <para>An array of strings containing the vocabulary entries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:</para><para><code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code></para><para>For example:</para><para><code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code></para><para>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom Vocabularies</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.UpdateVocabularyResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.UpdateVocabularyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet"> <summary> Updates a vocabulary filter with a new list of filtered words. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.VocabularyFilterFileUri"> <summary> <para> <para>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a>.</para><para>The specified file must be less than 50 KB of UTF-8 characters.</para><para>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code> parameter, you can't use the <code>Words</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as another vocabulary filter, you get a <code>ConflictException</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.Word"> <summary> <para> <para>The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a>.</para><para>If you provide a list of words in the <code>Words</code> parameter, you can't use the <code>VocabularyFilterFileUri</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.UpdateVocabularyFilterResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.UpdateVocabularyFilterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VocabularyFilterName parameter. The -PassThru parameter is deprecated, use -Select '^VocabularyFilterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |