[ aws . voice-id ]

start-speaker-enrollment-job

Description

Starts a new batch speaker enrollment job using specified details.

See also: AWS API Documentation

Synopsis

  start-speaker-enrollment-job
[--client-token <value>]
--data-access-role-arn <value>
--domain-id <value>
[--enrollment-config <value>]
--input-data-config <value>
[--job-name <value>]
--output-data-config <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

--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 Batch enrollment using audio data from prior calls for the permissions needed in this role.

--domain-id (string)

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

--enrollment-config (structure)

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.

ExistingEnrollmentAction -> (string)

The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP , which skips the enrollment for the existing speaker. Setting the value to OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.

FraudDetectionConfig -> (structure)

The fraud detection configuration to use for the speaker enrollment job.

FraudDetectionAction -> (string)

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL , which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

RiskThreshold -> (integer)

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

Shorthand Syntax:

ExistingEnrollmentAction=string,FraudDetectionConfig={FraudDetectionAction=string,RiskThreshold=integer}

JSON Syntax:

{
  "ExistingEnrollmentAction": "SKIP"|"OVERWRITE",
  "FraudDetectionConfig": {
    "FraudDetectionAction": "IGNORE"|"FAIL",
    "RiskThreshold": integer
  }
}

--input-data-config (structure)

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

S3Uri -> (string)

The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

Shorthand Syntax:

S3Uri=string

JSON Syntax:

{
  "S3Uri": "string"
}

--job-name (string)

A name for your speaker enrollment job.

--output-data-config (structure)

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.

KmsKeyId -> (string)

The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.

S3Uri -> (string)

The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder , the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out .

Shorthand Syntax:

KmsKeyId=string,S3Uri=string

JSON Syntax:

{
  "KmsKeyId": "string",
  "S3Uri": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Job -> (structure)

Details about the started speaker enrollment job.

CreatedAt -> (timestamp)

A timestamp showing the creation of the speaker enrollment job.

DataAccessRoleArn -> (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.

DomainId -> (string)

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

EndedAt -> (timestamp)

A timestamp showing when the speaker enrollment job ended.

EnrollmentConfig -> (structure)

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

ExistingEnrollmentAction -> (string)

The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP , which skips the enrollment for the existing speaker. Setting the value to OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.

FraudDetectionConfig -> (structure)

The fraud detection configuration to use for the speaker enrollment job.

FraudDetectionAction -> (string)

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL , which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

RiskThreshold -> (integer)

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

FailureDetails -> (structure)

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.

Message -> (string)

A description of the error that caused the batch job failure.

StatusCode -> (integer)

An HTTP status code representing the nature of the error.

InputDataConfig -> (structure)

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

S3Uri -> (string)

The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

JobId -> (string)

The service-generated identifier for the speaker enrollment job.

JobName -> (string)

The client-provided name for the speaker enrollment job.

JobProgress -> (structure)

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

PercentComplete -> (integer)

Shows the completed percentage of enrollment or registration requests listed in the input file.

JobStatus -> (string)

The current status of the speaker enrollment job.

OutputDataConfig -> (structure)

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.

KmsKeyId -> (string)

The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.

S3Uri -> (string)

The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder , the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out .