Class: AWS.Omics

var params = {
  jobId: 'STRING_VALUE' /* required */
};
omics.cancelAnnotationImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The job's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.cancelRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The run's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE' /* required */
};
omics.cancelVariantImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The job's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  storeFormat: GFF | TSV | VCF, /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE',
  reference: {
    referenceArn: 'STRING_VALUE'
  },
  sseConfig: {
    type: KMS, /* required */
    keyArn: 'STRING_VALUE'
  },
  storeOptions: {
    tsvStoreOptions: {
      annotationType: GENERIC | CHR_POS | CHR_POS_REF_ALT | CHR_START_END_ONE_BASE | CHR_START_END_REF_ALT_ONE_BASE | CHR_START_END_ZERO_BASE | CHR_START_END_REF_ALT_ZERO_BASE,
      formatToHeader: {
        '<FormatToHeaderKey>': 'STRING_VALUE',
        /* '<FormatToHeaderKey>': ... */
      },
      schema: [
        {
          '<SchemaItemKeyString>': LONG | INT | STRING | FLOAT | DOUBLE | BOOLEAN,
          /* '<SchemaItemKeyString>': ... */
        },
        /* more items */
      ]
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createAnnotationStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description for the store.

  • name — (String)

    A name for the store.

  • reference — (map)

    The genome reference for the store's annotations.

    • referenceArn — (String)

      The reference's ARN.

  • sseConfig — (map)

    Server-side encryption (SSE) settings for the store.

    • keyArn — (String)

      An encryption key ARN.

    • type — required — (String)

      The encryption type.

      Possible values include:
      • "KMS"
  • storeFormat — (String)

    The annotation file format of the store.

    Possible values include:
    • "GFF"
    • "TSV"
    • "VCF"
  • storeOptions — (map)

    File parsing options for the annotation store.

    • tsvStoreOptions — (map)

      File settings for a TSV store.

      • annotationType — (String)

        The store's annotation type.

        Possible values include:
        • "GENERIC"
        • "CHR_POS"
        • "CHR_POS_REF_ALT"
        • "CHR_START_END_ONE_BASE"
        • "CHR_START_END_REF_ALT_ONE_BASE"
        • "CHR_START_END_ZERO_BASE"
        • "CHR_START_END_REF_ALT_ZERO_BASE"
      • formatToHeader — (map<String>)

        The store's header key to column name mapping.

      • schema — (Array<map<String>>)

        The store's schema.

  • tags — (map<String>)

    Tags for the store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • creationTime — (Date)

      When the store was created.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • reference — (map)

      The store's genome reference. Required for all stores except TSV format with generic annotations.

      • referenceArn — (String)

        The reference's ARN.

    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"
    • storeFormat — (String)

      The annotation file format of the store.

      Possible values include:
      • "GFF"
      • "TSV"
      • "VCF"
    • storeOptions — (map)

      The store's file parsing options.

      • tsvStoreOptions — (map)

        File settings for a TSV store.

        • annotationType — (String)

          The store's annotation type.

          Possible values include:
          • "GENERIC"
          • "CHR_POS"
          • "CHR_POS_REF_ALT"
          • "CHR_START_END_ONE_BASE"
          • "CHR_START_END_REF_ALT_ONE_BASE"
          • "CHR_START_END_ZERO_BASE"
          • "CHR_START_END_REF_ALT_ZERO_BASE"
        • formatToHeader — (map<String>)

          The store's header key to column name mapping.

        • schema — (Array<map<String>>)

          The store's schema.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  sseConfig: {
    type: KMS, /* required */
    keyArn: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createReferenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    To ensure that requests don't run multiple times, specify a unique token for each request.

  • description — (String)

    A description for the store.

  • name — (String)

    A name for the store.

  • sseConfig — (map)

    Server-side encryption (SSE) settings for the store.

    • keyArn — (String)

      An encryption key ARN.

    • type — required — (String)

      The encryption type.

      Possible values include:
      • "KMS"
  • tags — (map<String>)

    Tags for the store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The store's ARN.

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • sseConfig — (map)

      The store's SSE settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  requestId: 'STRING_VALUE', /* required */
  maxCpus: 'NUMBER_VALUE',
  maxDuration: 'NUMBER_VALUE',
  maxRuns: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createRunGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxCpus — (Integer)

    The maximum number of CPUs to use in the group.

  • maxDuration — (Integer)

    A maximum run time for the group in minutes.

  • maxRuns — (Integer)

    The maximum number of concurrent runs for the group.

  • name — (String)

    A name for the group.

  • requestId — (String)

    To ensure that requests don't run multiple times, specify a unique ID for each request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

    Tags for the group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The group's ARN.

    • id — (String)

      The group's ID.

    • tags — (map<String>)

      Tags for the run group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  sseConfig: {
    type: KMS, /* required */
    keyArn: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createSequenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    To ensure that requests don't run multiple times, specify a unique token for each request.

  • description — (String)

    A description for the store.

  • name — (String)

    A name for the store.

  • sseConfig — (map)

    Server-side encryption (SSE) settings for the store.

    • keyArn — (String)

      An encryption key ARN.

    • type — required — (String)

      The encryption type.

      Possible values include:
      • "KMS"
  • tags — (map<String>)

    Tags for the store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The store's ARN.

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • sseConfig — (map)

      The store's SSE settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  reference: { /* required */
    referenceArn: 'STRING_VALUE'
  },
  description: 'STRING_VALUE',
  name: 'STRING_VALUE',
  sseConfig: {
    type: KMS, /* required */
    keyArn: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createVariantStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description for the store.

  • name — (String)

    A name for the store.

  • reference — (map)

    The genome reference for the store's variants.

    • referenceArn — (String)

      The reference's ARN.

  • sseConfig — (map)

    Server-side encryption (SSE) settings for the store.

    • keyArn — (String)

      An encryption key ARN.

    • type — required — (String)

      The encryption type.

      Possible values include:
      • "KMS"
  • tags — (map<String>)

    Tags for the store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • creationTime — (Date)

      When the store was created.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • reference — (map)

      The store's genome reference.

      • referenceArn — (String)

        The reference's ARN.

    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  requestId: 'STRING_VALUE', /* required */
  definitionUri: 'STRING_VALUE',
  definitionZip: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  description: 'STRING_VALUE',
  engine: WDL | NEXTFLOW,
  main: 'STRING_VALUE',
  name: 'STRING_VALUE',
  parameterTemplate: {
    '<WorkflowParameterName>': {
      description: 'STRING_VALUE',
      optional: true || false
    },
    /* '<WorkflowParameterName>': ... */
  },
  storageCapacity: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • definitionUri — (String)

    The URI of a definition for the workflow.

  • definitionZip — (Buffer, Typed Array, Blob, String)

    A ZIP archive for the workflow.

  • description — (String)

    A description for the workflow.

  • engine — (String)

    An engine for the workflow.

    Possible values include:
    • "WDL"
    • "NEXTFLOW"
  • main — (String)

    The path of the main definition file for the workflow.

  • name — (String)

    A name for the workflow.

  • parameterTemplate — (map<map>)

    A parameter template for the workflow.

    • description — (String)

      The parameter's description.

    • optional — (Boolean)

      Whether the parameter is optional.

  • requestId — (String)

    To ensure that requests don't run multiple times, specify a unique ID for each request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • storageCapacity — (Integer)

    A storage capacity for the workflow in gigabytes.

  • tags — (map<String>)

    Tags for the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The workflow's ARN.

    • id — (String)

      The workflow's ID.

    • status — (String)

      The workflow's status.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "UPDATING"
      • "DELETED"
      • "FAILED"
      • "INACTIVE"
    • tags — (map<String>)

      The workflow's tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  force: true || false
};
omics.deleteAnnotationStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • force — (Boolean)

    Whether to force deletion.

  • name — (String)

    The store's name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  referenceStoreId: 'STRING_VALUE' /* required */
};
omics.deleteReference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The reference's ID.

  • referenceStoreId — (String)

    The reference's store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.deleteReferenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The store's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.deleteRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The run's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.deleteRunGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The run group's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.deleteSequenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The sequence store's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  force: true || false
};
omics.deleteVariantStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • force — (Boolean)

    Whether to force deletion.

  • name — (String)

    The store's name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.deleteWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The workflow's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE' /* required */
};
omics.getAnnotationImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The job's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • destinationName — (String)

      The job's destination annotation store.

    • formatOptions — (map)

      Formatting options for a file.

      • tsvOptions — (map)

        Options for a TSV file.

        • readOptions — (map)

          The file's read options.

          • comment — (String)

            The file's comment character.

          • encoding — (String)

            The file's encoding.

          • escape — (String)

            A character for escaping quotes in the file.

          • escapeQuotes — (Boolean)

            Whether quotes need to be escaped in the file.

          • header — (Boolean)

            Whether the file has a header row.

          • lineSep — (String)

            A line separator for the file.

          • quote — (String)

            The file's quote character.

          • quoteAll — (Boolean)

            Whether all values need to be quoted, or just those that contain quotes.

          • sep — (String)

            The file's field separator.

      • vcfOptions — (map)

        Options for a VCF file.

        • ignoreFilterField — (Boolean)

          The file's ignore filter field setting.

        • ignoreQualField — (Boolean)

          The file's ignore qual field setting.

    • id — (String)

      The job's ID.

    • items — (Array<map>)

      The job's imported items.

      • jobStatus — required — (String)

        The item's job status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLED"
        • "COMPLETED"
        • "FAILED"
        • "COMPLETED_WITH_FAILURES"
      • source — required — (String)

        The source file's location in Amazon S3.

    • roleArn — (String)

      The job's service role ARN.

    • runLeftNormalization — (Boolean)

      The job's left normalization setting.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLED"
      • "COMPLETED"
      • "FAILED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

    • updateTime — (Date)

      When the job was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• annotationImportJobCreated

