Skip to content

Create Batch Segment Job

personalize_create_batch_segment_job R Documentation

Creates a batch segment job

Description

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

Usage

personalize_create_batch_segment_job(jobName, solutionVersionArn,
  filterArn, numResults, jobInput, jobOutput, roleArn, tags)

Arguments

jobName

[required] The name of the batch segment job to create.

solutionVersionArn

[required] The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

filterArn

The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

numResults

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

jobInput

[required] The Amazon S3 path for the input data used to generate the batch segment job.

jobOutput

[required] The Amazon S3 path for the bucket where the job's output will be stored.

roleArn

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

tags

A list of tags to apply to the batch segment job.

Value

A list with the following syntax: 

list(
  batchSegmentJobArn = "string"
)

Request syntax

svc$create_batch_segment_job(
  jobName = "string",
  solutionVersionArn = "string",
  filterArn = "string",
  numResults = 123,
  jobInput = list(
    s3DataSource = list(
      path = "string",
      kmsKeyArn = "string"
    )
  ),
  jobOutput = list(
    s3DataDestination = list(
      path = "string",
      kmsKeyArn = "string"
    )
  ),
  roleArn = "string",
  tags = list(
    list(
      tagKey = "string",
      tagValue = "string"
    )
  )
)