Get Batch

omics_get_batch

R Documentation

Retrieves details and current status for a specific run batch, including submission progress and run execution counts¶

Description¶

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Usage¶

omics_get_batch(batchId)

Arguments¶

batchId

[required] The identifier portion of the run batch ARN.

Value¶

A list with the following syntax:

list(
  id = "string",
  arn = "string",
  uuid = "string",
  name = "string",
  status = "CREATING"|"PENDING"|"SUBMITTING"|"INPROGRESS"|"STOPPING"|"CANCELLED"|"FAILED"|"PROCESSED"|"RUNS_DELETING"|"RUNS_DELETED",
  tags = list(
    "string"
  ),
  totalRuns = 123,
  defaultRunSetting = list(
    workflowId = "string",
    workflowType = "PRIVATE"|"READY2RUN",
    roleArn = "string",
    name = "string",
    cacheId = "string",
    cacheBehavior = "CACHE_ON_FAILURE"|"CACHE_ALWAYS",
    runGroupId = "string",
    priority = 123,
    parameters = list(),
    storageCapacity = 123,
    outputUri = "string",
    logLevel = "OFF"|"FATAL"|"ERROR"|"ALL",
    runTags = list(
      "string"
    ),
    retentionMode = "RETAIN"|"REMOVE",
    storageType = "STATIC"|"DYNAMIC",
    workflowOwnerId = "string",
    outputBucketOwnerId = "string",
    workflowVersionName = "string",
    networkingMode = "RESTRICTED"|"VPC",
    configurationName = "string"
  ),
  submissionSummary = list(
    successfulStartSubmissionCount = 123,
    failedStartSubmissionCount = 123,
    pendingStartSubmissionCount = 123,
    successfulCancelSubmissionCount = 123,
    failedCancelSubmissionCount = 123,
    successfulDeleteSubmissionCount = 123,
    failedDeleteSubmissionCount = 123
  ),
  runSummary = list(
    pendingRunCount = 123,
    startingRunCount = 123,
    runningRunCount = 123,
    stoppingRunCount = 123,
    completedRunCount = 123,
    deletedRunCount = 123,
    failedRunCount = 123,
    cancelledRunCount = 123
  ),
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  submittedTime = as.POSIXct(
    "2015-01-01"
  ),
  processedTime = as.POSIXct(
    "2015-01-01"
  ),
  failedTime = as.POSIXct(
    "2015-01-01"
  ),
  failureReason = "string"
)

Request syntax¶

svc$get_batch(
  batchId = "string"
)