You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.VoiceID

Inherits:
AWS.Service show all
Identifier:
voiceid
API Version:
2021-09-27
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.

Sending a Request Using VoiceID

var voiceid = new AWS.VoiceID();
voiceid.createDomain(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the VoiceID object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var voiceid = new AWS.VoiceID({apiVersion: '2021-09-27'});

You can also set the API version globally in AWS.config.apiVersions using the voiceid service identifier:

AWS.config.apiVersions = {
  voiceid: '2021-09-27',
  // other service API versions
};

var voiceid = new AWS.VoiceID();

Version:

  • 2021-09-27

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.VoiceID(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a VoiceID object

var voiceid = new AWS.VoiceID({apiVersion: '2021-09-27'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.VoiceID.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.VoiceID.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.VoiceID.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createDomain(params = {}, callback) ⇒ AWS.Request

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ServerSideEncryptionConfiguration: { /* required */
    KmsKeyId: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
voiceid.createDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      A brief description of this domain.

    • Name — (String)

      The name of the domain.

    • ServerSideEncryptionConfiguration — (map)

      The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect VoiceID encryption at rest for more details on how the KMS Key is used.

      • KmsKeyId — required — (String)

        The identifier of the KMS Key you want Voice ID to use to encrypt your data.

    • Tags — (Array<map>)

      A list of tags you want added to the domain.

      • Key — required — (String)

        The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.

      • Value — required — (String)

        The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Domain — (map)

        Information about the newly created domain.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the domain.

        • CreatedAt — (Date)

          The timestamp at which the domain is created.

        • Description — (String)

          The client-provided description of the domain.

        • DomainId — (String)

          The service-generated identifier for the domain.

        • DomainStatus — (String)

          The current status of the domain.

          Possible values include:
          • "ACTIVE"
          • "PENDING"
          • "SUSPENDED"
        • Name — (String)

          The client-provided name for the domain.

        • ServerSideEncryptionConfiguration — (map)

          The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.

          • KmsKeyId — required — (String)

            The identifier of the KMS Key you want Voice ID to use to encrypt your data.

        • UpdatedAt — (Date)

          The timestamp showing the domain's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDomain(params = {}, callback) ⇒ AWS.Request

Deletes the specified domain from the Amazon Connect Voice ID system.

Service Reference:

Examples:

Calling the deleteDomain operation

var params = {
  DomainId: 'STRING_VALUE' /* required */
};
voiceid.deleteDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFraudster(params = {}, callback) ⇒ AWS.Request

Deletes the specified fraudster from the Amazon Connect Voice ID system.

Service Reference:

Examples:

Calling the deleteFraudster operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  FraudsterId: 'STRING_VALUE' /* required */
};
voiceid.deleteFraudster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the fraudster.

    • FraudsterId — (String)

      The identifier of the fraudster you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSpeaker(params = {}, callback) ⇒ AWS.Request

Deletes the specified speaker from the Amazon Connect Voice ID system.

Service Reference:

Examples:

Calling the deleteSpeaker operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  SpeakerId: 'STRING_VALUE' /* required */
};
voiceid.deleteSpeaker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the speaker.

    • SpeakerId — (String)

      The identifier of the speaker you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDomain(params = {}, callback) ⇒ AWS.Request

Describes the specified domain.

Service Reference:

Examples:

Calling the describeDomain operation

var params = {
  DomainId: 'STRING_VALUE' /* required */
};
voiceid.describeDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain you are describing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Domain — (map)

        Information about the specified domain.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the domain.

        • CreatedAt — (Date)

          The timestamp at which the domain is created.

        • Description — (String)

          The client-provided description of the domain.

        • DomainId — (String)

          The service-generated identifier for the domain.

        • DomainStatus — (String)

          The current status of the domain.

          Possible values include:
          • "ACTIVE"
          • "PENDING"
          • "SUSPENDED"
        • Name — (String)

          The client-provided name for the domain.

        • ServerSideEncryptionConfiguration — (map)

          The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.

          • KmsKeyId — required — (String)

            The identifier of the KMS Key you want Voice ID to use to encrypt your data.

        • UpdatedAt — (Date)

          The timestamp showing the domain's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFraudster(params = {}, callback) ⇒ AWS.Request

Describes the specified fraudster.

Service Reference:

Examples:

Calling the describeFraudster operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  FraudsterId: 'STRING_VALUE' /* required */
};
voiceid.describeFraudster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the fraudster.

    • FraudsterId — (String)

      The identifier of the fraudster you are describing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fraudster — (map)

        Information about the specified fraudster.

        • CreatedAt — (Date)

          The timestamp when Voice ID identified the fraudster.

        • DomainId — (String)

          The identifier for the domain containing the fraudster.

        • GeneratedFraudsterId — (String)

          The service-generated identifier for the fraudster.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFraudsterRegistrationJob(params = {}, callback) ⇒ AWS.Request

Describes the specified fraudster registration job.

Service Reference:

Examples:

Calling the describeFraudsterRegistrationJob operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
voiceid.describeFraudsterRegistrationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier for the domain containing the fraudster registration job.

    • JobId — (String)

      The identifier for the fraudster registration job you are describing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Job — (map)

        Contains details about the specified fraudster registration job.

        • CreatedAt — (Date)

          A timestamp showing the creation time of the fraudster registration 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 containing the fraudster registration job.

        • EndedAt — (Date)

          A timestamp showing when the fraudster registration job ended.

        • FailureDetails — (map)

          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 — (map)

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

          • S3Uri — required — (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 fraudster registration job.

        • JobName — (String)

          The client-provied name for the fraudster registration job.

        • JobProgress — (map)

          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 fraudster registration job.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
        • OutputDataConfig — (map)

          The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS Key ID in order to encrypt the file.

          • KmsKeyId — (String)

            the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.

          • S3Uri — required — (String)

            The S3 path of the folder to which Voice ID writes the job output file, which 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.

        • RegistrationConfig — (map)

          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.

          • DuplicateRegistrationAction — (String)

            The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.

            Possible values include:
            • "SKIP"
            • "REGISTER_AS_NEW"
          • FraudsterSimilarityThreshold — (Integer)

            The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpeaker(params = {}, callback) ⇒ AWS.Request

Describes the specified speaker.

Service Reference:

Examples:

Calling the describeSpeaker operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  SpeakerId: 'STRING_VALUE' /* required */
};
voiceid.describeSpeaker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain that contains the speaker.

    • SpeakerId — (String)

      The identifier of the speaker you are describing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Speaker — (map)

        Information about the specified speaker.

        • CreatedAt — (Date)

          A timestamp showing when the speaker is created.

        • CustomerSpeakerId — (String)

          The client-provided identifier for the speaker.

        • DomainId — (String)

          The identifier of the domain that contains the speaker.

        • GeneratedSpeakerId — (String)

          The service-generated identifier for the speaker.

        • Status — (String)

          The current status of the speaker.

          Possible values include:
          • "ENROLLED"
          • "EXPIRED"
          • "OPTED_OUT"
          • "PENDING"
        • UpdatedAt — (Date)

          A timestamp showing the speaker's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSpeakerEnrollmentJob(params = {}, callback) ⇒ AWS.Request

Describes the specified speaker enrollment job.

Service Reference:

Examples:

Calling the describeSpeakerEnrollmentJob operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
voiceid.describeSpeakerEnrollmentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the speaker enrollment job.

    • JobId — (String)

      The identifier of the speaker enrollment job you are describing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Job — (map)

        Contains details about the specified speaker enrollment job.

        • CreatedAt — (Date)

          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 — (Date)

          A timestamp showing when the speaker enrollment job ended.

        • EnrollmentConfig — (map)

          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.

            Possible values include:
            • "SKIP"
            • "OVERWRITE"
          • FraudDetectionConfig — (map)

            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.

              Possible values include:
              • "IGNORE"
              • "FAIL"
            • 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 — (map)

          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 — (map)

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

          • S3Uri — required — (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 — (map)

          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.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
        • OutputDataConfig — (map)

          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 the fraudster registration job.

          • S3Uri — required — (String)

            The S3 path of the folder to which Voice ID writes the job output file, which 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

evaluateSession(params = {}, callback) ⇒ AWS.Request

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Service Reference:

Examples:

Calling the evaluateSession operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  SessionNameOrId: 'STRING_VALUE' /* required */
};
voiceid.evaluateSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain where the session started.

    • SessionNameOrId — (String)

      The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationResult — (map)

        Details resulting from the authentication process, such as authentication decision and authentication score.

        • AudioAggregationEndedAt — (Date)

          A timestamp indicating when audio aggregation ended for this authentication result.

        • AudioAggregationStartedAt — (Date)

          A timestamp indicating when audio aggregation started for this authentication result.

        • AuthenticationResultId — (String)

          The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

        • Configuration — (map)

          The AuthenticationConfiguration used to generate this authentication result.

          • AcceptanceThreshold — required — (Integer)

            The minimum threshold needed to successfully authenticate a speaker.

        • CustomerSpeakerId — (String)

          The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

        • Decision — (String)

          The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

          Possible values include:
          • "ACCEPT"
          • "REJECT"
          • "NOT_ENOUGH_SPEECH"
          • "SPEAKER_NOT_ENROLLED"
          • "SPEAKER_OPTED_OUT"
          • "SPEAKER_ID_NOT_PROVIDED"
        • GeneratedSpeakerId — (String)

          The service-generated identifier for the speaker whose authentication result is produced.

        • Score — (Integer)

          The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.

      • DomainId — (String)

        The identifier of the domain containing the session.

      • FraudDetectionResult — (map)

        Details resulting from the fraud detection process, such as fraud detection decision and risk score.

        • AudioAggregationEndedAt — (Date)

          A timestamp indicating when audio aggregation ended for this fraud detection result.

        • AudioAggregationStartedAt — (Date)

          A timestamp indicating when audio aggregation started for this fraud detection result.

        • Configuration — (map)

          The FraudDetectionConfiguration used to generate this fraud detection result.

          • RiskThreshold — required — (Integer)

            Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.

        • Decision — (String)

          The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

          Possible values include:
          • "HIGH_RISK"
          • "LOW_RISK"
          • "NOT_ENOUGH_SPEECH"
        • FraudDetectionResultId — (String)

          The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

        • Reasons — (Array<String>)

          The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and only has one possible value: KNOWN_FRAUDSTER.

        • RiskDetails — (map)

          Details about each risk analyzed for this speaker.

          • KnownFraudsterRisk — required — (map)

            The details resulting from 'Known Fraudster Risk' analysis of the speaker.

            • GeneratedFraudsterId — (String)

              The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is null.

            • RiskScore — required — (Integer)

              The score indicating the likelihood the speaker is a known fraudster.

      • SessionId — (String)

        The service-generated identifier of the session.

      • SessionName — (String)

        The client-provided name of the session.

      • StreamingStatus — (String)

        The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

        Possible values include:
        • "PENDING_CONFIGURATION"
        • "ONGOING"
        • "ENDED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDomains(params = {}, callback) ⇒ AWS.Request

Lists all the domains in the Amazon Web Services account.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
voiceid.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DomainSummaries — (Array<map>)

        A list containing details about each domain in the Amazon Web Services account.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the domain.

        • CreatedAt — (Date)

          The timestamp showing when the domain is created.

        • Description — (String)

          The client-provided description of the domain.

        • DomainId — (String)

          The service-generated identifier for the domain.

        • DomainStatus — (String)

          The current status of the domain.

          Possible values include:
          • "ACTIVE"
          • "PENDING"
          • "SUSPENDED"
        • Name — (String)

          The client-provided name for the domain.

        • ServerSideEncryptionConfiguration — (map)

          The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..

          • KmsKeyId — required — (String)

            The identifier of the KMS Key you want Voice ID to use to encrypt your data.

        • UpdatedAt — (Date)

          The timestamp showing the domain's last update.

      • NextToken — (String)

        If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listFraudsterRegistrationJobs(params = {}, callback) ⇒ AWS.Request

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

Service Reference:

Examples:

Calling the listFraudsterRegistrationJobs operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
voiceid.listFraudsterRegistrationJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the fraudster registration Jobs.

    • JobStatus — (String)

      Provides the status of your fraudster registration job.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "COMPLETED_WITH_ERRORS"
      • "FAILED"
    • MaxResults — (Integer)

      The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobSummaries — (Array<map>)

        A list containing details about each specified fraudster registration job.

        • CreatedAt — (Date)

          A timestamp showing when the fraudster registration job is created.

        • DomainId — (String)

          The identifier of the domain containing the fraudster registration job.

        • EndedAt — (Date)

          A timestamp showing when the fraudster registration job ended.

        • FailureDetails — (map)

          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.

        • JobId — (String)

          The service-generated identifier for the fraudster registration job.

        • JobName — (String)

          The client-provied name for the fraudster registration job.

        • JobProgress — (map)

          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 fraudster registration job.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
      • NextToken — (String)

        If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSpeakerEnrollmentJobs(params = {}, callback) ⇒ AWS.Request

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

Service Reference:

Examples:

Calling the listSpeakerEnrollmentJobs operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
voiceid.listSpeakerEnrollmentJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the speaker enrollment jobs.

    • JobStatus — (String)

      Provides the status of your speaker enrollment Job.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "COMPLETED_WITH_ERRORS"
      • "FAILED"
    • MaxResults — (Integer)

      The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobSummaries — (Array<map>)

        A list containing details about each specified speaker enrollment job.

        • CreatedAt — (Date)

          A timestamp showing the creation time of the speaker enrollment job.

        • DomainId — (String)

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

        • EndedAt — (Date)

          A timestamp showing when the speaker enrollment job ended.

        • FailureDetails — (map)

          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.

        • JobId — (String)

          The service-generated identifier for the speaker enrollment job.

        • JobName — (String)

          The client-provided name for the speaker enrollment job.

        • JobProgress — (map)

          Provides details regarding job progress. This field shows the completed percentage of enrollment 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.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
      • NextToken — (String)

        If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSpeakers(params = {}, callback) ⇒ AWS.Request

Lists all speakers in a specified domain.

Service Reference:

Examples:

Calling the listSpeakers operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
voiceid.listSpeakers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain.

    • MaxResults — (Integer)

      The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

      • SpeakerSummaries — (Array<map>)

        A list containing details about each speaker in the Amazon Web Services account.

        • CreatedAt — (Date)

          A timestamp showing the speaker's creation time.

        • CustomerSpeakerId — (String)

          The client-provided identifier for the speaker.

        • DomainId — (String)

          The identifier of the domain that contains the speaker.

        • GeneratedSpeakerId — (String)

          The service-generated identifier for the speaker.

        • Status — (String)

          The current status of the speaker.

          Possible values include:
          • "ENROLLED"
          • "EXPIRED"
          • "OPTED_OUT"
          • "PENDING"
        • UpdatedAt — (Date)

          A timestamp showing the speaker's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags associated with a specified Voice ID resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
voiceid.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The list of tags associated with the specified resource.

        • Key — required — (String)

          The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.

        • Value — required — (String)

          The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

optOutSpeaker(params = {}, callback) ⇒ AWS.Request

Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system.

Service Reference:

Examples:

Calling the optOutSpeaker operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  SpeakerId: 'STRING_VALUE' /* required */
};
voiceid.optOutSpeaker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainId — (String)

      The identifier of the domain containing the speaker.

    • SpeakerId — (String)

      The identifier of the speaker you want opted-out.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Speaker — (map)

        Details about the opted-out speaker.

        • CreatedAt — (Date)

          A timestamp showing when the speaker is created.

        • CustomerSpeakerId — (String)

          The client-provided identifier for the speaker.

        • DomainId — (String)

          The identifier of the domain that contains the speaker.

        • GeneratedSpeakerId — (String)

          The service-generated identifier for the speaker.

        • Status — (String)

          The current status of the speaker.

          Possible values include:
          • "ENROLLED"
          • "EXPIRED"
          • "OPTED_OUT"
          • "PENDING"
        • UpdatedAt — (Date)

          A timestamp showing the speaker's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startFraudsterRegistrationJob(params = {}, callback) ⇒ AWS.Request

Starts a new batch fraudster registration job using provided details.

Service Reference:

Examples:

Calling the startFraudsterRegistrationJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DomainId: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  RegistrationConfig: {
    DuplicateRegistrationAction: SKIP | REGISTER_AS_NEW,
    FraudsterSimilarityThreshold: 'NUMBER_VALUE'
  }
};
voiceid.startFraudsterRegistrationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

    • DomainId — (String)

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

    • InputDataConfig — (map)

      The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.

      • S3Uri — required — (String)

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

    • JobName — (String)

      The name of the new fraudster registration job.

    • OutputDataConfig — (map)

      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 the fraudster registration job.

      • S3Uri — required — (String)

        The S3 path of the folder to which Voice ID writes the job output file, which 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.

    • RegistrationConfig — (map)

      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.

      • DuplicateRegistrationAction — (String)

        The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.

        Possible values include:
        • "SKIP"
        • "REGISTER_AS_NEW"
      • FraudsterSimilarityThreshold — (Integer)

        The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Job — (map)

        Details about the started fraudster registration job.

        • CreatedAt — (Date)

          A timestamp showing the creation time of the fraudster registration 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 containing the fraudster registration job.

        • EndedAt — (Date)

          A timestamp showing when the fraudster registration job ended.

        • FailureDetails — (map)

          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 — (map)

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

          • S3Uri — required — (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 fraudster registration job.

        • JobName — (String)

          The client-provied name for the fraudster registration job.

        • JobProgress — (map)

          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 fraudster registration job.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
        • OutputDataConfig — (map)

          The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS Key ID in order to encrypt the file.

          • KmsKeyId — (String)

            the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.

          • S3Uri — required — (String)

            The S3 path of the folder to which Voice ID writes the job output file, which 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.

        • RegistrationConfig — (map)

          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.

          • DuplicateRegistrationAction — (String)

            The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.

            Possible values include:
            • "SKIP"
            • "REGISTER_AS_NEW"
          • FraudsterSimilarityThreshold — (Integer)

            The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startSpeakerEnrollmentJob(params = {}, callback) ⇒ AWS.Request

Starts a new batch speaker enrollment job using specified details.

Service Reference:

Examples:

Calling the startSpeakerEnrollmentJob operation

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DomainId: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  EnrollmentConfig: {
    ExistingEnrollmentAction: SKIP | OVERWRITE,
    FraudDetectionConfig: {
      FraudDetectionAction: IGNORE | FAIL,
      RiskThreshold: 'NUMBER_VALUE'
    }
  },
  JobName: 'STRING_VALUE'
};
voiceid.startSpeakerEnrollmentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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. Refer to Batch enrollment using audio data from prior calls documentation for the permissions needed in this role.

    • DomainId — (String)

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

    • EnrollmentConfig — (map)

      The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system 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.

        Possible values include:
        • "SKIP"
        • "OVERWRITE"
      • FraudDetectionConfig — (map)

        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.

          Possible values include:
          • "IGNORE"
          • "FAIL"
        • 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.

    • InputDataConfig — (map)

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

      • S3Uri — required — (String)

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

    • JobName — (String)

      A name for your speaker enrollment job.

    • OutputDataConfig — (map)

      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 the fraudster registration job.

      • S3Uri — required — (String)

        The S3 path of the folder to which Voice ID writes the job output file, which 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Job — (map)

        Details about the started speaker enrollment job.

        • CreatedAt — (Date)

          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 — (Date)

          A timestamp showing when the speaker enrollment job ended.

        • EnrollmentConfig — (map)

          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.

            Possible values include:
            • "SKIP"
            • "OVERWRITE"
          • FraudDetectionConfig — (map)

            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.

              Possible values include:
              • "IGNORE"
              • "FAIL"
            • 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 — (map)

          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 — (map)

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

          • S3Uri — required — (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 — (map)

          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.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "COMPLETED_WITH_ERRORS"
          • "FAILED"
        • OutputDataConfig — (map)

          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 the fraudster registration job.

          • S3Uri — required — (String)

            The S3 path of the folder to which Voice ID writes the job output file, which 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags an Amazon Connect Voice ID resource with the provided list of tags.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
voiceid.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.

    • Tags — (Array<map>)

      The list of tags to assign to the specified resource.

      • Key — required — (String)

        The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.

      • Value — required — (String)

        The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes specified tags from a specified Amazon Connect Voice ID resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
voiceid.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.

    • TagKeys — (Array<String>)

      The list of tag keys you want to remove from the specified resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDomain(params = {}, callback) ⇒ AWS.Request

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

Service Reference:

Examples:

Calling the updateDomain operation

var params = {
  DomainId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ServerSideEncryptionConfiguration: { /* required */
    KmsKeyId: 'STRING_VALUE' /* required */
  },
  Description: 'STRING_VALUE'
};
voiceid.updateDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A brief description about this domain.

    • DomainId — (String)

      The identifier of the domain to be updated.

    • Name — (String)

      The name of the domain.

    • ServerSideEncryptionConfiguration — (map)

      The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key.

      • KmsKeyId — required — (String)

        The identifier of the KMS Key you want Voice ID to use to encrypt your data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Domain — (map)

        Details about the updated domain

        • Arn — (String)

          The Amazon Resource Name (ARN) for the domain.

        • CreatedAt — (Date)

          The timestamp at which the domain is created.

        • Description — (String)

          The client-provided description of the domain.

        • DomainId — (String)

          The service-generated identifier for the domain.

        • DomainStatus — (String)

          The current status of the domain.

          Possible values include:
          • "ACTIVE"
          • "PENDING"
          • "SUSPENDED"
        • Name — (String)

          The client-provided name for the domain.

        • ServerSideEncryptionConfiguration — (map)

          The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.

          • KmsKeyId — required — (String)

            The identifier of the KMS Key you want Voice ID to use to encrypt your data.

        • UpdatedAt — (Date)

          The timestamp showing the domain's last update.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.