var params = {
  name: 'STRING_VALUE' /* required */
};
omics.getAnnotationStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The store's name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • reference — (map)

      The store's genome reference.

      • referenceArn — (String)

        The reference's ARN.

    • sseConfig — (map)

      The store's server-side encryption (SSE) settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"
    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"
    • statusMessage — (String)

      A status message.

    • storeArn — (String)

      The store's ARN.

    • storeFormat — (String)

      The store's annotation file format.

      Possible values include:
      • "GFF"
      • "TSV"
      • "VCF"
    • storeOptions — (map)

      The store's parsing options.

      • tsvStoreOptions — (map)

        File settings for a TSV store.

        • annotationType — (String)

          The store's annotation type.

          Possible values include:
          • "GENERIC"
          • "CHR_POS"
          • "CHR_POS_REF_ALT"
          • "CHR_START_END_ONE_BASE"
          • "CHR_START_END_REF_ALT_ONE_BASE"
          • "CHR_START_END_ZERO_BASE"
          • "CHR_START_END_REF_ALT_ZERO_BASE"
        • formatToHeader — (map<String>)

          The store's header key to column name mapping.

        • schema — (Array<map<String>>)

          The store's schema.

    • storeSizeBytes — (Integer)

      The store's size in bytes.

    • tags — (map<String>)

      The store's tags.

    • updateTime — (Date)

      When the store was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• annotationStoreCreated

