Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . personalize ]

create-batch-inference-job

Description

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-batch-inference-job
--job-name <value>
--solution-version-arn <value>
[--num-results <value>]
--job-input <value>
--job-output <value>
--role-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-name (string)

The name of the batch inference job to create.

--solution-version-arn (string)

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

--num-results (integer)

The number of recommendations to retreive.

--job-input (structure)

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

Shorthand Syntax:

s3DataSource={path=string,kmsKeyArn=string}

JSON Syntax:

{
  "s3DataSource": {
    "path": "string",
    "kmsKeyArn": "string"
  }
}

--job-output (structure)

The path to the Amazon S3 bucket where the job's output will be stored.

Shorthand Syntax:

s3DataDestination={path=string,kmsKeyArn=string}

JSON Syntax:

{
  "s3DataDestination": {
    "path": "string",
    "kmsKeyArn": "string"
  }
}

--role-arn (string)

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

batchInferenceJobArn -> (string)

The ARN of the batch inference job.