Package software.amazon.awssdk.services.voiceid.model

Interface SpeakerEnrollmentJob.Builder

    • Method Detail

      • createdAt

        SpeakerEnrollmentJob.Builder createdAt​(Instant createdAt)

        A timestamp of when the speaker enrollment job was created.

        Parameters:
        createdAt - A timestamp of when the speaker enrollment job was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

        SpeakerEnrollmentJob.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        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.

        Parameters:
        dataAccessRoleArn - 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:
        Returns a reference to this object so that method calls can be chained together.

      • domainId

        SpeakerEnrollmentJob.Builder domainId​(String domainId)

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

        Parameters:
        domainId - The identifier of the domain that contains the speaker enrollment job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endedAt

        SpeakerEnrollmentJob.Builder endedAt​(Instant endedAt)

        A timestamp of when the speaker enrollment job ended.

        Parameters:
        endedAt - A timestamp of when the speaker enrollment job ended.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enrollmentConfig

        SpeakerEnrollmentJob.Builder enrollmentConfig​(EnrollmentConfig enrollmentConfig)

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

        Parameters:
        enrollmentConfig - The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureDetails

        SpeakerEnrollmentJob.Builder failureDetails​(FailureDetails 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • inputDataConfig

        SpeakerEnrollmentJob.Builder inputDataConfig​(InputDataConfig inputDataConfig)

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

        Parameters:
        inputDataConfig - The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobId

        SpeakerEnrollmentJob.Builder jobId​(String jobId)

        The service-generated identifier for the speaker enrollment job.

        Parameters:
        jobId - The service-generated identifier for the speaker enrollment job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobName

        SpeakerEnrollmentJob.Builder jobName​(String jobName)

        The client-provided name for the speaker enrollment job.

        Parameters:
        jobName - The client-provided name for the speaker enrollment job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobProgress

        SpeakerEnrollmentJob.Builder jobProgress​(JobProgress jobProgress)

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

        Parameters:
        jobProgress - Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputDataConfig

        SpeakerEnrollmentJob.Builder outputDataConfig​(OutputDataConfig 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.