Class: Aws::TranscribeService::Types::CallAnalyticsJobSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

Provides detailed information about a specific Call Analytics job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#call_analytics_job_nameString

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

Returns:

  • (String)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#call_analytics_job_statusString

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.

Returns:

  • (String)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#completion_timeTime

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.

Returns:

  • (Time)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

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.

Returns:

  • (Time)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasonString

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

[1]: docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html

Returns:

  • (String)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language code used to create your Call Analytics transcription.

Returns:

  • (String)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

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.

Returns:

  • (Time)


445
446
447
448
449
450
451
452
453
454
455
# File 'lib/aws-sdk-transcribeservice/types.rb', line 445

class CallAnalyticsJobSummary < Struct.new(
  :call_analytics_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :call_analytics_job_status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end