Start Read Set Activation Job

omics_start_read_set_activation_job

R Documentation

Activates an archived read set and returns its metadata in a JSON formatted output¶

Description¶

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the get_read_set_activation_job operation.

To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

Usage¶

omics_start_read_set_activation_job(sequenceStoreId, clientToken,
  sources)

Arguments¶

sequenceStoreId

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

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

Request syntax¶

svc$start_read_set_activation_job(
  sequenceStoreId = "string",
  clientToken = "string",
  sources = list(
    list(
      readSetId = "string"
    )
  )
)