Class: Aws::VoiceID::Types::SpeakerEnrollmentJobSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb

Overview

Contains a summary of information about a speaker enrollment job.

See Also:

Constant Summary collapse

SENSITIVE = 
[:job_name]

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

A timestamp of when of the speaker enrollment job was created.

Returns:

  • (Time) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#domain_id ⇒ String

The identifier of the domain that contains the speaker enrollment job.

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#ended_at ⇒ Time

A timestamp of when the speaker enrollment job ended.

Returns:

  • (Time) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#failure_details ⇒ Types::FailureDetails

Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

Returns:



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#job_id ⇒ String

The service-generated identifier for the speaker enrollment job.

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#job_name ⇒ String

The client-provided name for the speaker enrollment job.

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#job_progress ⇒ Types::JobProgress

Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

Returns:



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#job_status ⇒ String

The current status of the speaker enrollment job.

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1882

class SpeakerEnrollmentJobSummary < Struct.new(
  :created_at,
  :domain_id,
  :ended_at,
  :failure_details,
  :job_id,
  :job_name,
  :job_progress,
  :job_status)
  SENSITIVE = [:job_name]
  include Aws::Structure
end