• annotationStoreDeleted

var params = {
  id: 'STRING_VALUE', /* required */
  partNumber: 'NUMBER_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  file: SOURCE1 | SOURCE2 | INDEX
};
omics.getReadSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • file — (String)

    The file to retrieve.

    Possible values include:
    • "SOURCE1"
    • "SOURCE2"
    • "INDEX"
  • id — (String)

    The read set's ID.

  • partNumber — (Integer)

    The part number to retrieve.

  • sequenceStoreId — (String)

    The read set's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • payload — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      The read set file payload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReadSetActivationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The job's ID.

  • sequenceStoreId — (String)

    The job's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • id — (String)

      The job's ID.

    • sequenceStoreId — (String)

      The job's sequence store ID.

    • sources — (Array<map>)

      The job's source files.

      • readSetId — required — (String)

        The source's read set ID.

      • status — required — (String)

        The source's status.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "FINISHED"
        • "FAILED"
      • statusMessage — (String)

        The source's status message.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• readSetActivationJobCompleted

var params = {
  id: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReadSetExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The job's ID.

  • sequenceStoreId — (String)

    The job's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • destination — (String)

      The job's destination in Amazon S3.

    • id — (String)

      The job's ID.

    • readSets — (Array<map>)

      The job's read sets.

      • id — required — (String)

        The set's ID.

      • status — required — (String)

        The set's status.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "FINISHED"
        • "FAILED"
      • statusMessage — (String)

        The set's status message.

    • sequenceStoreId — (String)

      The job's sequence store ID.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• readSetExportJobCompleted

var params = {
  id: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReadSetImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The job's ID.

  • sequenceStoreId — (String)

    The job's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • id — (String)

      The job's ID.

    • roleArn — (String)

      The job's service role ARN.

    • sequenceStoreId — (String)

      The job's sequence store ID.

    • sources — (Array<map>)

      The job's source files.

      • description — (String)

        The source's description.

      • generatedFrom — (String)

        Where the source originated.

      • name — (String)

        The source's name.

      • referenceArn — (String)

        The source's genome reference ARN.

      • sampleId — required — (String)

        The source's sample ID.

      • sourceFileType — required — (String)

        The source's file type.

        Possible values include:
        • "FASTQ"
        • "BAM"
        • "CRAM"
      • sourceFiles — required — (map)

        The source files' location in Amazon S3.

        • source1 — required — (String)

          The location of the first file in Amazon S3.

        • source2 — (String)

          The location of the second file in Amazon S3.

      • status — required — (String)

        The source's status.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "FINISHED"
        • "FAILED"
      • statusMessage — (String)

        The source's status message.

      • subjectId — required — (String)

        The source's subject ID.

      • tags — (map<String>)

        The source's tags.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• readSetImportJobCompleted

var params = {
  id: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReadSetMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The read set's ID.

  • sequenceStoreId — (String)

    The read set's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The read set's ARN.

    • creationTime — (Date)

      When the read set was created.

    • description — (String)

      The read set's description.

    • fileType — (String)

      The read set's file type.

      Possible values include:
      • "FASTQ"
      • "BAM"
      • "CRAM"
    • files — (map)

      The read set's files.

      • index — (map)

        The files' index.

        • contentLength — (Integer)

          The file's content length.

        • partSize — (Integer)

          The file's part size.

        • totalParts — (Integer)

          The file's total parts.

      • source1 — (map)

        The location of the first file in Amazon S3.

        • contentLength — (Integer)

          The file's content length.

        • partSize — (Integer)

          The file's part size.

        • totalParts — (Integer)

          The file's total parts.

      • source2 — (map)

        The location of the second file in Amazon S3.

        • contentLength — (Integer)

          The file's content length.

        • partSize — (Integer)

          The file's part size.

        • totalParts — (Integer)

          The file's total parts.

    • id — (String)

      The read set's ID.

    • name — (String)

      The read set's name.

    • referenceArn — (String)

      The read set's genome reference ARN.

    • sampleId — (String)

      The read set's sample ID.

    • sequenceInformation — (map)

      The read set's sequence information.

      • alignment — (String)

        The sequence's alignment setting.

      • generatedFrom — (String)

        Where the sequence originated.

      • totalBaseCount — (Integer)

        The sequence's total base count.

      • totalReadCount — (Integer)

        The sequence's total read count.

    • sequenceStoreId — (String)

      The read set's sequence store ID.

    • status — (String)

      The read set's status.

      Possible values include:
      • "ARCHIVED"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • subjectId — (String)

      The read set's subject ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  partNumber: 'NUMBER_VALUE', /* required */
  referenceStoreId: 'STRING_VALUE', /* required */
  file: SOURCE | INDEX,
  range: 'STRING_VALUE'
};
omics.getReference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • file — (String)

    The file to retrieve.

    Possible values include:
    • "SOURCE"
    • "INDEX"
  • id — (String)

    The reference's ID.

  • partNumber — (Integer)

    The part number to retrieve.

  • range — (String)

    The range to retrieve.

  • referenceStoreId — (String)

    The reference's store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • payload — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      The reference file payload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  referenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReferenceImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The job's ID.

  • referenceStoreId — (String)

    The job's reference store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • id — (String)

      The job's ID.

    • referenceStoreId — (String)

      The job's reference store ID.

    • roleArn — (String)

      The job's service role ARN.

    • sources — (Array<map>)

      The job's source files.

      • description — (String)

        The source's description.

      • name — (String)

        The source's name.

      • sourceFile — (String)

        The source file's location in Amazon S3.

      • status — required — (String)

        The source's status.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "FINISHED"
        • "FAILED"
      • statusMessage — (String)

        The source's status message.

      • tags — (map<String>)

        The source's tags.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• referenceImportJobCompleted

var params = {
  id: 'STRING_VALUE', /* required */
  referenceStoreId: 'STRING_VALUE' /* required */
};
omics.getReferenceMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The reference's ID.

  • referenceStoreId — (String)

    The reference's reference store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The reference's ARN.

    • creationTime — (Date)

      When the reference was created.

    • description — (String)

      The reference's description.

    • files — (map)

      The reference's files.

      • index — (map)

        The files' index.

        • contentLength — (Integer)

          The file's content length.

        • partSize — (Integer)

          The file's part size.

        • totalParts — (Integer)

          The file's total parts.

      • source — (map)

        The source file's location in Amazon S3.

        • contentLength — (Integer)

          The file's content length.

        • partSize — (Integer)

          The file's part size.

        • totalParts — (Integer)

          The file's total parts.

    • id — (String)

      The reference's ID.

    • md5 — (String)

      The reference's MD5 checksum.

    • name — (String)

      The reference's name.

    • referenceStoreId — (String)

      The reference's reference store ID.

    • status — (String)

      The reference's status.

      Possible values include:
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • updateTime — (Date)

      When the reference was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.getReferenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The store's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The store's ARN.

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • sseConfig — (map)

      The store's server-side encryption (SSE) settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  export: [
    DEFINITION,
    /* more items */
  ]
};
omics.getRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • export — (Array<String>)

    The run's export format.

  • id — (String)

    The run's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The run's ARN.

    • creationTime — (Date)

      When the run was created.

    • definition — (String)

      The run's definition.

    • digest — (String)

      The run's digest.

    • id — (String)

      The run's ID.

    • logLevel — (String)

      The run's log level.

      Possible values include:
      • "OFF"
      • "FATAL"
      • "ERROR"
      • "ALL"
    • name — (String)

      The run's name.

    • outputUri — (String)

      The run's output URI.

    • parameters — (map)

      The run's parameters.

    • priority — (Integer)

      The run's priority.

    • resourceDigests — (map<String>)

      The run's resource digests.

    • roleArn — (String)

      The run's service role ARN.

    • runGroupId — (String)

      The run's group ID.

    • runId — (String)

      The run's ID.

    • startTime — (Date)

      When the run started.

    • startedBy — (String)

      Who started the run.

    • status — (String)

      The run's status.

      Possible values include:
      • "PENDING"
      • "STARTING"
      • "RUNNING"
      • "STOPPING"
      • "COMPLETED"
      • "DELETED"
      • "CANCELLED"
      • "FAILED"
    • statusMessage — (String)

      The run's status message.

    • stopTime — (Date)

      The run's stop time.

    • storageCapacity — (Integer)

      The run's storage capacity in gigabytes.

    • tags — (map<String>)

      The run's tags.

    • workflowId — (String)

      The run's workflow ID.

    • workflowType — (String)

      The run's workflow type.

      Possible values include:
      • "PRIVATE"
      • "SERVICE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• runCompleted

