:doc:`VoiceID <../../voice-id>` / Paginator / ListFraudsterRegistrationJobs

*****************************
ListFraudsterRegistrationJobs
*****************************



.. py:class:: VoiceID.Paginator.ListFraudsterRegistrationJobs

  ::

    
    paginator = client.get_paginator('list_fraudster_registration_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`VoiceID.Client.list_fraudster_registration_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsterRegistrationJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DomainId='string',
          JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DomainId: string
    :param DomainId: **[REQUIRED]** 

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

      

    
    :type JobStatus: string
    :param JobStatus: 

      Provides the status of your fraudster registration job.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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'
                },
            ],
            
        }
        
      **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.

              
        
      
    