| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.VoiceId.ListSpeakerEnrollmentJobs
Description
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.
This operation returns paginated results.
Synopsis
- data ListSpeakerEnrollmentJobs = ListSpeakerEnrollmentJobs' {}
- newListSpeakerEnrollmentJobs :: Text -> ListSpeakerEnrollmentJobs
- listSpeakerEnrollmentJobs_jobStatus :: Lens' ListSpeakerEnrollmentJobs (Maybe SpeakerEnrollmentJobStatus)
- listSpeakerEnrollmentJobs_maxResults :: Lens' ListSpeakerEnrollmentJobs (Maybe Natural)
- listSpeakerEnrollmentJobs_nextToken :: Lens' ListSpeakerEnrollmentJobs (Maybe Text)
- listSpeakerEnrollmentJobs_domainId :: Lens' ListSpeakerEnrollmentJobs Text
- data ListSpeakerEnrollmentJobsResponse = ListSpeakerEnrollmentJobsResponse' {}
- newListSpeakerEnrollmentJobsResponse :: Int -> ListSpeakerEnrollmentJobsResponse
- listSpeakerEnrollmentJobsResponse_jobSummaries :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe [SpeakerEnrollmentJobSummary])
- listSpeakerEnrollmentJobsResponse_nextToken :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe Text)
- listSpeakerEnrollmentJobsResponse_httpStatus :: Lens' ListSpeakerEnrollmentJobsResponse Int
Creating a Request
data ListSpeakerEnrollmentJobs Source #
See: newListSpeakerEnrollmentJobs smart constructor.
Constructors
| ListSpeakerEnrollmentJobs' | |
Fields
| |
Instances
newListSpeakerEnrollmentJobs Source #
Arguments
| :: Text | |
| -> ListSpeakerEnrollmentJobs |
Create a value of ListSpeakerEnrollmentJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobs_jobStatus - Provides the status of your speaker enrollment Job.
$sel:maxResults:ListSpeakerEnrollmentJobs', listSpeakerEnrollmentJobs_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.
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobs_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.
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobs_domainId - The identifier of the domain containing the speaker enrollment jobs.
Request Lenses
listSpeakerEnrollmentJobs_jobStatus :: Lens' ListSpeakerEnrollmentJobs (Maybe SpeakerEnrollmentJobStatus) Source #
Provides the status of your speaker enrollment Job.
listSpeakerEnrollmentJobs_maxResults :: Lens' ListSpeakerEnrollmentJobs (Maybe Natural) Source #
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.
listSpeakerEnrollmentJobs_nextToken :: Lens' ListSpeakerEnrollmentJobs (Maybe Text) Source #
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.
listSpeakerEnrollmentJobs_domainId :: Lens' ListSpeakerEnrollmentJobs Text Source #
The identifier of the domain containing the speaker enrollment jobs.
Destructuring the Response
data ListSpeakerEnrollmentJobsResponse Source #
See: newListSpeakerEnrollmentJobsResponse smart constructor.
Constructors
| ListSpeakerEnrollmentJobsResponse' | |
Fields
| |
Instances
newListSpeakerEnrollmentJobsResponse Source #
Arguments
| :: Int | |
| -> ListSpeakerEnrollmentJobsResponse |
Create a value of ListSpeakerEnrollmentJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobSummaries:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_jobSummaries - A list containing details about each specified speaker enrollment job.
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobsResponse_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.
$sel:httpStatus:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_httpStatus - The response's http status code.
Response Lenses
listSpeakerEnrollmentJobsResponse_jobSummaries :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe [SpeakerEnrollmentJobSummary]) Source #
A list containing details about each specified speaker enrollment job.
listSpeakerEnrollmentJobsResponse_nextToken :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe Text) Source #
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.
listSpeakerEnrollmentJobsResponse_httpStatus :: Lens' ListSpeakerEnrollmentJobsResponse Int Source #
The response's http status code.