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

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

Overview

Contains all the information about a speaker enrollment job.

Constant Summary collapse

SENSITIVE =
[:job_name]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

A timestamp showing the creation of the speaker enrollment job.

Returns:

  • (Time)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_arnString

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)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_idString

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

Returns:

  • (String)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_atTime

A timestamp showing when the speaker enrollment job ended.

Returns:

  • (Time)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_configTypes::EnrollmentConfig

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



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_detailsTypes::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.



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_configTypes::InputDataConfig

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



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_idString

The service-generated identifier for the speaker enrollment job.

Returns:

  • (String)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_nameString

The client-provided name for the speaker enrollment job.

Returns:

  • (String)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_progressTypes::JobProgress

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

Returns:



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_statusString

The current status of the speaker enrollment job.

Returns:

  • (String)


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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_configTypes::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.



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 1661

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