• runRunning

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.getRunGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The group's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The group's ARN.

    • creationTime — (Date)

      When the group was created.

    • id — (String)

      The group's ID.

    • maxCpus — (Integer)

      The group's maximum number of CPUs to use.

    • maxDuration — (Integer)

      The group's maximum run time in minutes.

    • maxRuns — (Integer)

      The maximum number of concurrent runs for the group.

    • name — (String)

      The group's name.

    • tags — (map<String>)

      The group's tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  taskId: 'STRING_VALUE' /* required */
};
omics.getRunTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The task's ID.

  • taskId — (String)

    The task's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cpus — (Integer)

      The task's CPU usage.

    • creationTime — (Date)

      When the task was created.

    • logStream — (String)

      The task's log stream.

    • memory — (Integer)

      The task's memory use in gigabytes.

    • name — (String)

      The task's name.

    • startTime — (Date)

      The task's start time.

    • status — (String)

      The task's status.

      Possible values include:
      • "PENDING"
      • "STARTING"
      • "RUNNING"
      • "STOPPING"
      • "COMPLETED"
      • "CANCELLED"
      • "FAILED"
    • statusMessage — (String)

      The task's status message.

    • stopTime — (Date)

      The task's stop time.

    • taskId — (String)

      The task's ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• taskCompleted

