ListFraudsterRegistrationJobs - Amazon Voice ID

ListFraudsterRegistrationJobs

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

Request Syntax

{ "DomainId": "string", "JobStatus": "string", "MaxResults": number, "NextToken": "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.

DomainId

The identifier of the domain containing the fraudster registration Jobs.

Type: String

Length Constraints: Fixed length of 22.

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

Required: Yes

JobStatus

Provides the status of your fraudster registration job.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED

Required: No

MaxResults

The maximum number of Jobs to list per API call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token used to list the next set of Jobs if the previous call did not list all remaining Jobs. The API returns a NextToken in the response when the number of remaining jobs is higher than MaxResults.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: ^\p{ASCII}{0,8192}$

Required: No

Response Syntax

{ "JobSummaries": [ { "CreatedAt": number, "DomainId": "string", "EndedAt": number, "FailureDetails": { "Message": "string", "StatusCode": number }, "JobId": "string", "JobName": "string", "JobProgress": { "PercentComplete": number }, "JobStatus": "string" } ], "NextToken": "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.

JobSummaries

A list containing information about each specified fraudster registration job.

Type: Array of FraudsterRegistrationJobSummary objects

NextToken

The token that can be used to list the next set of jobs in a paginated manner. If there are no more jobs left, the value is null.

Type: String

Length Constraints: Minimum length of 1.

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

InternalServerException

There was an unknown internal error when processing the request.

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. 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 and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: