Start Job

locationservice_start_job

R Documentation

StartJob starts a new asynchronous bulk processing job

Description

start_job starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.

For more information, see Job concepts in the Amazon Location Service Developer Guide.

Usage

locationservice_start_job(ClientToken, Action, ActionOptions,
  ExecutionRoleArn, InputOptions, Name, OutputOptions, Tags)

Arguments

ClientToken	A unique identifier for this request to ensure idempotency.
Action	[required] The action to perform on the input data.
ActionOptions	Additional parameters that can be requested for each result.
ExecutionRoleArn	[required] The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job. The IAM role must be created in the same Amazon Web Services account where you plan to run your job. For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.
InputOptions	[required] Configuration for input data location and format. Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.
Name	An optional name for the job resource.
OutputOptions	[required] Configuration for output data location and format.
Tags	Tags and corresponding values to be associated with the job.

Value

A list with the following syntax:

list(
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  JobArn = "string",
  JobId = "string",
  Status = "Pending"|"Running"|"Completed"|"Failed"|"Cancelling"|"Cancelled"
)

Request syntax

svc$start_job(
  ClientToken = "string",
  Action = "ValidateAddress",
  ActionOptions = list(
    ValidateAddress = list(
      AdditionalFeatures = list(
        "Position"|"CountrySpecificAttributes"
      )
    )
  ),
  ExecutionRoleArn = "string",
  InputOptions = list(
    Location = "string",
    Format = "Parquet"
  ),
  Name = "string",
  OutputOptions = list(
    Format = "Parquet",
    Location = "string"
  ),
  Tags = list(
    "string"
  )
)