• taskRunning

var params = {
  id: 'STRING_VALUE' /* required */
};
omics.getSequenceStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The store's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The store's ARN.

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • sseConfig — (map)

      The store's server-side encryption (SSE) settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE' /* required */
};
omics.getVariantImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The job's ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completionTime — (Date)

      When the job completed.

    • creationTime — (Date)

      When the job was created.

    • destinationName — (String)

      The job's destination variant store.

    • id — (String)

      The job's ID.

    • items — (Array<map>)

      The job's items.

      • jobStatus — required — (String)

        The item's job status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLED"
        • "COMPLETED"
        • "FAILED"
        • "COMPLETED_WITH_FAILURES"
      • source — required — (String)

        The source file's location in Amazon S3.

      • statusMessage — (String)

        A message that provides additional context about a job

    • roleArn — (String)

      The job's service role ARN.

    • runLeftNormalization — (Boolean)

      The job's left normalization setting.

    • status — (String)

      The job's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLED"
      • "COMPLETED"
      • "FAILED"
      • "COMPLETED_WITH_FAILURES"
    • statusMessage — (String)

      The job's status message.

    • updateTime — (Date)

      When the job was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• variantImportJobCreated

var params = {
  name: 'STRING_VALUE' /* required */
};
omics.getVariantStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The store's name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • creationTime — (Date)

      When the store was created.

    • description — (String)

      The store's description.

    • id — (String)

      The store's ID.

    • name — (String)

      The store's name.

    • reference — (map)

      The store's genome reference.

      • referenceArn — (String)

        The reference's ARN.

    • sseConfig — (map)

      The store's server-side encryption (SSE) settings.

      • keyArn — (String)

        An encryption key ARN.

      • type — required — (String)

        The encryption type.

        Possible values include:
        • "KMS"
    • status — (String)

      The store's status.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"
    • statusMessage — (String)

      The store's status message.

    • storeArn — (String)

      The store's ARN.

    • storeSizeBytes — (Integer)

      The store's size in bytes.

    • tags — (map<String>)

      The store's tags.

    • updateTime — (Date)

      When the store was updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• variantStoreCreated

