Get Job

locationservice_get_job

R Documentation

GetJob retrieves detailed information about a specific job, including its current status, configuration, and error information if the job failed

Description

get_job retrieves detailed information about a specific job, including its current status, configuration, and error information if the job failed.

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

Usage

locationservice_get_job(JobId)

Arguments

JobId

[required] The unique identifier of the job to retrieve.

Value

A list with the following syntax:

list(
  Action = "ValidateAddress",
  ActionOptions = list(
    ValidateAddress = list(
      AdditionalFeatures = list(
        "Position"|"CountrySpecificAttributes"
      )
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  EndedAt = as.POSIXct(
    "2015-01-01"
  ),
  Error = list(
    Code = "ValidationError"|"InternalServerError",
    Messages = list(
      "string"
    )
  ),
  ExecutionRoleArn = "string",
  InputOptions = list(
    Location = "string",
    Format = "Parquet"
  ),
  JobArn = "string",
  JobId = "string",
  Name = "string",
  OutputOptions = list(
    Format = "Parquet",
    Location = "string"
  ),
  Status = "Pending"|"Running"|"Completed"|"Failed"|"Cancelling"|"Cancelled",
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_job(
  JobId = "string"
)