:doc:`FraudDetector <../../frauddetector>` / Client / get_batch_prediction_jobs

*************************
get_batch_prediction_jobs
*************************



.. py:method:: FraudDetector.Client.get_batch_prediction_jobs(**kwargs)

  

  Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchPredictionJobs>`_  


  **Request Syntax**
  ::

    response = client.get_batch_prediction_jobs(
        jobId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type jobId: string
  :param jobId: 

    The batch prediction job for which to get the details.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of objects to return for the request.

    

  
  :type nextToken: string
  :param nextToken: 

    The next token from the previous request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'batchPredictions': [
              {
                  'jobId': 'string',
                  'status': 'IN_PROGRESS_INITIALIZING'|'IN_PROGRESS'|'CANCEL_IN_PROGRESS'|'CANCELED'|'COMPLETE'|'FAILED',
                  'failureReason': 'string',
                  'startTime': 'string',
                  'completionTime': 'string',
                  'lastHeartbeatTime': 'string',
                  'inputPath': 'string',
                  'outputPath': 'string',
                  'eventTypeName': 'string',
                  'detectorName': 'string',
                  'detectorVersion': 'string',
                  'iamRoleArn': 'string',
                  'arn': 'string',
                  'processedRecordsCount': 123,
                  'totalRecordsCount': 123
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **batchPredictions** *(list) --* 

        An array containing the details of each batch prediction job.

        
        

        - *(dict) --* 

          The batch prediction details.

          
          

          - **jobId** *(string) --* 

            The job ID for the batch prediction.

            
          

          - **status** *(string) --* 

            The batch prediction status.

            
          

          - **failureReason** *(string) --* 

            The reason a batch prediction job failed.

            
          

          - **startTime** *(string) --* 

            Timestamp of when the batch prediction job started.

            
          

          - **completionTime** *(string) --* 

            Timestamp of when the batch prediction job completed.

            
          

          - **lastHeartbeatTime** *(string) --* 

            Timestamp of most recent heartbeat indicating the batch prediction job was making progress.

            
          

          - **inputPath** *(string) --* 

            The Amazon S3 location of your training file.

            
          

          - **outputPath** *(string) --* 

            The Amazon S3 location of your output file.

            
          

          - **eventTypeName** *(string) --* 

            The name of the event type.

            
          

          - **detectorName** *(string) --* 

            The name of the detector.

            
          

          - **detectorVersion** *(string) --* 

            The detector version.

            
          

          - **iamRoleArn** *(string) --* 

            The ARN of the IAM role to use for this job request.

            
          

          - **arn** *(string) --* 

            The ARN of batch prediction job.

            
          

          - **processedRecordsCount** *(integer) --* 

            The number of records processed by the batch prediction job.

            
          

          - **totalRecordsCount** *(integer) --* 

            The total number of records in the batch prediction job.

            
      
    
      

      - **nextToken** *(string) --* 

        The next token for the subsequent request.

        
  
  **Exceptions**
  
  *   :py:class:`FraudDetector.Client.exceptions.ValidationException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`FraudDetector.Client.exceptions.InternalServerException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ThrottlingException`

  
  *   :py:class:`FraudDetector.Client.exceptions.AccessDeniedException`

  