ListSpeakerEnrollmentJobs - Amazon Connect Voice ID

ListSpeakerEnrollmentJobs

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

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 speaker enrollment jobs.

Type: String

Length Constraints: Fixed length of 22.

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

Required: Yes

JobStatus

Provides the status of your speaker enrollment Job.

Type: String

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

Required: No

MaxResults

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

Type: Integer

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

Required: No

NextToken

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.

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 details about each specified speaker enrollment job.

Type: Array of SpeakerEnrollmentJobSummary objects

NextToken

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.

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

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

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

See Also

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