CreateBatchPredictionJob - Amazon Fraud Detector

CreateBatchPredictionJob

Creates a batch prediction job.

Request Syntax

{ "detectorName": "string", "detectorVersion": "string", "eventTypeName": "string", "iamRoleArn": "string", "inputPath": "string", "jobId": "string", "outputPath": "string", "tags": [ { "key": "string", "value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

detectorName

The name of the detector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_-]+$

Required: Yes

detectorVersion

The detector version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^([1-9][0-9]*)$

Required: No

eventTypeName

The name of the event type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_-]+$

Required: Yes

iamRoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn\:aws[a-z-]{0,15}\:iam\:\:[0-9]{12}\:role\/[^\s]{2,64}$

Required: Yes

inputPath

The Amazon S3 location of your training file.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^s3:\/\/(.+)$

Required: Yes

jobId

The ID of the batch prediction job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_-]+$

Required: Yes

outputPath

The Amazon S3 location of your output file.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^s3:\/\/(.+)$

Required: Yes

tags

A collection of key and value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

HTTP Status Code: 400

InternalServerException

An exception indicating an internal server error.

HTTP Status Code: 500

ValidationException

An exception indicating a specified value is not allowed.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: