libZSservicesZSamazonka-voice-idZSamazonka-voice-id
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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.

Synopsis

Creating a Request

data ListSpeakerEnrollmentJobs Source #

See: newListSpeakerEnrollmentJobs smart constructor.

Constructors

ListSpeakerEnrollmentJobs' 

Fields

  • nextToken :: Maybe Text

    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.

  • jobStatus :: Maybe SpeakerEnrollmentJobStatus

    Provides the status of your speaker enrollment Job.

  • maxResults :: Maybe Natural

    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.

  • domainId :: Text

    The identifier of the domain containing the speaker enrollment jobs.

Instances

Instances details
Eq ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Read ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Show ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Generic ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Associated Types

type Rep ListSpeakerEnrollmentJobs :: Type -> Type #

NFData ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Hashable ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

ToJSON ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

AWSRequest ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

ToHeaders ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

ToPath ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

ToQuery ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

type Rep ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

type Rep ListSpeakerEnrollmentJobs = D1 ('MetaData "ListSpeakerEnrollmentJobs" "Amazonka.VoiceId.ListSpeakerEnrollmentJobs" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "ListSpeakerEnrollmentJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpeakerEnrollmentJobStatus))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListSpeakerEnrollmentJobs Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

newListSpeakerEnrollmentJobs Source #

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:

$sel:nextToken: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.

$sel:jobStatus: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.

$sel:domainId:ListSpeakerEnrollmentJobs', listSpeakerEnrollmentJobs_domainId - The identifier of the domain containing the speaker enrollment jobs.

Request Lenses

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_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_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

  • nextToken :: Maybe Text

    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.

  • jobSummaries :: Maybe [SpeakerEnrollmentJobSummary]

    A list containing details about each specified speaker enrollment job.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListSpeakerEnrollmentJobsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Show ListSpeakerEnrollmentJobsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Generic ListSpeakerEnrollmentJobsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

Associated Types

type Rep ListSpeakerEnrollmentJobsResponse :: Type -> Type #

NFData ListSpeakerEnrollmentJobsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

type Rep ListSpeakerEnrollmentJobsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakerEnrollmentJobs

type Rep ListSpeakerEnrollmentJobsResponse = D1 ('MetaData "ListSpeakerEnrollmentJobsResponse" "Amazonka.VoiceId.ListSpeakerEnrollmentJobs" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "ListSpeakerEnrollmentJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpeakerEnrollmentJobSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSpeakerEnrollmentJobsResponse Source #

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:nextToken: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:jobSummaries:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_jobSummaries - A list containing details about each specified speaker enrollment job.

$sel:httpStatus:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_httpStatus - The response's http status code.

Response Lenses

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_jobSummaries :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe [SpeakerEnrollmentJobSummary]) Source #

A list containing details about each specified speaker enrollment job.