AWS.Tools.TranscribeService

3.3.590.0

AWS.Tools.TranscribeService.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.TranscribeService</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet">
            <summary>
            Returns information about a transcription job. To see the status of the job, check
            the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
            the job is finished and you can find the results at the location specified in the
            <code>TranscriptionFileUri</code> field.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobCmdlet.TranscriptionJobName">
            <summary>
            <para>
            <para>The name of the job.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet">
            <summary>
            Lists transcription jobs with the specified status.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.JobNameContain">
            <summary>
            <para>
            <para>When specified, the jobs returned in the list are limited to jobs whose name contains
            the specified string.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.Status">
            <summary>
            <para>
            <para>When specified, returns only transcription jobs with the specified status. Jobs are
            ordered by creation date, with the newest jobs returned first. If you don’t specify
            a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
            </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of jobs to return in the response. If there are fewer results in
            the list, this response contains only the actual results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSTranscriptionJobListCmdlet.NextToken">
            <summary>
            <para>
            <para>If the result of the previous request to <code>ListTranscriptionJobs</code> was truncated,
            include the <code>NextToken</code> to fetch the next set of jobs.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet">
            <summary>
            Gets information about a vocabulary.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyCmdlet.VocabularyName">
            <summary>
            <para>
            <para>The name of the vocabulary to return information about. The name is case-sensitive.</para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet">
            <summary>
            Returns a list of vocabularies that match the specified criteria. If no criteria are
            specified, returns the entire list of vocabularies.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.NameContain">
            <summary>
            <para>
            <para>When specified, the vocabularies returned in the list are limited to vocabularies
            whose name contains the specified string. The search is case-insensitive, <code>ListVocabularies</code>
            will return both "vocabularyname" and "VocabularyName" in the response list.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.StateEqual">
            <summary>
            <para>
            <para>When specified, only returns vocabularies with the <code>VocabularyState</code> field
            equal to the specified state.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of vocabularies to return in the response. If there are fewer results
            in the list, this response contains only the actual results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.GetTRSVocabularyListCmdlet.NextToken">
            <summary>
            <para>
            <para>If the result of the previous request to <code>ListVocabularies</code> was truncated,
            include the <code>NextToken</code> to fetch the next set of jobs.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet">
            <summary>
            Creates a new custom vocabulary that you can use to change the way Amazon Transcribe
            handles transcription of an audio file.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.LanguageCode">
            <summary>
            <para>
            <para>The language code of the vocabulary entries.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.Phrase">
            <summary>
            <para>
            <para>An array of strings that contains the vocabulary entries. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.VocabularyFileUri">
            <summary>
            <para>
            <para>The S3 location of the text file that contains the definition of the custom vocabulary.
            The URI must be in the same region as the API endpoint that you are calling. The general
            form is </para><para><code> https://s3-&lt;aws-region&gt;.amazonaws.com/&lt;bucket-name&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;
            </code></para><para>For example:</para><para><code>https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt</code></para><para>For more information about S3 object names, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object
            Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>For more information about custom vocabularies, see <a href="http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary">Custom
            Vocabularies</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.NewTRSVocabularyCmdlet.VocabularyName">
            <summary>
            <para>
            <para>The name of the vocabulary. The name must be unique within an AWS account. The name
            is case-sensitive.</para>
            </para>
            </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.RemoveTRSTranscriptionJobCmdlet">
            <summary>
            Deletes a previously submitted transcription job along with any other generated results
            such as the transcription, models, and so on.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.TranscriptionJobName">
            <summary>
            <para>
            <para>The name of the transcription job to be deleted.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSTranscriptionJobCmdlet.PassThru">
            <summary>
            Returns the value passed to the TranscriptionJobName parameter.
            By default, this cmdlet does not generate any output.
            </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 vocabulary from Amazon Transcribe.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.VocabularyName">
            <summary>
            <para>
            <para>The name of the vocabulary to delete. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.RemoveTRSVocabularyCmdlet.PassThru">
            <summary>
            Returns the value passed to the VocabularyName parameter.
            By default, this cmdlet does not generate any output.
            </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.StartTRSTranscriptionJobCmdlet">
            <summary>
            Starts an asynchronous job to transcribe speech to text.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ChannelIdentification">
            <summary>
            <para>
            <para>Instructs Amazon Transcribe to process each audio channel separately and then merge
            the transcription output of each channel into a single transcription. </para><para>Amazon Transcribe also produces a transcription of each item detected on an audio
            channel, including the start time and end time of the item and alternative transcriptions
            of the item including the confidence that Amazon Transcribe has in the transcription.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code>
            in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.LanguageCode">
            <summary>
            <para>
            <para>The language code for the language used in the input media file.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_MaxSpeakerLabel">
            <summary>
            <para>
            <para>The maximum number of speakers to identify in the input audio. If there are more speakers
            in the audio than this number, multiple speakers will be identified as a single speaker.
            If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code>
            field to true.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Media_MediaFileUri">
            <summary>
            <para>
            <para>The S3 location of the input media file. The URI must be in the same region as the
            API endpoint that you are calling. The general form is:</para><para><code> https://s3-&lt;aws-region&gt;.amazonaws.com/&lt;bucket-name&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;
            </code></para><para>For example:</para><para><code>https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4</code></para><para><code>https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4</code></para><para>For more information about S3 object names, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object
            Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.MediaFormat">
            <summary>
            <para>
            <para>The format of the input media file.</para><para> If you do not specify the format of the media file, Amazon Transcribe determines
            the format. If the format is not recognized, Amazon Transcribe returns an <code>InternalFailureException</code>
            exception. If you specify the format, it must match the format detected by Amazon
            Transcribe, otherwise you get an <code>InternalFailureException</code> exception.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.MediaSampleRateHertz">
            <summary>
            <para>
            <para>The sample rate of the audio track in the input media file in Hertz. </para><para>If you do not specify the media sample rate, Amazon Transcribe determines the sample
            rate. If you specify the sample rate, it must match the sample rate detected by Amazon
            Transcribe. In most cases, you should leave the <code>MediaSampleRateHertz</code>
            field blank and let Amazon Transcribe determine the sample rate.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.OutputBucketName">
            <summary>
            <para>
            <para>The location where the transcription is stored.</para><para>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription
            in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation,
            the operation returns this location in the <code>TranscriptFileUri</code> field. The
            S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket.
            For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
            Required for IAM User Roles</a>.</para><para>Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts
            that are placed in your S3 bucket. You can't specify your own encryption key.</para><para>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a
            pre-signed URL, a shareable URL that provides secure access to your transcription,
            and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download
            the transcription.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_ShowSpeakerLabel">
            <summary>
            <para>
            <para>Determines whether the transcription job uses speaker recognition to identify different
            speakers in the input audio. Speaker recognition labels individual speakers in the
            audio file. If you set the <code>ShowSpeakerLabels</code> field to true, you must
            also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</para><para>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code>
            in the same request. If you set both, your request returns a <code>BadRequestException</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.TranscriptionJobName">
            <summary>
            <para>
            <para>The name of the job. Note that you can't use the strings "." or ".." by themselves
            as the job name. The name must also be unique within an AWS account.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Settings_VocabularyName">
            <summary>
            <para>
            <para>The name of a vocabulary to use when processing the transcription job.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.StartTRSTranscriptionJobCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet">
            <summary>
            Updates an existing vocabulary with new values. The <code>UpdateVocabulary</code>
            operation overwrites all of the existing information with the values that you provide
            in the request.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.LanguageCode">
            <summary>
            <para>
            <para>The language code of the vocabulary entries.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.Phrase">
            <summary>
            <para>
            <para>An array of strings containing the vocabulary entries.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyFileUri">
            <summary>
            <para>
            <para>The S3 location of the text file that contains the definition of the custom vocabulary.
            The URI must be in the same region as the API endpoint that you are calling. The general
            form is </para><para><code> https://s3-&lt;aws-region&gt;.amazonaws.com/&lt;bucket-name&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;
            </code></para><para>For example:</para><para><code>https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt</code></para><para>For more information about S3 object names, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object
            Keys</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>For more information about custom vocabularies, see <a href="http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary">Custom
            Vocabularies</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.TRS.UpdateTRSVocabularyCmdlet.VocabularyName">
            <summary>
            <para>
            <para>The name of the vocabulary to update. The name is case-sensitive.</para>
            </para>
            </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>
    </members>
</doc>