batch_import_jobs

Creates, updates, deletes, gets or lists a batch_import_jobs resource.

Overview

Name	batch_import_jobs
Type	Resource
Id	aws.frauddetector.batch_import_jobs

Fields

The following fields are returned by SELECT queries:

get_batch_import_jobs

Name	Datatype	Description
batch_imports	array	An array containing the details of each batch import job.
next_token	string	The next token for the subsequent resquest.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_batch_import_jobs	select	region		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.
create_batch_import_job	insert	region, jobId, inputPath, outputPath, eventTypeName, iamRoleArn		Creates a batch import job.
delete_batch_import_job	delete	region		Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_batch_import_jobs

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.

SELECT
batch_imports,
next_token
FROM aws.frauddetector.batch_import_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_batch_import_job

Creates a batch import job.

INSERT INTO aws.frauddetector.batch_import_jobs (
jobId,
inputPath,
outputPath,
eventTypeName,
iamRoleArn,
tags,
region
)
SELECT 
'{{ jobId }}' /* required */,
'{{ inputPath }}' /* required */,
'{{ outputPath }}' /* required */,
'{{ eventTypeName }}' /* required */,
'{{ iamRoleArn }}' /* required */,
'{{ tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: batch_import_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the batch_import_jobs resource.
  - name: jobId
    value: "{{ jobId }}"
    description: |
      The ID of the batch import job. The ID cannot be of a past job, unless the job exists in CREATE_FAILED state.
  - name: inputPath
    value: "{{ inputPath }}"
    description: |
      The URI that points to the Amazon S3 location of your data file.
  - name: outputPath
    value: "{{ outputPath }}"
    description: |
      The URI that points to the Amazon S3 location for storing your results.
  - name: eventTypeName
    value: "{{ eventTypeName }}"
    description: |
      The name of the event type.
  - name: iamRoleArn
    value: "{{ iamRoleArn }}"
    description: |
      The ARN of the IAM role created for Amazon S3 bucket that holds your data file. The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.
  - name: tags
    description: |
      A collection of key-value pairs associated with this request.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_batch_import_job

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

DELETE FROM aws.frauddetector.batch_import_jobs
WHERE region = '{{ region }}' --required
;