Class: Aws::VoiceID::Types::StartSpeakerEnrollmentJobRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:job_name]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String)


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :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. Refer to [Batch enrollment using audio data from prior calls] for the permissions needed in this role.

[1]: docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html

Returns:

  • (String)


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :output_data_config)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#domain_idString

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

Returns:

  • (String)


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :output_data_config)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#enrollment_configTypes::EnrollmentConfig

The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.



2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :output_data_config)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :output_data_config)
  SENSITIVE = [:job_name]
  include Aws::Structure
end

#job_nameString

A name for your speaker enrollment job.

Returns:

  • (String)


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :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.



2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/aws-sdk-voiceid/types.rb', line 2073

class StartSpeakerEnrollmentJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :enrollment_config,
  :input_data_config,
  :job_name,
  :output_data_config)
  SENSITIVE = [:job_name]
  include Aws::Structure
end