• variantStoreDeleted

var params = {
  id: 'STRING_VALUE', /* required */
  export: [
    DEFINITION,
    /* more items */
  ],
  type: PRIVATE | SERVICE
};
omics.getWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • export — (Array<String>)

    The export format for the workflow.

  • id — (String)

    The workflow's ID.

  • type — (String)

    The workflow's type.

    Possible values include:
    • "PRIVATE"
    • "SERVICE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The workflow's ARN.

    • creationTime — (Date)

      When the workflow was created.

    • definition — (String)

      The workflow's definition.

    • description — (String)

      The workflow's description.

    • digest — (String)

      The workflow's digest.

    • engine — (String)

      The workflow's engine.

      Possible values include:
      • "WDL"
      • "NEXTFLOW"
    • id — (String)

      The workflow's ID.

    • main — (String)

      The path of the main definition file for the workflow.

    • name — (String)

      The workflow's name.

    • parameterTemplate — (map<map>)

      The workflow's parameter template.

      • description — (String)

        The parameter's description.

      • optional — (Boolean)

        Whether the parameter is optional.

    • status — (String)

      The workflow's status.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "UPDATING"
      • "DELETED"
      • "FAILED"
      • "INACTIVE"
    • statusMessage — (String)

      The workflow's status message.

    • storageCapacity — (Integer)

      The workflow's storage capacity in gigabytes.

    • tags — (map<String>)

      The workflow's tags.

    • type — (String)

      The workflow's type.

      Possible values include:
      • "PRIVATE"
      • "SERVICE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• workflowActive

