TranscribeService / Client / list_call_analytics_jobs

list_call_analytics_jobs#

TranscribeService.Client.list_call_analytics_jobs(**kwargs)#

Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

To get detailed information about a specific Call Analytics job, use the operation.

See also: AWS API Documentation

Request Syntax

response = client.list_call_analytics_jobs(
    Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    JobNameContains='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Status (string) – 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 Status, all Call Analytics jobs are returned.

  • JobNameContains (string) – Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

  • NextToken (string) – If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    'NextToken': 'string',
    'CallAnalyticsJobSummaries': [
        {
            'CallAnalyticsJobName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
            'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
            'CallAnalyticsJobDetails': {
                'Skipped': [
                    {
                        'Feature': 'GENERATIVE_SUMMARIZATION',
                        'ReasonCode': 'INSUFFICIENT_CONVERSATION_CONTENT'|'FAILED_SAFETY_GUIDELINES',
                        'Message': 'string'
                    },
                ]
            },
            'FailureReason': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Status (string) –

      Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

    • NextToken (string) –

      If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • CallAnalyticsJobSummaries (list) –

      Provides a summary of information about each result.

      • (dict) –

        Provides detailed information about a specific Call Analytics job.

        • CallAnalyticsJobName (string) –

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

        • CreationTime (datetime) –

          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.

        • StartTime (datetime) –

          The date and time your 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.

        • CompletionTime (datetime) –

          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.

        • LanguageCode (string) –

          The language code used to create your Call Analytics transcription.

        • CallAnalyticsJobStatus (string) –

          Provides the status of your 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.

        • CallAnalyticsJobDetails (dict) –

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

          • Skipped (list) –

            Contains information about any skipped analytics features during the analysis of a call analytics job.

            This array lists all the analytics features that were skipped, along with their corresponding reason code and message.

            • (dict) –

              Represents a skipped analytics feature during the analysis of a call analytics job.

              The Feature field indicates the type of analytics feature that was skipped.

              The Message field contains additional information or a message explaining why the analytics feature was skipped.

              The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.

              • Feature (string) –

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

              • ReasonCode (string) –

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

              • Message (string) –

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

        • FailureReason (string) –

          If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Exceptions

  • TranscribeService.Client.exceptions.BadRequestException

  • TranscribeService.Client.exceptions.LimitExceededException

  • TranscribeService.Client.exceptions.InternalFailureException