FraudDetector / Client / get_batch_import_jobs

get_batch_import_jobs#

FraudDetector.Client.get_batch_import_jobs(**kwargs)#

Gets all batch import jobs or a specific job of the specified 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 GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

Request Syntax

response = client.get_batch_import_jobs(
    jobId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • jobId (string) – The ID of the batch import job to get.

  • maxResults (integer) – The maximum number of objects to return for request.

  • nextToken (string) – The next token from the previous request.

Return type:

dict

Returns:

Response Syntax

{
    'batchImports': [
        {
            'jobId': 'string',
            'status': 'IN_PROGRESS_INITIALIZING'|'IN_PROGRESS'|'CANCEL_IN_PROGRESS'|'CANCELED'|'COMPLETE'|'FAILED',
            'failureReason': 'string',
            'startTime': 'string',
            'completionTime': 'string',
            'inputPath': 'string',
            'outputPath': 'string',
            'eventTypeName': 'string',
            'iamRoleArn': 'string',
            'arn': 'string',
            'processedRecordsCount': 123,
            'failedRecordsCount': 123,
            'totalRecordsCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • batchImports (list) –

      An array containing the details of each batch import job.

      • (dict) –

        The batch import job details.

        • jobId (string) –

          The ID of the batch import job.

        • status (string) –

          The status of the batch import job.

        • failureReason (string) –

          The reason batch import job failed.

        • startTime (string) –

          Timestamp of when the batch import job started.

        • completionTime (string) –

          Timestamp of when batch import job completed.

        • inputPath (string) –

          The Amazon S3 location of your data file for batch import.

        • outputPath (string) –

          The Amazon S3 location of your output file.

        • eventTypeName (string) –

          The name of the event type.

        • iamRoleArn (string) –

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

        • arn (string) –

          The ARN of the batch import job.

        • processedRecordsCount (integer) –

          The number of records processed by batch import job.

        • failedRecordsCount (integer) –

          The number of records that failed to import.

        • totalRecordsCount (integer) –

          The total number of records in the batch import job.

    • nextToken (string) –

      The next token for the subsequent resquest.

Exceptions