Class: Aws::VoiceID::Types::SpeakerEnrollmentJob

Inherits:

Struct

• Object
• Struct
• Aws::VoiceID::Types::SpeakerEnrollmentJob

Includes:

Structure

Defined in:

lib/aws-sdk-voiceid/types.rb

Overview

Contains all the information about a speaker enrollment job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:job_name]

Instance Attribute Summary

• #created_at ⇒ Time

  A timestamp of when the speaker enrollment job was created.

• #data_access_role_arn ⇒ String

  The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer’s buckets to read the input manifest file and write the job output file.

• #domain_id ⇒ String

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

• #ended_at ⇒ Time

  A timestamp of when the speaker enrollment job ended.

• #enrollment_config ⇒ Types::EnrollmentConfig

  The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the ‘FraudDetectionConfig` to use.

• #failure_details ⇒ Types::FailureDetails

  Contains details that are populated when an entire batch job fails.

• #input_data_config ⇒ Types::InputDataConfig

  The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

• #job_id ⇒ String

  The service-generated identifier for the speaker enrollment job.

• #job_name ⇒ String

  The client-provided name for the speaker enrollment job.

• #job_progress ⇒ Types::JobProgress

  Provides details on job progress.

• #job_status ⇒ String

  The current status of the speaker enrollment job.

• #output_data_config ⇒ Types::OutputDataConfig

  The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

Instance Attribute Details

#created_at ⇒ Time

A timestamp of when the speaker enrollment job was created.

Returns:

• (Time)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#data_access_role_arn ⇒ String

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer’s buckets to read the input manifest file and write the job output file.

Returns:

• (String)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#domain_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#ended_at ⇒ Time

A timestamp of when the speaker enrollment job ended.

Returns:

• (Time)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#enrollment_config ⇒ Types::EnrollmentConfig

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the ‘FraudDetectionConfig` to use.

Returns:

• (Types::EnrollmentConfig)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

class SpeakerEnrollmentJob < Struct.new(
  :created_at,
  :data_access_role_arn,
  :domain_id,
  :ended_at,
  :enrollment_config,
  :failure_details,
  :input_data_config,
  :job_id,
  :job_name,
  :job_progress,
  :job_status,
  :output_data_config)
  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:

• (Types::FailureDetails)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#input_data_config ⇒ Types::InputDataConfig

The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

Returns:

• (Types::InputDataConfig)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#job_id ⇒ String

The service-generated identifier for the speaker enrollment job.

Returns:

• (String)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#job_name ⇒ String

The client-provided name for the speaker enrollment job.

Returns:

• (String)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#job_progress ⇒ Types::JobProgress

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

Returns:

• (Types::JobProgress)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#job_status ⇒ String

The current status of the speaker enrollment job.

Returns:

• (String)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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

#output_data_config ⇒ Types::OutputDataConfig

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

Returns:

• (Types::OutputDataConfig)

# File 'lib/aws-sdk-voiceid/types.rb', line 1822

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