|
7 | 7 | "DeleteTranscriptionJob": "<p>Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.</p>", |
8 | 8 | "DeleteVocabulary": "<p>Deletes a vocabulary from Amazon Transcribe. </p>", |
9 | 9 | "DeleteVocabularyFilter": "<p>Removes a vocabulary filter.</p>", |
10 | | - "GetTranscriptionJob": "<p>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.</p>", |
| 10 | + "GetTranscriptionJob": "<p>Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>.</p>", |
11 | 11 | "GetVocabulary": "<p>Gets information about a vocabulary. </p>", |
12 | 12 | "GetVocabularyFilter": "<p>Returns information about a vocabulary filter.</p>", |
13 | 13 | "ListTranscriptionJobs": "<p>Lists transcription jobs with the specified status.</p>", |
|
37 | 37 | "refs": { |
38 | 38 | } |
39 | 39 | }, |
| 40 | + "ContentRedaction": { |
| 41 | + "base": "<p>Settings for content redaction within a transcription job.</p> <p>You can redact transcripts in US English (en-us). For more information see: <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html\">Automatic Content Redaction</a> </p>", |
| 42 | + "refs": { |
| 43 | + "StartTranscriptionJobRequest$ContentRedaction": "<p>An object that contains the request parameters for content redaction.</p>", |
| 44 | + "TranscriptionJob$ContentRedaction": "<p>An object that describes content redaction settings for the transcription job.</p>", |
| 45 | + "TranscriptionJobSummary$ContentRedaction": "<p>The content redaction settings of the transcription job.</p>" |
| 46 | + } |
| 47 | + }, |
40 | 48 | "CreateVocabularyFilterRequest": { |
41 | 49 | "base": null, |
42 | 50 | "refs": { |
|
269 | 277 | "OutputBucketName": { |
270 | 278 | "base": null, |
271 | 279 | "refs": { |
272 | | - "StartTranscriptionJobRequest$OutputBucketName": "<p>The location where the transcription is stored.</p> <p>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>.</p> <p>You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</p> <p>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.</p>" |
| 280 | + "StartTranscriptionJobRequest$OutputBucketName": "<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the <code>TranscriptFileUri</code>. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</p> <p>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.</p>" |
273 | 281 | } |
274 | 282 | }, |
275 | 283 | "OutputLocationType": { |
|
291 | 299 | "UpdateVocabularyRequest$Phrases": "<p>An array of strings containing the vocabulary entries.</p>" |
292 | 300 | } |
293 | 301 | }, |
| 302 | + "RedactionOutput": { |
| 303 | + "base": null, |
| 304 | + "refs": { |
| 305 | + "ContentRedaction$RedactionOutput": "<p>Request parameter where you choose whether to output only the redacted transcript or generate an additional unredacted transcript.</p> <p>When you choose <code>redacted</code> Amazon Transcribe outputs a JSON file with only the redacted transcript and related information.</p> <p>When you choose <code>redacted_and_unredacted</code> Amazon Transcribe outputs a JSON file with the unredacted transcript and related information in addition to the JSON file with the redacted transcript.</p>" |
| 306 | + } |
| 307 | + }, |
| 308 | + "RedactionType": { |
| 309 | + "base": null, |
| 310 | + "refs": { |
| 311 | + "ContentRedaction$RedactionType": "<p>Request parameter that defines the entities to be redacted. The only accepted value is <code>PII</code>.</p>" |
| 312 | + } |
| 313 | + }, |
294 | 314 | "Settings": { |
295 | 315 | "base": "<p>Provides optional settings for the <code>StartTranscriptionJob</code> operation.</p>", |
296 | 316 | "refs": { |
|
390 | 410 | "CreateVocabularyRequest$VocabularyFileUri": "<p>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 </p> <p> <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt</code> </p> <p>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>.</p> <p>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>.</p>", |
391 | 411 | "GetVocabularyFilterResponse$DownloadUri": "<p>The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.</p>", |
392 | 412 | "GetVocabularyResponse$DownloadUri": "<p>The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.</p>", |
393 | | - "Media$MediaFileUri": "<p>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:</p> <p> <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/example.mp4</code> </p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4</code> </p> <p>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>.</p>", |
394 | | - "Transcript$TranscriptFileUri": "<p>The location where the transcription is stored.</p> <p>Use this URI to access the transcription. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>", |
| 413 | + "Media$MediaFileUri": "<p>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code> s3://<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>s3://examplebucket/example.mp4</code> </p> <p> <code>s3://examplebucket/mediadocs/example.mp4</code> </p> <p>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>.</p>", |
| 414 | + "Transcript$TranscriptFileUri": "<p>The S3 object location of the the transcript.</p> <p>Use this URI to access the transcript. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>", |
| 415 | + "Transcript$RedactedTranscriptFileUri": "<p>The S3 object location of the redacted transcript.</p> <p>Use this URI to access the redacated transcript. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>", |
395 | 416 | "UpdateVocabularyFilterRequest$VocabularyFilterFileUri": "<p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets\">Character Sets for Custom Vocabularies</a>.</p> <p>The specified file must be less than 50 KB of UTF-8 characters.</p> <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code> parameter, you can't use the <code>Words</code> parameter.</p>", |
396 | 417 | "UpdateVocabularyRequest$VocabularyFileUri": "<p>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 </p> <p> <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt</code> </p> <p>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>.</p> <p>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>.</p>" |
397 | 418 | } |
|
0 commit comments