Class: AWS.VoiceID

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)

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

    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 Voice ID encryption at rest for more details on how the KMS key is used.

    • KmsKeyId — required — (String)

      The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

  • 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 of when the domain was created.

      • Description — (String)

        The description of the domain.

      • DomainId — (String)

        The identifier of the domain.

      • DomainStatus — (String)

        The current status of the domain.

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

        The 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 to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

      • ServerSideEncryptionUpdateDetails — (map)

        Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

        • Message — (String)

          Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

        • OldKmsKeyId — (String)

          The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

        • UpdateStatus — (String)

          Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
      • UpdatedAt — (Date)

        The timestamp of when the domain was last update.

      • WatchlistDetails — (map)

        The watchlist details of a domain. Contains the default watchlist ID of the domain.

        • DefaultWatchlistId — required — (String)

          The identifier of the default watchlist.

Returns:

• (AWS.Request) —

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

var params = {
  DomainId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
voiceid.createWatchlist(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)

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

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

    A brief description of this watchlist.

  • DomainId — (String)

    The identifier of the domain that contains the watchlist.

  • Name — (String)

    The name of the watchlist.

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:

    • Watchlist — (map)

      Information about the newly created watchlist.

      • CreatedAt — (Date)

        The timestamp of when the watchlist was created.

      • DefaultWatchlist — (Boolean)

        Whether the specified watchlist is the default watchlist of a domain.

      • Description — (String)

        The description of the watchlist.

      • DomainId — (String)

        The identifier of the domain that contains the watchlist.

      • Name — (String)

        The name for the watchlist.

      • UpdatedAt — (Date)

        The timestamp of when the watchlist was updated.

      • WatchlistId — (String)

        The identifier of the watchlist.

Returns:

• (AWS.Request) —

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

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.

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 that contains 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.

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 that contains 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.

var params = {
  DomainId: 'STRING_VALUE', /* required */
  WatchlistId: 'STRING_VALUE' /* required */
};
voiceid.deleteWatchlist(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 watchlist.

  • WatchlistId — (String)

    The identifier of the watchlist to be deleted.

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.

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 that 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 of when the domain was created.

      • Description — (String)

        The description of the domain.

      • DomainId — (String)

        The identifier of the domain.

      • DomainStatus — (String)

        The current status of the domain.

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

        The 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 to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

      • ServerSideEncryptionUpdateDetails — (map)

        Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

        • Message — (String)

          Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

        • OldKmsKeyId — (String)

          The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

        • UpdateStatus — (String)

          Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
      • UpdatedAt — (Date)

        The timestamp of when the domain was last update.

      • WatchlistDetails — (map)

        The watchlist details of a domain. Contains the default watchlist ID of the domain.

        • DefaultWatchlistId — required — (String)

          The identifier of the default watchlist.

Returns:

• (AWS.Request) —

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

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 that contains 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 of when Voice ID identified the fraudster.

      • DomainId — (String)

        The identifier of the domain that contains the fraudster.

      • GeneratedFraudsterId — (String)

        The service-generated identifier for the fraudster.

      • WatchlistIds — (Array<String>)

        The identifier of the watchlists the fraudster is a part of.

Returns:

• (AWS.Request) —

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

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 of the domain that contains the fraudster registration job.

  • JobId — (String)

    The identifier of 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 of when the fraudster registration job was created.

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

      • EndedAt — (Date)

        A timestamp of 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-provided 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 a speaker enrollment job/fraudster registration job.

        • S3Uri — required — (String)

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

      • 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.

        • WatchlistIds — (Array<String>)

          The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.

Returns:

• (AWS.Request) —

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

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 of when the speaker was 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.

      • LastAccessedAt — (Date)

        The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

      • Status — (String)

        The current status of the speaker.

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

        A timestamp of the speaker's last update.

Returns:

• (AWS.Request) —

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

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 that contains 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 of when the speaker enrollment job was created.

      • 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 of 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.

          • WatchlistIds — (Array<String>)

            The identifier of watchlists against which fraud detection is performed.

      • 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 a speaker enrollment job/fraudster registration job.

        • S3Uri — required — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  DomainId: 'STRING_VALUE', /* required */
  WatchlistId: 'STRING_VALUE' /* required */
};
voiceid.describeWatchlist(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 watchlist.

  • WatchlistId — (String)

    The identifier of the watchlist that 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:

    • Watchlist — (map)

      Information about the specified watchlist.

      • CreatedAt — (Date)

        The timestamp of when the watchlist was created.

      • DefaultWatchlist — (Boolean)

        Whether the specified watchlist is the default watchlist of a domain.

      • Description — (String)

        The description of the watchlist.

      • DomainId — (String)

        The identifier of the domain that contains the watchlist.

      • Name — (String)

        The name for the watchlist.

      • UpdatedAt — (Date)

        The timestamp of when the watchlist was updated.

      • WatchlistId — (String)

        The identifier of the watchlist.

Returns:

• (AWS.Request) —

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

var params = {
  DomainId: 'STRING_VALUE', /* required */
  FraudsterId: 'STRING_VALUE', /* required */
  WatchlistId: 'STRING_VALUE' /* required */
};
voiceid.disassociateFraudster(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 fraudster.

  • FraudsterId — (String)

    The identifier of the fraudster to be disassociated from the watchlist.

  • WatchlistId — (String)

    The identifier of the watchlist that you want to disassociate from the fraudster.

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)

      Contains all the information about a fraudster.

      • CreatedAt — (Date)

        The timestamp of when Voice ID identified the fraudster.

      • DomainId — (String)

        The identifier of the domain that contains the fraudster.

      • GeneratedFraudsterId — (String)

        The service-generated identifier for the fraudster.

      • WatchlistIds — (Array<String>)

        The identifier of the watchlists the fraudster is a part of.

Returns:

• (AWS.Request) —

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

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 of when audio aggregation ended for this authentication result.

      • AudioAggregationStartedAt — (Date)

        A timestamp of 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"
        • "SPEAKER_EXPIRED"
      • 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 that contains the session.

    • FraudDetectionResult — (map)

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

      • AudioAggregationEndedAt — (Date)

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

      • AudioAggregationStartedAt — (Date)

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

      • Configuration — (map)

        The FraudDetectionConfiguration used to generate this fraud detection result.

        • RiskThreshold — (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.

        • WatchlistId — (String)

          The identifier of the watchlist against which fraud detection is performed.

      • 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 the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

      • RiskDetails — (map)

        Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.

        • 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.

        • VoiceSpoofingRisk — required — (map)

          The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

          • RiskScore — required — (Integer)

            The score indicating the likelihood of speaker’s voice being spoofed.

    • 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, after 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.

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 more 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 of when the domain was created.

      • Description — (String)

        The description of the domain.

      • DomainId — (String)

        The identifier of 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 to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

      • ServerSideEncryptionUpdateDetails — (map)

        Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

        • Message — (String)

          Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

        • OldKmsKeyId — (String)

          The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

        • UpdateStatus — (String)

          Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
      • UpdatedAt — (Date)

        The timestamp of when the domain was last updated.

      • WatchlistDetails — (map)

        Provides information about watchlistDetails and DefaultWatchlistID.

        • DefaultWatchlistId — required — (String)

          The identifier of the default watchlist.

    • 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.

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 that contains 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 more 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 of when the fraudster registration job was created.

      • DomainId — (String)

        The identifier of the domain that contains the fraudster registration job.

      • EndedAt — (Date)

        A timestamp of 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-provided 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.

var params = {
  DomainId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WatchlistId: 'STRING_VALUE'
};
voiceid.listFraudsters(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 more 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.

  • WatchlistId — (String)

    The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.

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:

    • FraudsterSummaries — (Array<map>)

      A list that contains details about each fraudster in the Amazon Web Services account.

      • CreatedAt — (Date)

        The timestamp of when the fraudster summary was created.

      • DomainId — (String)

        The identifier of the domain that contains the fraudster summary.

      • GeneratedFraudsterId — (String)

        The service-generated identifier for the fraudster.

      • WatchlistIds — (Array<String>)

        The identifier of the watchlists the fraudster is a part of.

    • 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.

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 that contains 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 more 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 of when of the speaker enrollment job was created.

      • DomainId — (String)

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

      • EndedAt — (Date)

        A timestamp of 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.

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 more 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.

      • LastAccessedAt — (Date)

        The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

      • 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.

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.

var params = {
  DomainId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
voiceid.listWatchlists(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 more 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.

    • WatchlistSummaries — (Array<map>)

      A list that contains details about each watchlist in the Amazon Web Services account.

      • CreatedAt — (Date)

        The timestamp of when the watchlist was created.

      • DefaultWatchlist — (Boolean)

        Whether the specified watchlist is the default watchlist of a domain.

      • Description — (String)

        The description of the watchlist.

      • DomainId — (String)

        The identifier of the domain that contains the watchlist.

      • Name — (String)

        The name for the watchlist.

      • UpdatedAt — (Date)

        The timestamp of when the watchlist was last updated.

      • WatchlistId — (String)

        The identifier of the watchlist.

Returns:

• (AWS.Request) —

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

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 that contains 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 of when the speaker was 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.

      • LastAccessedAt — (Date)

        The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

      • Status — (String)

        The current status of the speaker.

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

        A timestamp of the speaker's last update.

Returns:

• (AWS.Request) —

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

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',
    WatchlistIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
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)

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

    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 that contains 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 a speaker enrollment job/fraudster registration job.

    • S3Uri — required — (String)

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

  • 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.

    • WatchlistIds — (Array<String>)

      The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.

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 of when the fraudster registration job was created.

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

      • EndedAt — (Date)

        A timestamp of 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-provided 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 a speaker enrollment job/fraudster registration job.

        • S3Uri — required — (String)

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

      • 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.

        • WatchlistIds — (Array<String>)

          The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.

Returns:

• (AWS.Request) —

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

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',
      WatchlistIds: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  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)

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

    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 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 Voice ID or when a speaker is identified as a fraudster.

    • ExistingEnrollmentAction — (String)

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

      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.

      • WatchlistIds — (Array<String>)

        The identifier of watchlists against which fraud detection is performed.

  • 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 a speaker enrollment job/fraudster registration job.

    • S3Uri — required — (String)

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

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 of when the speaker enrollment job was created.

      • 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 of 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.

          • WatchlistIds — (Array<String>)

            The identifier of watchlists against which fraud detection is performed.

      • 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 a speaker enrollment job/fraudster registration job.

        • S3Uri — required — (String)

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

Returns:

• (AWS.Request) —

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

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.

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.

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. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

    • KmsKeyId — required — (String)

      The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

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 of when the domain was created.

      • Description — (String)

        The description of the domain.

      • DomainId — (String)

        The identifier of the domain.

      • DomainStatus — (String)

        The current status of the domain.

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

        The 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 to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

      • ServerSideEncryptionUpdateDetails — (map)

        Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

        • Message — (String)

          Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

        • OldKmsKeyId — (String)

          The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

        • UpdateStatus — (String)

          Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
      • UpdatedAt — (Date)

        The timestamp of when the domain was last update.

      • WatchlistDetails — (map)

        The watchlist details of a domain. Contains the default watchlist ID of the domain.

        • DefaultWatchlistId — required — (String)

          The identifier of the default watchlist.

Returns:

• (AWS.Request) —

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

var params = {
  DomainId: 'STRING_VALUE', /* required */
  WatchlistId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
voiceid.updateWatchlist(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 watchlist.

  • DomainId — (String)

    The identifier of the domain that contains the watchlist.

  • Name — (String)

    The name of the watchlist.

  • WatchlistId — (String)

    The identifier of the watchlist to be updated.

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:

    • Watchlist — (map)

      Details about the updated watchlist.

      • CreatedAt — (Date)

        The timestamp of when the watchlist was created.

      • DefaultWatchlist — (Boolean)

        Whether the specified watchlist is the default watchlist of a domain.

      • Description — (String)

        The description of the watchlist.

      • DomainId — (String)

        The identifier of the domain that contains the watchlist.

      • Name — (String)

        The name for the watchlist.

      • UpdatedAt — (Date)

        The timestamp of when the watchlist was updated.

      • WatchlistId — (String)

        The identifier of the watchlist.

Returns:

• (AWS.Request) —

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