VoiceID / Client / list_fraudster_registration_jobs

list_fraudster_registration_jobs#

VoiceID.Client.list_fraudster_registration_jobs(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_fraudster_registration_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 fraudster registration Jobs.

  • JobStatus (string) – Provides the status of your fraudster registration 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 fraudster registration job.

      • (dict) –

        Contains a summary of information about a fraudster registration job.

        • CreatedAt (datetime) –

          A timestamp of when the fraudster registration job was created.

        • DomainId (string) –

          The identifier of the domain that contains the fraudster registration job.

        • EndedAt (datetime) –

          A timestamp of when the fraudster registration 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 fraudster registration job.

        • JobName (string) –

          The client-provided name for the fraudster registration job.

        • JobProgress (dict) –

          Shows the completed percentage of registration 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 fraudster registration 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