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> Adds one or more custom tags, each in the form of a key:value pair, to the specified resource. <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format <c>arn:partition:service:region:account-id:resource-type/resource-id</c>.</para><para>For example, <c>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</c>.</para><para>Valid values for <c>resource-type</c> are: <c>transcription-job</c>, <c>medical-transcription-job</c>, <c>vocabulary</c>, <c>medical-vocabulary</c>, <c>vocabulary-filter</c>, and <c>language-model</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.AddTRSResourceTagCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.</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.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> Provides information about the specified Call Analytics category. <para> To get a list of your Call Analytics categories, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>The name of the Call Analytics 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 a list of Call Analytics categories, including all rules that make up each category. <para> To get detailed information about a specific Call Analytics category, use the operation. </para><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 Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsCategoryListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListCallAnalyticsCategories</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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> Provides information about the specified Call Analytics job. <para> To view the job's status, refer to <c>CallAnalyticsJobStatus</c>. If the status is <c>COMPLETED</c>, the job is finished. You can find your completed transcript at the URI specified in <c>TranscriptFileUri</c>. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your transcription job failed. </para><para> If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in <c>RedactedTranscriptFileUri</c>. </para><para> If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in <c>RedactedMediaFileUri</c>. </para><para> To get a list of your Call Analytics jobs, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobCmdlet.CallAnalyticsJobName"> <summary> <para> <para>The name of the Call Analytics job you want information about. Job names are 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> Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned. <para> To get detailed information about a specific Call Analytics job, use the operation. </para><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>Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.</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 that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSCallAnalyticsJobListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListCallAnalyticsJobs</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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>Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include <c>Status</c>, all Call Analytics jobs are returned.</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 the specified custom language model. <para> This operation also shows if the base language model that 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 <c>DescribeLanguageModel</c> to help identify the reason for this failure. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>The name of the custom language model you want information about. 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 a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned. <para> To get detailed information about a specific custom language model, use the operation. </para><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>Returns only the custom language models that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.StatusEqual"> <summary> <para> <para>Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include <c>StatusEquals</c>, all custom language models are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSLanguageModelListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListLanguageModels</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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.GetTRSMedicalScribeJobCmdlet"> <summary> Provides information about the specified Medical Scribe job. <para> To view the status of the specified medical transcription job, check the <c>MedicalScribeJobStatus</c> field. If the status is <c>COMPLETED</c>, the job is finished. You can find the results at the location specified in <c>MedicalScribeOutput</c>. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your Medical Scribe job failed. </para><para> To get a list of your Medical Scribe jobs, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobCmdlet.MedicalScribeJobName"> <summary> <para> <para>The name of the Medical Scribe job you want information about. Job names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalScribeJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.GetMedicalScribeJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.GetMedicalScribeJobResponse 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.GetTRSMedicalScribeJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalScribeJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalScribeJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobListCmdlet"> <summary> Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. <para> To get detailed information about a specific Medical Scribe job, use the operation. </para><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.GetTRSMedicalScribeJobListCmdlet.JobNameContain"> <summary> <para> <para>Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListMedicalScribeJobs</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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.GetTRSMedicalScribeJobListCmdlet.Status"> <summary> <para> <para>Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include <c>Status</c>, all Medical Scribe jobs are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalScribeJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalScribeJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListMedicalScribeJobsResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.ListMedicalScribeJobsResponse 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.GetTRSMedicalScribeJobListCmdlet.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.GetTRSMedicalScribeJobListCmdlet.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> Provides information about the specified medical transcription job. <para> To view the status of the specified medical transcription job, check the <c>TranscriptionJobStatus</c> field. If the status is <c>COMPLETED</c>, the job is finished. You can find the results at the location specified in <c>TranscriptFileUri</c>. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your transcription job failed. </para><para> To get a list of your medical transcription jobs, use the operation. </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. Job names are 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> Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned. <para> To get detailed information about a specific medical transcription job, use the operation. </para><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>Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.</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 that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalTranscriptionJobListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListMedicalTranscriptionJobs</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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>Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include <c>Status</c>, all medical transcription jobs are returned.</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> Provides information about the specified custom medical vocabulary. <para> To view the status of the specified custom medical vocabulary, check the <c>VocabularyState</c> field. If the status is <c>READY</c>, your custom vocabulary is available to use. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your vocabulary failed. </para><para> To get a list of your custom medical vocabularies, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are 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> Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned. <para> To get detailed information about a specific custom medical vocabulary, use the operation. </para><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 only the custom medical vocabularies that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.StateEqual"> <summary> <para> <para>Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include <c>StateEquals</c>, all custom medical vocabularies are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSMedicalVocabularyListCmdlet.NextToken"> <summary> <para> <para>If your <c>ListMedicalVocabularies</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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 the specified transcription job, vocabulary, model, or resource. <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format <c>arn:partition:service:region:account-id:resource-type/resource-id</c>.</para><para>For example, <c>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</c>.</para><para>Valid values for <c>resource-type</c> are: <c>transcription-job</c>, <c>medical-transcription-job</c>, <c>vocabulary</c>, <c>medical-vocabulary</c>, <c>vocabulary-filter</c>, and <c>language-model</c>.</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> Provides information about the specified transcription job. <para> To view the status of the specified transcription job, check the <c>TranscriptionJobStatus</c> field. If the status is <c>COMPLETED</c>, the job is finished. You can find the results at the location specified in <c>TranscriptFileUri</c>. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your transcription job failed. </para><para> If you enabled content redaction, the redacted transcript can be found at the location specified in <c>RedactedTranscriptFileUri</c>. </para><para> To get a list of your transcription jobs, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet.TranscriptionJobName"> <summary> <para> <para>The name of the transcription job you want information about. Job names are case sensitive.</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> Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned. <para> To get detailed information about a specific transcription job, use the operation. </para><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>Returns only the transcription jobs that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a 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 your <c>ListTranscriptionJobs</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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>Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include <c>Status</c>, all transcription jobs are returned.</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> Provides information about the specified custom vocabulary. <para> To view the status of the specified custom vocabulary, check the <c>VocabularyState</c> field. If the status is <c>READY</c>, your custom vocabulary is available to use. If the status is <c>FAILED</c>, <c>FailureReason</c> provides details on why your custom vocabulary failed. </para><para> To get a list of your custom vocabularies, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want information about. Custom vocabulary names are 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> Provides information about the specified custom vocabulary filter. <para> To get a list of your custom vocabulary filters, use the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive.</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> Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. <para> To get detailed information about a specific custom vocabulary filter, use the operation. </para><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>Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyFilterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a 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 your <c>ListVocabularyFilters</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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> Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. <para> To get detailed information about a specific custom vocabulary, use the operation. </para><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>Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.StateEqual"> <summary> <para> <para>Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include <c>StateEquals</c>, all custom medical vocabularies are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a 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 your <c>ListVocabularies</c> request returns more results than can be displayed, <c>NextToken</c> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <c>NextToken</c> with the value of the copied string. Repeat as needed to view all your results.</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 new Call Analytics category. <para> All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. </para><para> When creating a new category, you can use the <c>InputType</c> parameter to label the category as a <c>POST_CALL</c> or a <c>REAL_TIME</c> category. <c>POST_CALL</c> categories can only be applied to post-call transcriptions and <c>REAL_TIME</c> categories can only be applied to real-time transcriptions. If you do not include <c>InputType</c>, your category is created as a <c>POST_CALL</c> category by default. </para><para> Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and . </para><para> To update an existing category, see . </para><para> To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for post-call transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for real-time transcriptions</a>. </para> </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. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use <c>sentiment-positive-last30seconds</c> for a category over a generic name like <c>test-category</c>.</para><para>Category names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.InputType"> <summary> <para> <para>Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.</para><para>Specifying <c>POST_CALL</c> assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.</para><para>Specifying <c>REAL_TIME</c> assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.</para><para>If you do not include <c>InputType</c>, your category is created as a post-call category by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSCallAnalyticsCategoryCmdlet.Rule"> <summary> <para> <para>Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that 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. <para> When creating a new custom language model, you must specify: </para><ul><li><para> If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model </para></li><li><para> The location of your training and tuning files (this must be an Amazon S3 URI) </para></li><li><para> The language of your model </para></li><li><para> A unique name for your model </para></li></ul> </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 <c>WideBand</c>. To transcribe audio with a sample rate less than 16,000 Hz, choose <c>NarrowBand</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.InputDataConfig_DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.</para><para>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that US English (<c>en-US</c>) is the only language supported with Amazon Transcribe Medical.</para><para>A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (<c>en-US</c>), you can only apply this model to files that contain English audio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>A unique name, chosen by you, for your 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 new custom language model with the same name as an existing custom language model, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.InputDataConfig_S3Uri"> <summary> <para> <para>The Amazon S3 location (URI) of the text files you want to use to train your custom language model.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-model-training-data/</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSLanguageModelCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.</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.NewTRSLanguageModelCmdlet.InputDataConfig_TuningDataS3Uri"> <summary> <para> <para>The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/</c></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> Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the <c>Phrases</c> flag; <c>CreateMedicalVocabulary</c> does not support the <c>Phrases</c> flag and only accepts vocabularies in table format. </para><para> Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language. </para><para> For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</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. US English (<c>en-US</c>) 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 custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom 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 medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>A unique name, chosen by you, for your new custom medical 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 new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a <c>ConflictException</c> 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 custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the <c>Phrases</c> flag. </para><para> Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language. </para><para> For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </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 custom vocabulary must contain terms in only one language.</para><para>A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (<c>en-US</c>), you can only apply this custom vocabulary to files that contain English audio.</para><para>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Phrase"> <summary> <para> <para>Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the <c>VocabularyFileUri</c> parameter.</para><para>Note that if you include <c>Phrases</c> in your request, you cannot use <c>VocabularyFileUri</c>; you must choose one or the other.</para><para>Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom 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.NewTRSVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</c></para><para>Note that if you include <c>VocabularyFileUri</c> in your request, you cannot use the <c>Phrases</c> flag; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>A unique name, chosen by you, for your new custom 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 new custom vocabulary with the same name as an existing custom vocabulary, you get a <c>ConflictException</c> 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 custom vocabulary filter. <para> You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts. </para><para> Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language. </para><para> For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary filtering</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.</para><para>A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English (<c>en-US</c>), you can only apply this filter to files that contain English audio.</para><para>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.</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.NewTRSVocabularyFilterCmdlet.VocabularyFilterFileUri"> <summary> <para> <para>The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</c></para><para>Note that if you include <c>VocabularyFilterFileUri</c> in your request, you cannot use <c>Words</c>; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>A unique name, chosen by you, for your new custom 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 new custom vocabulary filter with the same name as an existing custom vocabulary filter, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyFilterCmdlet.Word"> <summary> <para> <para>Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the <c>VocabularyFilterFileUri</c> parameter.</para><para>Note that if you include <c>Words</c> in your request, you cannot use <c>VocabularyFilterFileUri</c>; you must choose one or the other.</para><para>Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language.</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 <c>CategoryName</c>. Category names are case sensitive. </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 <c>CallAnalyticsJobName</c>. Job names are case sensitive. </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 <c>ModelName</c>. custom language model names are case sensitive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSLanguageModelCmdlet.ModelName"> <summary> <para> <para>The name of the custom language 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.RemoveTRSMedicalScribeJobCmdlet"> <summary> Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using <c>MedicalScribeJobName</c>. Job names are case sensitive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalScribeJobCmdlet.MedicalScribeJobName"> <summary> <para> <para>The name of the Medical Scribe job you want to delete. Job names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalScribeJobCmdlet.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.DeleteMedicalScribeJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalScribeJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalScribeJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalScribeJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalScribeJobCmdlet.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. To use this operation, specify the name of the job you want to delete using <c>MedicalTranscriptionJobName</c>. Job names are case sensitive. </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 custom vocabulary you want to delete using <c>VocabularyName</c>. Custom vocabulary names are case sensitive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom medical vocabulary you want to delete. Custom medical 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 the specified tags from the specified Amazon Transcribe resource. <para> If you include <c>UntagResource</c> in your request, you must also include <c>ResourceArn</c> and <c>TagKeys</c>. </para> </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 <c>arn:partition:service:region:account-id:resource-type/resource-id</c>.</para><para>For example, <c>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</c>.</para><para>Valid values for <c>resource-type</c> are: <c>transcription-job</c>, <c>medical-transcription-job</c>, <c>vocabulary</c>, <c>medical-vocabulary</c>, <c>vocabulary-filter</c>, and <c>language-model</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSResourceTagCmdlet.TagKey"> <summary> <para> <para>Removes the specified tag keys from the 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. To use this operation, specify the name of the job you want to delete using <c>TranscriptionJobName</c>. Job names are case sensitive. </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 custom vocabulary you want to delete using <c>VocabularyName</c>. Custom vocabulary names are case sensitive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to delete. Custom 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 custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using <c>VocabularyFilterName</c>. Custom vocabulary filter names are case sensitive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want to delete. Custom 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> Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request. <para> In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call Analytics</a>. </para><para> If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for post-call transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for real-time transcriptions</a>. </para><para> To make a <c>StartCallAnalyticsJob</c> request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the <c>Media</c> parameter. </para><para> Note that job queuing is enabled by default for Call Analytics jobs. </para><para> You must include the following parameters in your <c>StartCallAnalyticsJob</c> request: </para><ul><li><para><c>region</c>: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and quotas</a>. </para></li><li><para><c>CallAnalyticsJobName</c>: A custom name that you create for your transcription job that's unique within your Amazon Web Services account. </para></li><li><para><c>DataAccessRoleArn</c>: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. </para></li><li><para><c>Media</c> (<c>MediaFileUri</c> or <c>RedactedMediaFileUri</c>): The Amazon S3 location of your media file. </para></li></ul><note><para> With Call Analytics, you can redact the audio contained in your media file by including <c>RedactedMediaFileUri</c>, instead of <c>MediaFileUri</c>, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the <c>RedactedMediaFileUri</c> field of your response. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.CallAnalyticsJobName"> <summary> <para> <para>A unique name, chosen by you, for your Call Analytics job.</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 new job with the same name as an existing job, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ChannelDefinition"> <summary> <para> <para>Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set <c>ChannelId</c> to <c>0</c> (to indicate the first channel) and <c>ParticipantRole</c> to <c>AGENT</c> (to indicate that it's the agent speaking).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Summarization_GenerateAbstractiveSummary"> <summary> <para> <para>Enables Generative call summarization in your Call Analytics request</para><para>Generative call summarization provides a summary of the transcript including important components discussed in the conversation.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html">Enabling generative call summarization</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageIdSetting"> <summary> <para> <para>If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include <c>LanguageIdSettings</c> with the relevant sub-parameters (<c>VocabularyName</c>, <c>LanguageModelName</c>, and <c>VocabularyFilterName</c>).</para><para><c>LanguageIdSettings</c> supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.</para><para>It's recommended that you include <c>LanguageOptions</c> when using <c>LanguageIdSettings</c> to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in <c>en-US</c> but Amazon Transcribe determines that the language spoken in your media is <c>en-AU</c>, your custom vocabulary <i>is not</i> applied to your transcription. If you include <c>LanguageOptions</c> and include <c>en-US</c> as the only English language dialect, your custom vocabulary <i>is</i> applied to your transcription.</para><para>If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but <b>do not</b> want to use automatic language identification, use instead the <code /> parameter with the <c>LanguageModelName</c>, <c>VocabularyName</c>, or <c>VocabularyFilterName</c> sub-parameters.</para><para>For a list of languages supported with Call Analytics, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages and language-specific features</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageModelName"> <summary> <para> <para>The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.</para><para>The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_LanguageOption"> <summary> <para> <para>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</para><para>Including language options can improve the accuracy of language identification.</para><para>For a list of languages supported with Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</para><para>To transcribe speech in Modern Standard Arabic (<c>ar-SA</c>), your media 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.StartTRSCallAnalyticsJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to transcribe. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The KMS key you want to use to encrypt your Call Analytics output.</para><para>If using a key located in the <b>current</b> Amazon Web Services account, you can specify your KMS key in one of four ways:</para><ol><li><para>Use the KMS key ID itself. For example, <c>1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use an alias for the KMS key ID. For example, <c>alias/ExampleAlias</c>.</para></li><li><para>Use the Amazon Resource Name (ARN) for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If using a key located in a <b>different</b> Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:</para><ol><li><para>Use the ARN for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If you do not specify an encryption key, your output 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 using the <c>OutputLocation</c> parameter.</para><para>Note that the role making the request must have permission to use the specified KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.OutputLocation"> <summary> <para> <para>The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:</para><ol><li><para>s3://DOC-EXAMPLE-BUCKET</para></li><li><para>s3://DOC-EXAMPLE-BUCKET/my-output-folder/</para></li><li><para>s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json</para></li></ol><para>Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the <c>CallAnalyticsJobName</c> parameter.</para><para>You can specify a KMS key to encrypt your output using the <c>OutputEncryptionKMSKeyId</c> parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.</para><para>If you do not specify <c>OutputLocation</c>, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_PiiEntityType"> <summary> <para> <para>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <c>ALL</c>. If you do not include <c>PiiEntityTypes</c> in your request, all PII is redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to redact. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para><important><para><c>RedactedMediaFileUri</c> produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (<c>StartCallAnalyticsJob</c>) transcription requests.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_RedactionOutput"> <summary> <para> <para>Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.</para><para>When you choose <c>redacted</c> Amazon Transcribe creates only a redacted transcript.</para><para>When you choose <c>redacted_and_unredacted</c> Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.ContentRedaction_RedactionType"> <summary> <para> <para>Specify the category of information you want to redact; <c>PII</c> (personally identifiable information) is the only valid value. You can use <c>PiiEntityTypes</c> to choose which types of PII you want to redact. If you do not include <c>PiiEntityTypes</c> in your request, all PII is redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyFilterMethod"> <summary> <para> <para>Specify how you want your custom vocabulary filter applied to your transcript.</para><para>To replace words with <c>***</c>, choose <c>mask</c>.</para><para>To delete words, choose <c>remove</c>.</para><para>To flag words without changing them, choose <c>tag</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.</para><para>Note that if you include <c>VocabularyFilterName</c> in your request, you must also include <c>VocabularyFilterMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSCallAnalyticsJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.</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.StartTRSMedicalScribeJobCmdlet"> <summary> Transcribes patient-clinician conversations and generates clinical notes. <para> Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html">Amazon Web Services HealthScribe</a>. </para><para> To make a <c>StartMedicalScribeJob</c> request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the <c>Media</c> parameter. </para><para> You must include the following parameters in your <c>StartMedicalTranscriptionJob</c> request: </para><ul><li><para><c>DataAccessRoleArn</c>: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in <c>Media</c>, write permission on the Amazon S3 bucket specified in <c>OutputBucketName</c>, and full permissions on the KMS key specified in <c>OutputEncryptionKMSKeyId</c> (if set). The role should also allow <c>transcribe.amazonaws.com</c> to assume it. </para></li><li><para><c>Media</c> (<c>MediaFileUri</c>): The Amazon S3 location of your media file. </para></li><li><para><c>MedicalScribeJobName</c>: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account. </para></li><li><para><c>OutputBucketName</c>: The Amazon S3 bucket where you want your output files stored. </para></li><li><para><c>Settings</c>: A <c>MedicalScribeSettings</c> obect that must set exactly one of <c>ShowSpeakerLabels</c> or <c>ChannelIdentification</c> to true. If <c>ShowSpeakerLabels</c> is true, <c>MaxSpeakerLabels</c> must also be set. </para></li><li><para><c>ChannelDefinitions</c>: A <c>MedicalScribeChannelDefinitions</c> array should be set if and only if the <c>ChannelIdentification</c> value of <c>Settings</c> is set to true. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.ChannelDefinition"> <summary> <para> <para>Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set <c>ChannelId</c> of the first <c>ChannelDefinition</c> in the list to <c>0</c> (to indicate the first channel) and <c>ParticipantRole</c> to <c>CLINICIAN</c> (to indicate that it's the clinician speaking). Then you would set the <c>ChannelId</c> of the second <c>ChannelDefinition</c> in the list to <c>1</c> (to indicate the second channel) and <c>ParticipantRole</c> to <c>PATIENT</c> (to indicate that it's the patient speaking). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Settings_ChannelIdentification"> <summary> <para> <para>Enables channel identification in multi-channel audio.</para><para>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.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. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Settings_MaxSpeakerLabel"> <summary> <para> <para>Specify the maximum number of speakers you want to partition in your media.</para><para>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</para><para>If you specify the <c>MaxSpeakerLabels</c> field, you must set the <c>ShowSpeakerLabels</c> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to transcribe. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.MedicalScribeJobName"> <summary> <para> <para>A unique name, chosen by you, for your Medical Scribe job.</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 new job with the same name as an existing job, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.OutputBucketName"> <summary> <para> <para>The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the <c>S3://</c> prefix of the specified bucket.</para><para>Note that the role specified in the <c>DataAccessRoleArn</c> request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The KMS key you want to use to encrypt your Medical Scribe output.</para><para>If using a key located in the <b>current</b> Amazon Web Services account, you can specify your KMS key in one of four ways:</para><ol><li><para>Use the KMS key ID itself. For example, <c>1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use an alias for the KMS key ID. For example, <c>alias/ExampleAlias</c>.</para></li><li><para>Use the Amazon Resource Name (ARN) for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If using a key located in a <b>different</b> Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:</para><ol><li><para>Use the ARN for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).</para><para>Note that the role specified in the <c>DataAccessRoleArn</c> request parameter must have permission to use the specified KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to redact. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para><important><para><c>RedactedMediaFileUri</c> produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (<c>StartCallAnalyticsJob</c>) transcription requests.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Settings_ShowSpeakerLabel"> <summary> <para> <para>Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.</para><para>If you enable <c>ShowSpeakerLabels</c> in your request, you must also include <c>MaxSpeakerLabels</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</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.StartTRSMedicalScribeJobCmdlet.Settings_VocabularyFilterMethod"> <summary> <para> <para>Specify how you want your custom vocabulary filter applied to your transcript.</para><para>To replace words with <c>***</c>, choose <c>mask</c>.</para><para>To delete words, choose <c>remove</c>.</para><para>To flag words without changing them, choose <c>tag</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Settings_VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.</para><para>Note that if you include <c>VocabularyFilterName</c> in your request, you must also include <c>VocabularyFilterMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MedicalScribeJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartMedicalScribeJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartMedicalScribeJobResponse 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.StartTRSMedicalScribeJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MedicalScribeJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalScribeJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalScribeJobCmdlet.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> Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. <para> In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How Amazon Transcribe Medical works</a>. </para><para> To make a <c>StartMedicalTranscriptionJob</c> request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the <c>Media</c> parameter. </para><para> You must include the following parameters in your <c>StartMedicalTranscriptionJob</c> request: </para><ul><li><para><c>region</c>: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and quotas</a>. </para></li><li><para><c>MedicalTranscriptionJobName</c>: A custom name you create for your transcription job that is unique within your Amazon Web Services account. </para></li><li><para><c>Media</c> (<c>MediaFileUri</c>): The Amazon S3 location of your media file. </para></li><li><para><c>LanguageCode</c>: This must be <c>en-US</c>. </para></li><li><para><c>OutputBucketName</c>: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include <c>OutputKey</c>. </para></li><li><para><c>Specialty</c>: This must be <c>PRIMARYCARE</c>. </para></li><li><para><c>Type</c>: Choose whether your audio is a conversation or a dictation. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ChannelIdentification"> <summary> <para> <para>Enables channel identification in multi-channel audio.</para><para>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</para><para>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.ContentIdentificationType"> <summary> <para> <para>Labels all personal health information (PHI) identified in your transcript. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</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. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language spoken in the input media file. US English (<c>en-US</c>) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a <c>BadRequestException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_MaxAlternative"> <summary> <para> <para>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.</para><para>If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.</para><para>If you include <c>MaxAlternatives</c> in your request, you must also include <c>ShowAlternatives</c> with a value of <c>true</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_MaxSpeakerLabel"> <summary> <para> <para>Specify the maximum number of speakers you want to partition in your media.</para><para>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</para><para>If you specify the <c>MaxSpeakerLabels</c> field, you must set the <c>ShowSpeakerLabels</c> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to transcribe. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.MediaFormat"> <summary> <para> <para>Specify the format of your 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 your input media file.</para><para>If you do not specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit <c>MediaSampleRateHertz</c> 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>A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the <c>OutputKey</c> parameter.</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 new job with the same name as an existing job, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputBucketName"> <summary> <para> <para>The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the <c>S3://</c> prefix of the specified bucket.</para><para>If you want your output to go to a sub-folder of this bucket, specify it using the <c>OutputKey</c> parameter; <c>OutputBucketName</c> only accepts the name of a bucket.</para><para>For example, if you want your output stored in <c>S3://DOC-EXAMPLE-BUCKET</c>, set <c>OutputBucketName</c> to <c>DOC-EXAMPLE-BUCKET</c>. However, if you want your output stored in <c>S3://DOC-EXAMPLE-BUCKET/test-files/</c>, set <c>OutputBucketName</c> to <c>DOC-EXAMPLE-BUCKET</c> and <c>OutputKey</c> to <c>test-files/</c>.</para><para>Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The KMS key you want to use to encrypt your medical transcription output.</para><para>If using a key located in the <b>current</b> Amazon Web Services account, you can specify your KMS key in one of four ways:</para><ol><li><para>Use the KMS key ID itself. For example, <c>1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use an alias for the KMS key ID. For example, <c>alias/ExampleAlias</c>.</para></li><li><para>Use the Amazon Resource Name (ARN) for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If using a key located in a <b>different</b> Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:</para><ol><li><para>Use the ARN for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If you do not specify an encryption key, your output 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 using the <c>OutputLocation</c> parameter.</para><para>Note that the role making the request must have permission to use the specified KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.OutputKey"> <summary> <para> <para>Use in combination with <c>OutputBucketName</c> to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (<c>MedicalTranscriptionJobName</c>).</para><para>Here are some examples of how you can use <c>OutputKey</c>:</para><ul><li><para>If you specify 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c> and 'my-transcript.json' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</c>.</para></li><li><para>If you specify 'my-first-transcription' as the <c>MedicalTranscriptionJobName</c>, 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c>, and 'my-transcript' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</c>.</para></li><li><para>If you specify 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c> and 'test-files/my-transcript.json' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</c>.</para></li><li><para>If you specify 'my-first-transcription' as the <c>MedicalTranscriptionJobName</c>, 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c>, and 'test-files/my-transcript' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</c>.</para></li></ul><para>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to redact. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para><important><para><c>RedactedMediaFileUri</c> produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (<c>StartCallAnalyticsJob</c>) transcription requests.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ShowAlternative"> <summary> <para> <para>To include alternative transcriptions within your transcription output, include <c>ShowAlternatives</c> in your transcription request.</para><para>If you include <c>ShowAlternatives</c>, you must also include <c>MaxAlternatives</c>, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_ShowSpeakerLabel"> <summary> <para> <para>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</para><para>If you enable <c>ShowSpeakerLabels</c> in your request, you must also include <c>MaxSpeakerLabels</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Specialty"> <summary> <para> <para>Specify the predominant medical specialty represented in your media. For batch transcriptions, <c>PRIMARYCARE</c> is the only valid value. If you require additional specialties, refer to .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.</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.StartTRSMedicalTranscriptionJobCmdlet.Type"> <summary> <para> <para>Specify whether your input media contains only one person (<c>DICTATION</c>) or contains a conversation between two people (<c>CONVERSATION</c>).</para><para>For example, <c>DICTATION</c> could be used for a medical professional wanting to transcribe voice memos; <c>CONVERSATION</c> could be used for transcribing the doctor-patient dialogue during the patient's office visit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSMedicalTranscriptionJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive.</para><para>The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (<c>en-US</c>) is the only valid language for Amazon Transcribe Medical.</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> Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. <para> To make a <c>StartTranscriptionJob</c> request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the <c>Media</c> parameter. </para><para> You must include the following parameters in your <c>StartTranscriptionJob</c> request: </para><ul><li><para><c>region</c>: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and quotas</a>. </para></li><li><para><c>TranscriptionJobName</c>: A custom name you create for your transcription job that is unique within your Amazon Web Services account. </para></li><li><para><c>Media</c> (<c>MediaFileUri</c>): The Amazon S3 location of your media file. </para></li><li><para> One of <c>LanguageCode</c>, <c>IdentifyLanguage</c>, or <c>IdentifyMultipleLanguages</c>: If you know the language of your media file, specify it using the <c>LanguageCode</c> parameter; you can find all valid language codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. If you do not know the languages spoken in your media, use either <c>IdentifyLanguage</c> or <c>IdentifyMultipleLanguages</c> and let Amazon Transcribe identify the languages for you. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.JobExecutionSettings_AllowDeferredExecution"> <summary> <para> <para>Makes it possible to enable job queuing when your concurrent request limit is exceeded. When <c>AllowDeferredExecution</c> is set to <c>true</c>, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If <c>AllowDeferredExecution</c> is set to <c>false</c> and the number of transcription job requests exceed the concurrent request limit, you get a <c>LimitExceededException</c> error.</para><para>If you include <c>AllowDeferredExecution</c> in your request, you must also include <c>DataAccessRoleArn</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ChannelIdentification"> <summary> <para> <para>Enables channel identification in multi-channel audio.</para><para>Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.JobExecutionSettings_DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para><para>Note that if you include <c>DataAccessRoleArn</c> in your request, you must also include <c>AllowDeferredExecution</c>.</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; if you select both WebVTT (<c>vtt</c>) and SubRip (<c>srt</c>) formats, two output files are generated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.IdentifyLanguage"> <summary> <para> <para>Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use <c>IdentifyMultipleLanguages</c> instead.</para><para>If you include <c>IdentifyLanguage</c>, you can optionally include a list of language codes, using <c>LanguageOptions</c>, that you think may be present in your media file. Including <c>LanguageOptions</c> restricts <c>IdentifyLanguage</c> to only the language options that you specify, which can improve transcription accuracy.</para><para>If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include <c>LanguageIdSettings</c> with the relevant sub-parameters (<c>VocabularyName</c>, <c>LanguageModelName</c>, and <c>VocabularyFilterName</c>). If you include <c>LanguageIdSettings</c>, also include <c>LanguageOptions</c>.</para><para>Note that you must include one of <c>LanguageCode</c>, <c>IdentifyLanguage</c>, or <c>IdentifyMultipleLanguages</c> in your request. If you include more than one of these parameters, your transcription job fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.IdentifyMultipleLanguage"> <summary> <para> <para>Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use <c>IdentifyLanguage</c> instead.</para><para>If you include <c>IdentifyMultipleLanguages</c>, you can optionally include a list of language codes, using <c>LanguageOptions</c>, that you think may be present in your media file. Including <c>LanguageOptions</c> restricts <c>IdentifyLanguage</c> to only the language options that you specify, which can improve transcription accuracy.</para><para>If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include <c>LanguageIdSettings</c> with the relevant sub-parameters (<c>VocabularyName</c> and <c>VocabularyFilterName</c>). If you include <c>LanguageIdSettings</c>, also include <c>LanguageOptions</c>.</para><para>Note that you must include one of <c>LanguageCode</c>, <c>IdentifyLanguage</c>, or <c>IdentifyMultipleLanguages</c> in your request. If you include more than one of these parameters, your transcription job fails.</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. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language spoken in the input media file.</para><para>If you're unsure of the language spoken in your media file, consider using <c>IdentifyLanguage</c> or <c>IdentifyMultipleLanguages</c> to enable automatic language identification.</para><para>Note that you must include one of <c>LanguageCode</c>, <c>IdentifyLanguage</c>, or <c>IdentifyMultipleLanguages</c> in your request. If you include more than one of these parameters, your transcription job fails.</para><para>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</para><note><para>To transcribe speech in Modern Standard Arabic (<c>ar-SA</c>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageIdSetting"> <summary> <para> <para>If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include <c>LanguageIdSettings</c> with the relevant sub-parameters (<c>VocabularyName</c>, <c>LanguageModelName</c>, and <c>VocabularyFilterName</c>). Note that multi-language identification (<c>IdentifyMultipleLanguages</c>) doesn't support custom language models.</para><para><c>LanguageIdSettings</c> supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.</para><para>It's recommended that you include <c>LanguageOptions</c> when using <c>LanguageIdSettings</c> to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in <c>en-US</c> but Amazon Transcribe determines that the language spoken in your media is <c>en-AU</c>, your custom vocabulary <i>is not</i> applied to your transcription. If you include <c>LanguageOptions</c> and include <c>en-US</c> as the only English language dialect, your custom vocabulary <i>is</i> applied to your transcription.</para><para>If you want to include a custom language model with your request but <b>do not</b> want to use automatic language identification, use instead the <code /> parameter with the <c>LanguageModelName</c> sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but <b>do not</b> want to use automatic language identification, use instead the <code /> parameter with the <c>VocabularyName</c> or <c>VocabularyFilterName</c> (or both) sub-parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ModelSettings_LanguageModelName"> <summary> <para> <para>The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.</para><para>The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageOption"> <summary> <para> <para>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</para><para>If you include <c>LanguageOptions</c> in your request, you must also include <c>IdentifyLanguage</c>.</para><para>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>.</para><para>To transcribe speech in Modern Standard Arabic (<c>ar-SA</c>), your media 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>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.</para><para>If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.</para><para>If you include <c>MaxAlternatives</c> in your request, you must also include <c>ShowAlternatives</c> with a value of <c>true</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_MaxSpeakerLabel"> <summary> <para> <para>Specify the maximum number of speakers you want to partition in your media.</para><para>Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.</para><para>If you specify the <c>MaxSpeakerLabels</c> field, you must set the <c>ShowSpeakerLabels</c> field to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Media_MediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to transcribe. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.MediaFormat"> <summary> <para> <para>Specify the format of your 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 your input media file.</para><para>If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit <c>MediaSampleRateHertz</c> 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 name of the Amazon S3 bucket where you want your transcription output stored. Do not include the <c>S3://</c> prefix of the specified bucket.</para><para>If you want your output to go to a sub-folder of this bucket, specify it using the <c>OutputKey</c> parameter; <c>OutputBucketName</c> only accepts the name of a bucket.</para><para>For example, if you want your output stored in <c>S3://DOC-EXAMPLE-BUCKET</c>, set <c>OutputBucketName</c> to <c>DOC-EXAMPLE-BUCKET</c>. However, if you want your output stored in <c>S3://DOC-EXAMPLE-BUCKET/test-files/</c>, set <c>OutputBucketName</c> to <c>DOC-EXAMPLE-BUCKET</c> and <c>OutputKey</c> to <c>test-files/</c>.</para><para>Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <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>If you do not specify <c>OutputBucketName</c>, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputEncryptionKMSKeyId"> <summary> <para> <para>The KMS key you want to use to encrypt your transcription output.</para><para>If using a key located in the <b>current</b> Amazon Web Services account, you can specify your KMS key in one of four ways:</para><ol><li><para>Use the KMS key ID itself. For example, <c>1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use an alias for the KMS key ID. For example, <c>alias/ExampleAlias</c>.</para></li><li><para>Use the Amazon Resource Name (ARN) for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If using a key located in a <b>different</b> Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:</para><ol><li><para>Use the ARN for the KMS key ID. For example, <c>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Use the ARN for the KMS key alias. For example, <c>arn:aws:kms:region:account-ID:alias/ExampleAlias</c>.</para></li></ol><para>If you do not specify an encryption key, your output 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 using the <c>OutputLocation</c> parameter.</para><para>Note that the role making the request must have permission to use the specified KMS key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputKey"> <summary> <para> <para>Use in combination with <c>OutputBucketName</c> to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (<c>TranscriptionJobName</c>).</para><para>Here are some examples of how you can use <c>OutputKey</c>:</para><ul><li><para>If you specify 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c> and 'my-transcript.json' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</c>.</para></li><li><para>If you specify 'my-first-transcription' as the <c>TranscriptionJobName</c>, 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c>, and 'my-transcript' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</c>.</para></li><li><para>If you specify 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c> and 'test-files/my-transcript.json' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</c>.</para></li><li><para>If you specify 'my-first-transcription' as the <c>TranscriptionJobName</c>, 'DOC-EXAMPLE-BUCKET' as the <c>OutputBucketName</c>, and 'test-files/my-transcript' as the <c>OutputKey</c>, your transcription output path is <c>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</c>.</para></li></ul><para>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Subtitles_OutputStartIndex"> <summary> <para> <para>Specify the starting value that is assigned to the first subtitle segment.</para><para>The default start index for Amazon Transcribe is <c>0</c>, which differs from the more widely used standard of <c>1</c>. If you're uncertain which value to use, we recommend choosing <c>1</c>, as this may improve compatibility with other services.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_PiiEntityType"> <summary> <para> <para>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <c>ALL</c>. If you do not include <c>PiiEntityTypes</c> in your request, all PII is redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Media_RedactedMediaFileUri"> <summary> <para> <para>The Amazon S3 location of the media file you want to redact. For example:</para><ul><li><para><c>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</c></para></li><li><para><c>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</c></para></li></ul><para>Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.</para><important><para><c>RedactedMediaFileUri</c> produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (<c>StartCallAnalyticsJob</c>) transcription requests.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_RedactionOutput"> <summary> <para> <para>Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.</para><para>When you choose <c>redacted</c> Amazon Transcribe creates only a redacted transcript.</para><para>When you choose <c>redacted_and_unredacted</c> Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.ContentRedaction_RedactionType"> <summary> <para> <para>Specify the category of information you want to redact; <c>PII</c> (personally identifiable information) is the only valid value. You can use <c>PiiEntityTypes</c> to choose which types of PII you want to redact. If you do not include <c>PiiEntityTypes</c> in your request, all PII is redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ShowAlternative"> <summary> <para> <para>To include alternative transcriptions within your transcription output, include <c>ShowAlternatives</c> in your transcription request.</para><para>If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.</para><para>If you include <c>ShowAlternatives</c>, you must also include <c>MaxAlternatives</c>, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative transcriptions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ShowSpeakerLabel"> <summary> <para> <para>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</para><para>If you enable <c>ShowSpeakerLabels</c> in your request, you must also include <c>MaxSpeakerLabels</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Tag"> <summary> <para> <para>Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.</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.StartTRSTranscriptionJobCmdlet.ToxicityDetection"> <summary> <para> <para>Enables toxic speech detection in your transcript. If you include <c>ToxicityDetection</c> in your request, you must also include <c>ToxicityCategories</c>.</para><para>For information on the types of toxic speech Amazon Transcribe can detect, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/toxic-language.html">Detecting toxic speech</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.TranscriptionJobName"> <summary> <para> <para>A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the <c>OutputKey</c> parameter.</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 new job with the same name as an existing job, you get a <c>ConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyFilterMethod"> <summary> <para> <para>Specify how you want your custom vocabulary filter applied to your transcript.</para><para>To replace words with <c>***</c>, choose <c>mask</c>.</para><para>To delete words, choose <c>remove</c>.</para><para>To flag words without changing them, choose <c>tag</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</para><para>Note that if you include <c>VocabularyFilterName</c> in your request, you must also include <c>VocabularyFilterMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</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 specified Call Analytics category with new rules. Note that the <c>UpdateCallAnalyticsCategory</c> operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category. <para> To create a new category, see . </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.CategoryName"> <summary> <para> <para>The name of the Call Analytics category you want to update. Category names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.InputType"> <summary> <para> <para>Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the <c>POST_CALL</c> input type, you must use <c>POST_CALL</c> as the input type when updating this category.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSCallAnalyticsCategoryCmdlet.Rule"> <summary> <para> <para>The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.</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 an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of the entries in the custom vocabulary you want to update. US English (<c>en-US</c>) is the only language supported with Amazon Transcribe Medical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSMedicalVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.</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 custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.</para><para>A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (<c>en-US</c>), you can only apply this custom vocabulary to files that contain English audio.</para><para>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.Phrase"> <summary> <para> <para>Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the <c>VocabularyFileUri</c> parameter.</para><para>Note that if you include <c>Phrases</c> in your request, you cannot use <c>VocabularyFileUri</c>; you must choose one or the other.</para><para>Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyFileUri"> <summary> <para> <para>The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</c></para><para>Note that if you include <c>VocabularyFileUri</c> in your request, you cannot use the <c>Phrases</c> flag; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyName"> <summary> <para> <para>The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.</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 an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</para><para>IAM role ARNs have the format <c>arn:partition:iam::account:role/role-name-with-path</c>. For example: <c>arn:aws:iam::111122223333:role/Admin</c>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.VocabularyFilterFileUri"> <summary> <para> <para>The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.</para><para>Here's an example URI path: <c>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</c></para><para>Note that if you include <c>VocabularyFilterFileUri</c> in your request, you cannot use <c>Words</c>; you must choose one or the other.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.VocabularyFilterName"> <summary> <para> <para>The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyFilterCmdlet.Word"> <summary> <para> <para>Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the <c>VocabularyFilterFileUri</c> parameter.</para><para>Note that if you include <c>Words</c> in your request, you cannot use <c>VocabularyFilterFileUri</c>; you must choose one or the other.</para><para>Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your language.</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> |