Amazon Fraud Detector Fraud Detector Batch Prediction Job API

The Fraud Detector Batch Prediction Job API from Amazon Fraud Detector — 4 operation(s) for fraud detector batch prediction job.

Operations 4

POST /#CancelBatchPredictionJob Cancel Batch Prediction Job #
POST /#CreateBatchPredictionJob Create Batch Prediction Job #
POST /#DeleteBatchPredictionJob Delete Batch Prediction Job #
POST /#GetBatchPredictionJobs Get Batch Prediction Jobs #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-fraud-detector:amazon-fraud-detector-batch-prediction-job-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-fraud-detector-batch-prediction-job-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon Fraud Detector Batch Prediction Job API
  version: '2019-11-15'
  description: Generated from AWS's published Smithy model for Amazon Fraud Detector. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://frauddetector.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Batch Prediction Job
paths:
  /#CancelBatchPredictionJob:
    post:
      operationId: CancelBatchPredictionJob
      summary: Cancel Batch Prediction Job
      description: Cancels the specified batch prediction job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelBatchPredictionJobResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.CancelBatchPredictionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelBatchPredictionJobRequest'
      tags:
      - Batch Prediction Job
  /#CreateBatchPredictionJob:
    post:
      operationId: CreateBatchPredictionJob
      summary: Create Batch Prediction Job
      description: Creates a batch prediction job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateBatchPredictionJobResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.CreateBatchPredictionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateBatchPredictionJobRequest'
      tags:
      - Batch Prediction Job
  /#DeleteBatchPredictionJob:
    post:
      operationId: DeleteBatchPredictionJob
      summary: Delete Batch Prediction Job
      description: Deletes a batch prediction job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteBatchPredictionJobResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.DeleteBatchPredictionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteBatchPredictionJobRequest'
      tags:
      - Batch Prediction Job
  /#GetBatchPredictionJobs:
    post:
      operationId: GetBatchPredictionJobs
      summary: Get Batch Prediction Jobs
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetBatchPredictionJobsResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.GetBatchPredictionJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetBatchPredictionJobsRequest'
      tags:
      - Batch Prediction Job
components:
  schemas:
    CancelBatchPredictionJobResult:
      type: object
      properties: {}
    CreateBatchPredictionJobResult:
      type: object
      properties: {}
    GetBatchPredictionJobsResult:
      type: object
      properties:
        batchPredictions:
          type: array
          items:
            $ref: '#/components/schemas/BatchPrediction'
          description: An array containing the details of each batch prediction job.
        nextToken:
          type: string
          description: The next token for the subsequent request.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteBatchPredictionJobRequest:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the batch prediction job to delete.
      required:
      - jobId
    CreateBatchPredictionJobRequest:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the batch prediction job.
        inputPath:
          type: string
          description: The Amazon S3 location of your training file.
        outputPath:
          type: string
          description: The Amazon S3 location of your output file.
        eventTypeName:
          type: string
          description: The name of the event type.
        detectorName:
          type: string
          description: The name of the detector.
        detectorVersion:
          type: string
          description: The detector version.
        iamRoleArn:
          type: string
          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.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A collection of key and value pairs.
      required:
      - jobId
      - inputPath
      - outputPath
      - eventTypeName
      - detectorName
      - iamRoleArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CancelBatchPredictionJobRequest:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the batch prediction job to cancel.
      required:
      - jobId
    DeleteBatchPredictionJobResult:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetBatchPredictionJobsRequest:
      type: object
      properties:
        jobId:
          type: string
          description: The batch prediction job for which to get the details.
        maxResults:
          type: integer
          description: The maximum number of objects to return for the request.
        nextToken:
          type: string
          description: The next token from the previous request.
    BatchPrediction:
      type: object
      properties:
        jobId:
          type: string
          description: The job ID for the batch prediction.
        status:
          type: string
          enum:
          - IN_PROGRESS_INITIALIZING
          - IN_PROGRESS
          - CANCEL_IN_PROGRESS
          - CANCELED
          - COMPLETE
          - FAILED
          description: The batch prediction status.
        failureReason:
          type: string
          description: The reason a batch prediction job failed.
        startTime:
          type: string
          description: Timestamp of when the batch prediction job started.
        completionTime:
          type: string
          description: Timestamp of when the batch prediction job completed.
        lastHeartbeatTime:
          type: string
          description: Timestamp of most recent heartbeat indicating the batch prediction job was making progress.
        inputPath:
          type: string
          description: The Amazon S3 location of your training file.
        outputPath:
          type: string
          description: The Amazon S3 location of your output file.
        eventTypeName:
          type: string
          description: The name of the event type.
        detectorName:
          type: string
          description: The name of the detector.
        detectorVersion:
          type: string
          description: The detector version.
        iamRoleArn:
          type: string
          description: The ARN of the IAM role to use for this job request.
        arn:
          type: string
          description: The ARN of batch prediction job.
        processedRecordsCount:
          type: integer
          description: The number of records processed by the batch prediction job.
        totalRecordsCount:
          type: integer
          description: The total number of records in the batch prediction job.
    Tag:
      type: object
      properties:
        key:
          type: string
          description: A tag key.
        value:
          type: string
          description: A value assigned to a tag key.
      required:
      - key
      - value
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: frauddetector
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/frauddetector/service/2019-11-15/frauddetector-2019-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)