Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartFraudsterRegistrationJob

Starts a new batch fraudster registration job using provided details.

Request Syntax


{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DomainId": "string",
   "InputDataConfig": { 
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   },
   "RegistrationConfig": { 
      "DuplicateRegistrationAction": "string",
      "FraudsterSimilarityThreshold": number,
      "WatchlistIds": [ "string" ]
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9-_]+$

Required: No

DataAccessRoleArn

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$

Required: Yes

DomainId

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

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^[a-zA-Z0-9]{22}$

Required: Yes

InputDataConfig

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

Type: InputDataConfig object

Required: Yes

JobName

The name of the new fraudster registration job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Required: No

OutputDataConfig

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

Type: OutputDataConfig object

Required: Yes

RegistrationConfig

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

Type: RegistrationConfig object

Required: No

Response Syntax


{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RegistrationConfig": { 
         "DuplicateRegistrationAction": "string",
         "FraudsterSimilarityThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Job

Details about the started fraudster registration job.

Type: FraudsterRegistrationJob object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action. Check the error message and try again.

HTTP Status Code: 400

ConflictException

The request failed due to a conflict. Check the ConflictType and error message for more details.

HTTP Status Code: 400

InternalServerException

The request failed due to an unknown error on the server side.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ResourceType and error message for more details.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.

HTTP Status Code: 400

ValidationException

The request failed one or more validations; check the error message for more details.

HTTP Status Code: 400