batch_prediction_jobs

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

Overview

Name	batch_prediction_jobs
Type	Resource
Id	aws.frauddetector.batch_prediction_jobs

Fields

The following fields are returned by SELECT queries:

get_batch_prediction_jobs

Name	Datatype	Description
batch_predictions	array	An array containing the details of each batch prediction job.
next_token	string	The next token for the subsequent request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_batch_prediction_jobs	select	region		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.
create_batch_prediction_job	insert	region, jobId, inputPath, outputPath, eventTypeName, detectorName, iamRoleArn		Creates a batch prediction job.
delete_batch_prediction_job	delete	region		Deletes a batch prediction job.

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_prediction_jobs

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.

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

INSERT examples

create_batch_prediction_job

Creates a batch prediction job.

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

Manifest

# Description fields are for documentation purposes
- name: batch_prediction_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the batch_prediction_jobs resource.
  - name: jobId
    value: "{{ jobId }}"
    description: |
      The ID of the batch prediction job.
  - name: inputPath
    value: "{{ inputPath }}"
    description: |
      The Amazon S3 location of your training file.
  - name: outputPath
    value: "{{ outputPath }}"
    description: |
      The Amazon S3 location of your output file.
  - name: eventTypeName
    value: "{{ eventTypeName }}"
    description: |
      The name of the event type.
  - name: detectorName
    value: "{{ detectorName }}"
    description: |
      The name of the detector.
  - name: detectorVersion
    value: "{{ detectorVersion }}"
    description: |
      The detector version.
  - name: iamRoleArn
    value: "{{ iamRoleArn }}"
    description: |
      The ARN of the IAM role to use for this job request. 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 and value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_batch_prediction_job

Deletes a batch prediction job.

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