Class: Aws::VoiceID::Types::StartFraudsterRegistrationJobRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:job_name]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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) 


1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

class StartFraudsterRegistrationJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :input_data_config,
  :job_name,
  :output_data_config,
  :registration_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. Refer to the [Create and edit a fraudster watchlist] documentation for the permissions needed in this role.

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

Returns:

  • (String) 


1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

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

#domain_id ⇒ String

The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.

Returns:

  • (String) 


1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

class StartFraudsterRegistrationJobRequest < Struct.new(
  :client_token,
  :data_access_role_arn,
  :domain_id,
  :input_data_config,
  :job_name,
  :output_data_config,
  :registration_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 fraudster registration requests.

Returns:



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

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

#job_name ⇒ String

The name of the new fraudster registration job.

Returns:

  • (String) 


1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

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



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

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

#registration_config ⇒ Types::RegistrationConfig

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

Returns:



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/aws-sdk-voiceid/types.rb', line 1995

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