--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_transcribe_transcription_job{% #aws_transcribe_transcription_job %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `completion_time`{% #completion_time %} **Type**: `TIMESTAMP`**Provider name**: `CompletionTime`**Description**: The date and time the specified transcription job finished processing. Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For example, `2022-05-04T12:33:13.922000-07:00` represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. ## `content_redaction`{% #content_redaction %} **Type**: `STRUCT`**Provider name**: `ContentRedaction`**Description**: Indicates whether redaction was enabled in your transcript. - `pii_entity_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `PiiEntityTypes`**Description**: 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 `ALL`. If you do not include `PiiEntityTypes` in your request, all PII is redacted. - `redaction_output`**Type**: `STRING`**Provider name**: `RedactionOutput`**Description**: Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript. When you choose `redacted` Amazon Transcribe creates only a redacted transcript. When you choose `redacted_and_unredacted` Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files). - `redaction_type`**Type**: `STRING`**Provider name**: `RedactionType`**Description**: Specify the category of information you want to redact; `PII` (personally identifiable information) is the only valid value. You can use `PiiEntityTypes` to choose which types of PII you want to redact. If you do not include `PiiEntityTypes` in your request, all PII is redacted. ## `creation_time`{% #creation_time %} **Type**: `TIMESTAMP`**Provider name**: `CreationTime`**Description**: The date and time the specified transcription job request was made. Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For example, `2022-05-04T12:32:58.761000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. ## `failure_reason`{% #failure_reason %} **Type**: `STRING`**Provider name**: `FailureReason`**Description**: If `TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job request failed. The `FailureReason` field contains one of the following values: - `Unsupported media format`. The media format specified in `MediaFormat` isn't valid. Refer to refer to the `MediaFormat` parameter for a list of supported formats. - `The media format provided does not match the detected media format`. The media format specified in `MediaFormat` doesn't match the format of the input file. Check the media format of your media file and correct the specified value. - `Invalid sample rate for audio file`. The sample rate specified in `MediaSampleRateHertz` isn't valid. The sample rate must be between 8,000 and 48,000 hertz. - `The sample rate provided does not match the detected sample rate`. The sample rate specified in `MediaSampleRateHertz` doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. - `Invalid file size: file size too large`. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to [Service quotas](https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe). - `Invalid number of channels: number of channels too large`. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to [Service quotas](https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe). ## `identified_language_score`{% #identified_language_score %} **Type**: `FLOAT`**Provider name**: `IdentifiedLanguageScore`**Description**: The confidence score associated with the language identified in your media file. Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media. ## `identify_language`{% #identify_language %} **Type**: `BOOLEAN`**Provider name**: `IdentifyLanguage`**Description**: Indicates whether automatic language identification was enabled (`TRUE`) for the specified transcription job. ## `identify_multiple_languages`{% #identify_multiple_languages %} **Type**: `BOOLEAN`**Provider name**: `IdentifyMultipleLanguages`**Description**: Indicates whether automatic multi-language identification was enabled (`TRUE`) for the specified transcription job. ## `job_execution_settings`{% #job_execution_settings %} **Type**: `STRUCT`**Provider name**: `JobExecutionSettings`**Description**: Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used. - `allow_deferred_execution`**Type**: `BOOLEAN`**Provider name**: `AllowDeferredExecution`**Description**: Makes it possible to enable job queuing when your concurrent request limit is exceeded. When `AllowDeferredExecution` is set to `true`, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If `AllowDeferredExecution` is set to `false` and the number of transcription job requests exceed the concurrent request limit, you get a `LimitExceededException` error. If you include `AllowDeferredExecution` in your request, you must also include `DataAccessRoleArn`. - `data_access_role_arn`**Type**: `STRING`**Provider name**: `DataAccessRoleArn`**Description**: 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. IAM role ARNs have the format `arn:partition:iam::account:role/role-name-with-path`. For example: `arn:aws:iam::111122223333:role/Admin`. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). Note that if you include `DataAccessRoleArn` in your request, you must also include `AllowDeferredExecution`. ## `language_code`{% #language_code %} **Type**: `STRING`**Provider name**: `LanguageCode`**Description**: The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, `LanguageCodes`. ## `language_codes`{% #language_codes %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `LanguageCodes`**Description**: The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, `LanguageCode`. - `duration_in_seconds`**Type**: `FLOAT`**Provider name**: `DurationInSeconds`**Description**: Provides the total time, in seconds, each identified language is spoken in your media. - `language_code`**Type**: `STRING`**Provider name**: `LanguageCode`**Description**: Provides the language code for each language identified in your media. ## `language_id_settings`{% #language_id_settings %} **Type**: `STRING`**Provider name**: `LanguageIdSettings`**Description**: Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request. ## `language_options`{% #language_options %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `LanguageOptions`**Description**: Provides the language codes you specified in your request. ## `media`{% #media %} **Type**: `STRUCT`**Provider name**: `Media`**Description**: Provides the Amazon S3 location of the media file you used in your request. - `media_file_uri`**Type**: `STRING`**Provider name**: `MediaFileUri`**Description**: The Amazon S3 location of the media file you want to transcribe. For example: - `s3://DOC-EXAMPLE-BUCKET/my-media-file.flac` - `s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac` 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. - `redacted_media_file_uri`**Type**: `STRING`**Provider name**: `RedactedMediaFileUri`**Description**: The Amazon S3 location of the media file you want to redact. For example: - `s3://DOC-EXAMPLE-BUCKET/my-media-file.flac` - `s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac` 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.`RedactedMediaFileUri` produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (`StartCallAnalyticsJob`) transcription requests. ## `media_format`{% #media_format %} **Type**: `STRING`**Provider name**: `MediaFormat`**Description**: The format of the input media file. ## `media_sample_rate_hertz`{% #media_sample_rate_hertz %} **Type**: `INT32`**Provider name**: `MediaSampleRateHertz`**Description**: The sample rate, in hertz, of the audio track in your input media file. ## `model_settings`{% #model_settings %} **Type**: `STRUCT`**Provider name**: `ModelSettings`**Description**: Provides information on the custom language model you included in your request. - `language_model_name`**Type**: `STRING`**Provider name**: `LanguageModelName`**Description**: 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. 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. ## `settings`{% #settings %} **Type**: `STRUCT`**Provider name**: `Settings`**Description**: Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters. - `channel_identification`**Type**: `BOOLEAN`**Provider name**: `ChannelIdentification`**Description**: Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see [Transcribing multi-channel audio](https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). - `max_alternatives`**Type**: `INT32`**Provider name**: `MaxAlternatives`**Description**: Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript. 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. If you include `MaxAlternatives` in your request, you must also include `ShowAlternatives` with a value of `true`. For more information, see [Alternative transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). - `max_speaker_labels`**Type**: `INT32`**Provider name**: `MaxSpeakerLabels`**Description**: Specify the maximum number of speakers you want to partition in your media. Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker. If you specify the `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field to true. - `show_alternatives`**Type**: `BOOLEAN`**Provider name**: `ShowAlternatives`**Description**: To include alternative transcriptions within your transcription output, include `ShowAlternatives` in your transcription request. 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. If you include `ShowAlternatives`, you must also include `MaxAlternatives`, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate. For more information, see [Alternative transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). - `show_speaker_labels`**Type**: `BOOLEAN`**Provider name**: `ShowSpeakerLabels`**Description**: Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable `ShowSpeakerLabels` in your request, you must also include `MaxSpeakerLabels`. For more information, see [Partitioning speakers (diarization)](https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). - `vocabulary_filter_method`**Type**: `STRING`**Provider name**: `VocabularyFilterMethod`**Description**: Specify how you want your custom vocabulary filter applied to your transcript. To replace words with `***`, choose `mask`. To delete words, choose `remove`. To flag words without changing them, choose `tag`. - `vocabulary_filter_name`**Type**: `STRING`**Provider name**: `VocabularyFilterName`**Description**: 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. Note that if you include `VocabularyFilterName` in your request, you must also include `VocabularyFilterMethod`. - `vocabulary_name`**Type**: `STRING`**Provider name**: `VocabularyName`**Description**: 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. ## `start_time`{% #start_time %} **Type**: `TIMESTAMP`**Provider name**: `StartTime`**Description**: The date and time the specified transcription job began processing. Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For example, `2022-05-04T12:32:58.789000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. ## `subtitles`{% #subtitles %} **Type**: `STRUCT`**Provider name**: `Subtitles`**Description**: Indicates whether subtitles were generated with your transcription. - `formats`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `Formats`**Description**: Provides the format of your subtitle files. If your request included both WebVTT (`vtt`) and SubRip (`srt`) formats, both formats are shown. - `output_start_index`**Type**: `INT32`**Provider name**: `OutputStartIndex`**Description**: Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of `0` is used. - `subtitle_file_uris`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SubtitleFileUris`**Description**: The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided. If you included `OutputBucketName` in your transcription job request, this is the URI of that bucket. If you also included `OutputKey` in your request, your output is located in the path you specified in your request. If you didn't include `OutputBucketName` in your transcription job request, your subtitle file is stored in a service-managed bucket, and `TranscriptFileUri` provides you with a temporary URI you can use for secure access to your subtitle file.Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an `AccesDenied` error, you can get a new temporary URI by running a `GetTranscriptionJob` or `ListTranscriptionJob` request. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `toxicity_detection`{% #toxicity_detection %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ToxicityDetection`**Description**: Provides information about the toxicity detection settings applied to your transcription. - `toxicity_categories`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ToxicityCategories`**Description**: If you include `ToxicityDetection` in your transcription request, you must also include `ToxicityCategories`. The only accepted value for this parameter is `ALL`. ## `transcript`{% #transcript %} **Type**: `STRUCT`**Provider name**: `Transcript`**Description**: Provides you with the Amazon S3 URI you can use to access your transcript. - `redacted_transcript_file_uri`**Type**: `STRING`**Provider name**: `RedactedTranscriptFileUri`**Description**: The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript. If you included `OutputBucketName` in your transcription job request, this is the URI of that bucket. If you also included `OutputKey` in your request, your output is located in the path you specified in your request. If you didn't include `OutputBucketName` in your transcription job request, your transcript is stored in a service-managed bucket, and `RedactedTranscriptFileUri` provides you with a temporary URI you can use for secure access to your transcript.Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an `AccesDenied` error, you can get a new temporary URI by running a `GetTranscriptionJob` or `ListTranscriptionJob` request. - `transcript_file_uri`**Type**: `STRING`**Provider name**: `TranscriptFileUri`**Description**: The Amazon S3 location of your transcript. You can use this URI to access or download your transcript. If you included `OutputBucketName` in your transcription job request, this is the URI of that bucket. If you also included `OutputKey` in your request, your output is located in the path you specified in your request. If you didn't include `OutputBucketName` in your transcription job request, your transcript is stored in a service-managed bucket, and `TranscriptFileUri` provides you with a temporary URI you can use for secure access to your transcript.Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an `AccesDenied` error, you can get a new temporary URI by running a `GetTranscriptionJob` or `ListTranscriptionJob` request. ## `transcription_job_name`{% #transcription_job_name %} **Type**: `STRING`**Provider name**: `TranscriptionJobName`**Description**: The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account. ## `transcription_job_status`{% #transcription_job_status %} **Type**: `STRING`**Provider name**: `TranscriptionJobStatus`**Description**: Provides the status of the specified transcription job. If the status is `COMPLETED`, the job is finished and you can find the results at the location specified in `TranscriptFileUri` (or `RedactedTranscriptFileUri`, if you requested transcript redaction). If the status is `FAILED`, `FailureReason` provides details on why your transcription job failed.