Start Read Set Import Job

omics_start_read_set_import_job

R Documentation

Starts a read set import job¶

Description¶

Starts a read set import job.

Usage¶

omics_start_read_set_import_job(sequenceStoreId, roleArn, clientToken,
  sources)

Arguments¶

sequenceStoreId: [required] The read set's sequence store ID.
roleArn: [required] A service role for the job.
clientToken: To ensure that jobs don't run multiple times, specify a unique token for each job.
sources: [required] The job's source files.

Value¶

A list with the following syntax:

list(
  id = "string",
  sequenceStoreId = "string",
  roleArn = "string",
  status = "SUBMITTED"|"IN_PROGRESS"|"CANCELLING"|"CANCELLED"|"FAILED"|"COMPLETED"|"COMPLETED_WITH_FAILURES",
  creationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$start_read_set_import_job(
  sequenceStoreId = "string",
  roleArn = "string",
  clientToken = "string",
  sources = list(
    list(
      sourceFiles = list(
        source1 = "string",
        source2 = "string"
      ),
      sourceFileType = "FASTQ"|"BAM"|"CRAM"|"UBAM",
      subjectId = "string",
      sampleId = "string",
      generatedFrom = "string",
      referenceArn = "string",
      name = "string",
      description = "string",
      tags = list(
        "string"
      )
    )
  )
)