VoiceID / Client / list_speaker_enrollment_jobs

list_speaker_enrollment_jobs#

VoiceID.Client.list_speaker_enrollment_jobs(**kwargs)#

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

response = client.list_speaker_enrollment_jobs(
    DomainId='string',
    JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    MaxResults=123,
    NextToken='string'
)

Parameters:

DomainId (string) –
[REQUIRED]

The identifier of the domain that contains the speaker enrollment jobs.
JobStatus (string) – Provides the status of your speaker enrollment Job.
MaxResults (integer) – The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'JobSummaries': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'DomainId': 'string',
            'EndedAt': datetime(2015, 1, 1),
            'FailureDetails': {
                'Message': 'string',
                'StatusCode': 123
            },
            'JobId': 'string',
            'JobName': 'string',
            'JobProgress': {
                'PercentComplete': 123
            },
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- JobSummaries (list) –
  
  A list containing details about each specified speaker enrollment job.
  - (dict) –
    
    Contains a summary of information about a speaker enrollment job.
    - CreatedAt (datetime) –
      
      A timestamp of when of the speaker enrollment job was created.
    - DomainId (string) –
      
      The identifier of the domain that contains the speaker enrollment job.
    - EndedAt (datetime) –
      
      A timestamp of when the speaker enrollment job ended.
    - FailureDetails (dict) –
      
      Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn’t fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
      - Message (string) –
        
        A description of the error that caused the batch job failure.
      - StatusCode (integer) –
        
        An HTTP status code representing the nature of the error.
    - JobId (string) –
      
      The service-generated identifier for the speaker enrollment job.
    - JobName (string) –
      
      The client-provided name for the speaker enrollment job.
    - JobProgress (dict) –
      
      Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
      - PercentComplete (integer) –
        
        Shows the completed percentage of enrollment or registration requests listed in the input file.
    - JobStatus (string) –
      
      The current status of the speaker enrollment job.
- NextToken (string) –
  
  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.

Exceptions

VoiceID.Client.exceptions.ResourceNotFoundException
VoiceID.Client.exceptions.ValidationException
VoiceID.Client.exceptions.InternalServerException
VoiceID.Client.exceptions.ThrottlingException
VoiceID.Client.exceptions.AccessDeniedException