Start Read Set Export Job

omics_start_read_set_export_job

R Documentation

Starts a read set export job¶

Description¶

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the get_read_set_export_job API operation.

To monitor the status of the export job, use the list_read_set_export_jobs API operation.

Usage¶

omics_start_read_set_export_job(sequenceStoreId, destination, roleArn,
  clientToken, sources)

Arguments¶

sequenceStoreId

[required] The read set's sequence store ID.

destination

[required] A location for exported files in Amazon S3.

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",
  destination = "string",
  status = "SUBMITTED"|"IN_PROGRESS"|"CANCELLING"|"CANCELLED"|"FAILED"|"COMPLETED"|"COMPLETED_WITH_FAILURES",
  creationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$start_read_set_export_job(
  sequenceStoreId = "string",
  destination = "string",
  roleArn = "string",
  clientToken = "string",
  sources = list(
    list(
      readSetId = "string"
    )
  )
)