Skip to content

aws.transcribe.get_call_analytics_job

Example SQL Queries

SELECT * FROM
aws.transcribe.get_call_analytics_job
WHERE
"call_analytics_job_name" = 'VALUE';

Description

Provides information about the specified Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

To get a list of your Call Analytics jobs, use the operation.

Table Definition

Column NameColumn Data Type
call_analytics_job_name Required Input Column

The name of the Call Analytics job you want information about. Job names are case sensitive.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
call_analytics_job

Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

STRUCT(
"call_analytics_job_name" VARCHAR,
"call_analytics_job_status" VARCHAR,
"call_analytics_job_details" STRUCT(
"skipped" STRUCT(
"feature" VARCHAR,
"reason_code" VARCHAR,
"message" VARCHAR
)[]
),
"language_code" VARCHAR,
"media_sample_rate_hertz" BIGINT,
"media_format" VARCHAR,
"media" STRUCT(
"media_file_uri" VARCHAR,
"redacted_media_file_uri" VARCHAR
),
"transcript" STRUCT(
"transcript_file_uri" VARCHAR,
"redacted_transcript_file_uri" VARCHAR
),
"start_time" TIMESTAMP_S,
"creation_time" TIMESTAMP_S,
"completion_time" TIMESTAMP_S,
"failure_reason" VARCHAR,
"data_access_role_arn" VARCHAR,
"identified_language_score" DOUBLE,
"settings" STRUCT(
"vocabulary_name" VARCHAR,
"vocabulary_filter_name" VARCHAR,
"vocabulary_filter_method" VARCHAR,
"language_model_name" VARCHAR,
"content_redaction" STRUCT(
"redaction_type" VARCHAR,
"redaction_output" VARCHAR,
"pii_entity_types" VARCHAR[]
),
"language_options" VARCHAR[],
"language_id_settings" MAP(VARCHAR, STRUCT(
"vocabulary_name" VARCHAR,
"vocabulary_filter_name" VARCHAR,
"language_model_name" VARCHAR
)),
"summarization" STRUCT(
"generate_abstractive_summary" BOOLEAN
)
),
"channel_definitions" STRUCT(
"channel_id" BIGINT,
"participant_role" VARCHAR
)[]
)
Show child fields
call_analytics_job.call_analytics_job_details

Provides detailed information about a call analytics job, including information about skipped analytics features.

Show child fields
call_analytics_job.call_analytics_job_details.skipped[]
Show child fields
call_analytics_job.call_analytics_job_details.skipped[].feature

Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.

call_analytics_job.call_analytics_job_details.skipped[].message

Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.

call_analytics_job.call_analytics_job_details.skipped[].reason_code

Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.

call_analytics_job.call_analytics_job_name

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

call_analytics_job.call_analytics_job_status

Provides the status of the specified Call Analytics 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.

call_analytics_job.channel_definitions[]
Show child fields
call_analytics_job.channel_definitions[].channel_id

Specify the audio channel you want to define.

call_analytics_job.channel_definitions[].participant_role

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

call_analytics_job.completion_time

The date and time the specified Call Analytics 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.

call_analytics_job.creation_time

The date and time the specified Call Analytics 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.

call_analytics_job.data_access_role_arn

The Amazon Resource Name (ARN) you included in your request.

call_analytics_job.failure_reason

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics 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.

  • 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.

call_analytics_job.identified_language_score

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.

call_analytics_job.language_code

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

call_analytics_job.media

Provides the Amazon S3 location of the media file you used in your Call Analytics request.

Show child fields
call_analytics_job.media.media_file_uri

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.

call_analytics_job.media.redacted_media_file_uri

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.

call_analytics_job.media_format

The format of the input media file.

call_analytics_job.media_sample_rate_hertz

The sample rate, in hertz, of the audio track in your input media file.

call_analytics_job.settings

Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

Show child fields
call_analytics_job.settings.content_redaction

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

Show child fields
call_analytics_job.settings.content_redaction.pii_entity_types[]
call_analytics_job.settings.content_redaction.redaction_output

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).

call_analytics_job.settings.content_redaction.redaction_type

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.

call_analytics_job.settings.language_id_settings

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 LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

LanguageIdSettings 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.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

call_analytics_job.settings.language_model_name

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.

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.

call_analytics_job.settings.language_options[]
call_analytics_job.settings.summarization

Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

Show child fields
call_analytics_job.settings.summarization.generate_abstractive_summary

Enables Generative call summarization in your Call Analytics request

Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

For more information, see Enabling generative call summarization.

call_analytics_job.settings.vocabulary_filter_method

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.

call_analytics_job.settings.vocabulary_filter_name

The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

call_analytics_job.settings.vocabulary_name

The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

call_analytics_job.start_time

The date and time the specified Call Analytics 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.

call_analytics_job.transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

Show child fields
call_analytics_job.transcript.redacted_transcript_file_uri

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.

call_analytics_job.transcript.transcript_file_uri

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.