var params = {
  filter: {
    status: SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES,
    storeName: 'STRING_VALUE'
  },
  ids: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listAnnotationImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLED"
      • "COMPLETED"
      • "FAILED"
      • "COMPLETED_WITH_FAILURES"
    • storeName — (String)

      A store name to filter on.

  • ids — (Array<String>)

    IDs of annotation import jobs to retrieve.

  • maxResults — (Integer)

    The maximum number of jobs to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • annotationImportJobs — (Array<map>)

      A list of jobs.

      • completionTime — (Date)

        When the job completed.

      • creationTime — required — (Date)

        When the job was created.

      • destinationName — required — (String)

        The job's destination annotation store.

      • id — required — (String)

        The job's ID.

      • roleArn — required — (String)

        The job's service role ARN.

      • runLeftNormalization — (Boolean)

        The job's left normalization setting.

      • status — required — (String)

        The job's status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLED"
        • "COMPLETED"
        • "FAILED"
        • "COMPLETED_WITH_FAILURES"
      • updateTime — required — (Date)

        When the job was updated.

    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  filter: {
    status: CREATING | UPDATING | DELETING | ACTIVE | FAILED
  },
  ids: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listAnnotationStores(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"
  • ids — (Array<String>)

    IDs of stores to list.

  • maxResults — (Integer)

    The maximum number of stores to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • annotationStores — (Array<map>)

      A list of stores.

      • creationTime — required — (Date)

        The store's creation time.

      • description — required — (String)

        The store's description.

      • id — required — (String)

        The store's ID.

      • name — required — (String)

        The store's name.

      • reference — required — (map)

        The store's genome reference.

        • referenceArn — (String)

          The reference's ARN.

      • sseConfig — required — (map)

        The store's server-side encryption (SSE) settings.

        • keyArn — (String)

          An encryption key ARN.

        • type — required — (String)

          The encryption type.

          Possible values include:
          • "KMS"
      • status — required — (String)

        The store's status.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "FAILED"
      • statusMessage — required — (String)

        The store's status message.

      • storeArn — required — (String)

        The store's ARN.

      • storeFormat — required — (String)

        The store's file format.

        Possible values include:
        • "GFF"
        • "TSV"
        • "VCF"
      • storeSizeBytes — required — (Integer)

        The store's size in bytes.

      • updateTime — required — (Date)

        When the store was updated.

    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    status: SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReadSetActivationJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • status — (String)

      The filter's status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
  • maxResults — (Integer)

    The maximum number of read set activation jobs to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • sequenceStoreId — (String)

    The read set's sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • activationJobs — (Array<map>)

      A list of jobs.

      • completionTime — (Date)

        When the job completed.

      • creationTime — required — (Date)

        When the job was created.

      • id — required — (String)

        The job's ID.

      • sequenceStoreId — required — (String)

        The job's sequence store ID.

      • status — required — (String)

        The job's status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "COMPLETED"
        • "COMPLETED_WITH_FAILURES"
    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    status: SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReadSetExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
  • maxResults — (Integer)

    The maximum number of jobs to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • sequenceStoreId — (String)

    The jobs' sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • exportJobs — (Array<map>)

      A list of jobs.

      • completionTime — (Date)

        When the job completed.

      • creationTime — required — (Date)

        When the job was created.

      • destination — required — (String)

        The job's destination in Amazon S3.

      • id — required — (String)

        The job's ID.

      • sequenceStoreId — required — (String)

        The job's sequence store ID.

      • status — required — (String)

        The job's status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "COMPLETED"
        • "COMPLETED_WITH_FAILURES"
    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    status: SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReadSetImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
  • maxResults — (Integer)

    The maximum number of jobs to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • sequenceStoreId — (String)

    The jobs' sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • importJobs — (Array<map>)

      A list of jobs.

      • completionTime — (Date)

        When the job completed.

      • creationTime — required — (Date)

        When the job was created.

      • id — required — (String)

        The job's ID.

      • roleArn — required — (String)

        The job's service role ARN.

      • sequenceStoreId — required — (String)

        The job's sequence store ID.

      • status — required — (String)

        The job's status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "COMPLETED"
        • "COMPLETED_WITH_FAILURES"
    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    name: 'STRING_VALUE',
    referenceArn: 'STRING_VALUE',
    status: ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReadSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • name — (String)

      A name to filter on.

    • referenceArn — (String)

      A genome reference ARN to filter on.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "ARCHIVED"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
  • maxResults — (Integer)

    The maximum number of read sets to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • sequenceStoreId — (String)

    The jobs' sequence store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A pagination token that's included if more results are available.

    • readSets — (Array<map>)

      A list of read sets.

      • arn — required — (String)

        The read set's ARN.

      • creationTime — required — (Date)

        When the read set was created.

      • description — (String)

        The read set's description.

      • fileType — required — (String)

        The read set's file type.

        Possible values include:
        • "FASTQ"
        • "BAM"
        • "CRAM"
      • id — required — (String)

        The read set's ID.

      • name — (String)

        The read set's name.

      • referenceArn — (String)

        The read set's genome reference ARN.

      • sampleId — (String)

        The read set's sample ID.

      • sequenceInformation — (map)

        Details about a sequence.

        • alignment — (String)

          The sequence's alignment setting.

        • generatedFrom — (String)

          Where the sequence originated.

        • totalBaseCount — (Integer)

          The sequence's total base count.

        • totalReadCount — (Integer)

          The sequence's total read count.

      • sequenceStoreId — required — (String)

        The read set's sequence store ID.

      • status — required — (String)

        The read set's status.

        Possible values include:
        • "ARCHIVED"
        • "ACTIVATING"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"
      • subjectId — (String)

        The read set's subject ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  referenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    status: SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReferenceImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • status — (String)

      A status to filter on.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELLING"
      • "CANCELLED"
      • "FAILED"
      • "COMPLETED"
      • "COMPLETED_WITH_FAILURES"
  • maxResults — (Integer)

    The maximum number of jobs to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • referenceStoreId — (String)

    The job's reference store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • importJobs — (Array<map>)

      A lis of jobs.

      • completionTime — (Date)

        When the job completed.

      • creationTime — required — (Date)

        When the job was created.

      • id — required — (String)

        The job's ID.

      • referenceStoreId — required — (String)

        The job's reference store ID.

      • roleArn — required — (String)

        The job's service role ARN.

      • status — required — (String)

        The job's status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "COMPLETED"
        • "COMPLETED_WITH_FAILURES"
    • nextToken — (String)

      A pagination token that's included if more results are available.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  referenceStoreId: 'STRING_VALUE', /* required */
  filter: {
    createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    md5: 'STRING_VALUE',
    name: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filter — (map)

    A filter to apply to the list.

    • createdAfter — (Date)

      The filter's start date.

    • createdBefore — (Date)

      The filter's end date.

    • md5 — (String)

      An MD5 checksum to filter on.

    • name — (String)

      A name to filter on.

  • maxResults — (Integer)

    The maximum number of references to return in one page of results.

  • nextToken — (String)

    Specify the pagination token from a previous request to retrieve the next page of results.

  • referenceStoreId — (String)

    The references' reference store ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A pagination token that's included if more results are available.

    • references — (Array<map>)

      A list of references.

      • arn — required — (String)

        The reference's ARN.

      • creationTime — required — (Date)

        When the reference was created.

      • description — (String)

        The reference's description.

      • id — required — (String)

        The reference's ID.

      • md5 — required — (String)

        The reference's MD5 checksum.

      • name — (String)

        The reference's name.

      • referenceStoreId — required — (String)

        The reference's store ID.

      • status — (String)

        The reference's status.

        Possible values include:
        • "ACTIVE"
        • "DELETING"
        • "DELETED"
      • updateTime — required — (Date)

        When the reference was updated.