Class: AWS.Omics

var params = {
  shareId: 'STRING_VALUE' /* required */
};
omics.acceptShare(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: {}) —
  • shareId — (String)

    The ID of the resource share.

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 status of the resource share.

      Possible values include:
      • "PENDING"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  ids: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  sequenceStoreId: 'STRING_VALUE' /* required */
};
omics.batchDeleteReadSet(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: {}) —
  • ids — (Array<String>)

    The read sets' IDs.

  • sequenceStoreId — (String)

    The read sets' 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:

    • errors — (Array<map>)

      Errors returned by individual delete operations.

      • id — required — (String)

        The error's ID.

      • code — required — (String)

        The error's code.

      • message — required — (String)

        The error's message.

Returns:

• (AWS.Request) —

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

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 = {
  parts: [ /* required */
    {
      checksum: 'STRING_VALUE', /* required */
      partNumber: 'NUMBER_VALUE', /* required */
      partSource: SOURCE1 | SOURCE2 /* required */
    },
    /* more items */
  ],
  sequenceStoreId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE' /* required */
};
omics.completeMultipartReadSetUpload(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: {}) —
  • sequenceStoreId — (String)

    The sequence store ID for the store involved in the multipart upload.

  • uploadId — (String)

    The ID for the multipart upload.

  • parts — (Array<map>)

    The individual uploads or parts of a multipart upload.

    • partNumber — required — (Integer)

      A number identifying the part in a read set upload.

    • partSource — required — (String)

      The source file of the part being uploaded.

      Possible values include:
      • "SOURCE1"
      • "SOURCE2"
    • checksum — required — (String)

      A unique identifier used to confirm that parts are being added to the correct upload.

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:

    • readSetId — (String)

      The read set ID created for an uploaded read set.

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>': ... */
  },
  versionName: 'STRING_VALUE'
};
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: {}) —
  • reference — (map)

    The genome reference for the store's annotations.

    • referenceArn — (String)

      The reference's ARN.

  • name — (String)

    A name for the store.

  • description — (String)

    A description for the store.

  • tags — (map<String>)

    Tags for the store.

  • versionName — (String)

    The name given to an annotation store version to distinguish it from other versions.

  • sseConfig — (map)

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

    • type — required — (String)

      The encryption type.

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

      An encryption key ARN.

  • 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.

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:

    • id — (String)

      The store's ID.

    • reference — (map)

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

      • referenceArn — (String)

        The reference's ARN.

    • 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.

    • status — (String)

      The store's status.

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

      The store's name.

    • versionName — (String)

      The name given to an annotation store version to distinguish it from other versions.

    • creationTime — (Date)

      When the store was created.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  versionName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  versionOptions: {
    tsvVersionOptions: {
      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 */
      ]
    }
  }
};
omics.createAnnotationStoreVersion(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 name of an annotation store version from which versions are being created.

  • versionName — (String)

    The name given to an annotation store version to distinguish it from other versions.

  • description — (String)

    The description of an annotation store version.

  • versionOptions — (map)

    The options for an annotation store version.

    • tsvVersionOptions — (map)

      File settings for a version of a TSV store.

      • annotationType — (String)

        The store version'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 annotation store version's header key to column name mapping.

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

        The TSV schema for an annotation store version.

  • tags — (map<String>)

    Any tags added to annotation store version.

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:

    • id — (String)

      A generated ID for the annotation store

    • versionName — (String)

      The name given to an annotation store version to distinguish it from other versions.

    • storeId — (String)

      The ID for the annotation store from which new versions are being created.

    • versionOptions — (map)

      The options for an annotation store version.

      • tsvVersionOptions — (map)

        File settings for a version of a TSV store.

        • annotationType — (String)

          The store version'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 annotation store version's header key to column name mapping.

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

          The TSV schema for an annotation store version.

    • name — (String)

      The name given to an annotation store version to distinguish it from other versions.

    • status — (String)

      The status of a annotation store version.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "ACTIVE"
      • "FAILED"
    • creationTime — (Date)

      The time stamp for the creation of an annotation store version.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  sampleId: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  sourceFileType: FASTQ | BAM | CRAM | UBAM, /* required */
  subjectId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  generatedFrom: 'STRING_VALUE',
  referenceArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.createMultipartReadSetUpload(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: {}) —
  • sequenceStoreId — (String)

    The sequence store ID for the store that is the destination of the multipart uploads.

  • clientToken — (String)

    An idempotency token that can be used to avoid triggering multiple multipart uploads.

  • sourceFileType — (String)

    The type of file being uploaded.

    Possible values include:
    • "FASTQ"
    • "BAM"
    • "CRAM"
    • "UBAM"
  • subjectId — (String)

    The source's subject ID.

  • sampleId — (String)

    The source's sample ID.

  • generatedFrom — (String)

    Where the source originated.

  • referenceArn — (String)

    The ARN of the reference.

  • name — (String)

    The name of the read set.

  • description — (String)

    The description of the read set.

  • tags — (map<String>)

    Any tags to add to the read set.

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:

    • sequenceStoreId — (String)

      The sequence store ID for the store that the read set will be created in.

    • uploadId — (String)

      The ID for the initiated multipart upload.

    • sourceFileType — (String)

      The file type of the read set source.

      Possible values include:
      • "FASTQ"
      • "BAM"
      • "CRAM"
      • "UBAM"
    • subjectId — (String)

      The source's subject ID.

    • sampleId — (String)

      The source's sample ID.

    • generatedFrom — (String)

      The source of the read set.

    • referenceArn — (String)

      The read set source's reference ARN.

    • name — (String)

      The name of the read set.

    • description — (String)

      The description of the read set.

    • tags — (map<String>)

      The tags to add to the read set.

    • creationTime — (Date)

      The creation time of the multipart upload.

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: {}) —
  • name — (String)

    A name for the store.

  • description — (String)

    A description for the store.

  • sseConfig — (map)

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

    • type — required — (String)

      The encryption type.

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

      An encryption key ARN.

  • tags — (map<String>)

    Tags for the store.

  • clientToken — (String)

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

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:

    • id — (String)

      The store's ID.

    • arn — (String)

      The store's ARN.

    • name — (String)

      The store's name.

    • description — (String)

      The store's description.

    • sseConfig — (map)

      The store's SSE settings.

      • type — required — (String)

        The encryption type.

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

        An encryption key ARN.

    • creationTime — (Date)

      When the store was created.

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',
  maxGpus: '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: {}) —
  • name — (String)

    A name for the group.

  • maxCpus — (Integer)

    The maximum number of CPUs that can run concurrently across all active runs in the run group.

  • maxRuns — (Integer)

    The maximum number of runs that can be running at the same time.

  • maxDuration — (Integer)

    The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.

  • tags — (map<String>)

    Tags 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.
  • maxGpus — (Integer)

    The maximum number of GPUs that can run concurrently across all active runs in the run 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',
  eTagAlgorithmFamily: MD5up | SHA256up | SHA512up,
  fallbackLocation: '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: {}) —
  • name — (String)

    A name for the store.

  • description — (String)

    A description for the store.

  • sseConfig — (map)

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

    • type — required — (String)

      The encryption type.

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

      An encryption key ARN.

  • tags — (map<String>)

    Tags for the store.

  • clientToken — (String)

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

  • fallbackLocation — (String)

    An S3 location that is used to store files that have failed a direct upload.

  • eTagAlgorithmFamily — (String)

    The ETag algorithm family to use for ingested read sets.

    Possible values include:
    • "MD5up"
    • "SHA256up"
    • "SHA512up"

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:

    • id — (String)

      The store's ID.

    • arn — (String)

      The store's ARN.

    • name — (String)

      The store's name.

    • description — (String)

      The store's description.

    • sseConfig — (map)

      The store's SSE settings.

      • type — required — (String)

        The encryption type.

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

        An encryption key ARN.

    • creationTime — (Date)

      When the store was created.

    • fallbackLocation — (String)

      An S3 location that is used to store files that have failed a direct upload.

    • eTagAlgorithmFamily — (String)

      The algorithm family of the ETag.

      Possible values include:
      • "MD5up"
      • "SHA256up"
      • "SHA512up"

Returns:

• (AWS.Request) —

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

var params = {
  principalSubscriber: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE', /* required */
  shareName: 'STRING_VALUE'
};
omics.createShare(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: {}) —
  • resourceArn — (String)

    The ARN of the resource to be shared.

  • principalSubscriber — (String)

    The principal subscriber is the account being offered shared access to the resource.

  • shareName — (String)

    A name that the owner defines for the share.

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:

    • shareId — (String)

      The ID that HealthOmics generates for the share.

    • status — (String)

      The status of the share.

      Possible values include:
      • "PENDING"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "FAILED"
    • shareName — (String)

      The name of the share.

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: {}) —
  • reference — (map)

    The genome reference for the store's variants.

    • referenceArn — (String)

      The reference's ARN.

  • name — (String)

    A name for the store.

  • description — (String)

    A description for the store.

  • tags — (map<String>)

    Tags for the store.

  • sseConfig — (map)

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

    • type — required — (String)

      The encryption type.

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

      An encryption key ARN.

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:

    • id — (String)

      The store's ID.

    • 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"
    • name — (String)

      The store's name.

    • creationTime — (Date)

      When the store was created.

Returns:

• (AWS.Request) —

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

var params = {
  requestId: 'STRING_VALUE', /* required */
  accelerators: GPU,
  definitionUri: 'STRING_VALUE',
  definitionZip: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  description: 'STRING_VALUE',
  engine: WDL | NEXTFLOW | CWL,
  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: {}) —
  • name — (String)

    A name for the workflow.

  • description — (String)

    A description for the workflow.

  • engine — (String)

    An engine for the workflow.

    Possible values include:
    • "WDL"
    • "NEXTFLOW"
    • "CWL"
  • definitionZip — (Buffer, Typed Array, Blob, String)

    A ZIP archive for the workflow.

  • definitionUri — (String)

    The URI of a definition for the workflow.

  • main — (String)

    The path of the main definition file 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.

  • storageCapacity — (Integer)

    The default storage capacity for the workflow runs, in gibibytes.

  • tags — (map<String>)

    Tags for the workflow.

  • 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.
  • accelerators — (String)

    The computational accelerator specified to run the workflow.

    Possible values include:
    • "GPU"

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: {}) —
  • name — (String)

    The store's name.

  • force — (Boolean)

    Whether to force deletion.

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 = {
  name: 'STRING_VALUE', /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  force: true || false
};
omics.deleteAnnotationStoreVersions(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 name of the annotation store from which versions are being deleted.

  • versions — (Array<String>)

    The versions of an annotation store to be deleted.

  • force — (Boolean)

    Forces the deletion of an annotation store version when imports are in-progress..

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:

    • errors — (Array<map>)

      Any errors that occur when attempting to delete an annotation store version.

      • versionName — required — (String)

        The name given to an annotation store version.

      • message — required — (String)

        The message explaining the error in annotation store deletion.

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 = {
  shareId: 'STRING_VALUE' /* required */
};
omics.deleteShare(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: {}) —
  • shareId — (String)

    The ID for the resource share to be deleted.

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 status of the share being deleted.

      Possible values include:
      • "PENDING"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "FAILED"

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: {}) —
  • name — (String)

    The store's name.

  • force — (Boolean)

    Whether to force deletion.

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:

    • id — (String)

      The job's ID.

    • destinationName — (String)

      The job's destination annotation store.

    • versionName — (String)

      The name of the annotation store version.

    • roleArn — (String)

      The job's service role ARN.

    • 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.

    • creationTime — (Date)

      When the job was created.

    • updateTime — (Date)

      When the job was updated.

    • completionTime — (Date)

      When the job completed.

    • items — (Array<map>)

      The job's imported items.

      • source — required — (String)

        The source file's location in Amazon S3.

      • jobStatus — required — (String)

        The item's job status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELLED"
        • "COMPLETED"
        • "FAILED"
        • "COMPLETED_WITH_FAILURES"
    • runLeftNormalization — (Boolean)

      The job's left normalization setting.

    • formatOptions — (map)

      Formatting options for a file.

      • tsvOptions — (map)

        Options for a TSV file.

        • readOptions — (map)

          The file's read options.

          • sep — (String)

            The file's field separator.

          • encoding — (String)

            The file's encoding.

          • quote — (String)

            The file's quote character.

          • quoteAll — (Boolean)

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

          • escape — (String)

            A character for escaping quotes in the file.

          • escapeQuotes — (Boolean)

            Whether quotes need to be escaped in the file.

          • comment — (String)

            The file's comment character.

          • header — (Boolean)

            Whether the file has a header row.

          • lineSep — (String)

            A line separator for the file.

      • vcfOptions — (map)

        Options for a VCF file.

        • ignoreQualField — (Boolean)

          The file's ignore qual field setting.

        • ignoreFilterField — (Boolean)

          The file's ignore filter field setting.

    • annotationFields — (map<String>)

      The annotation schema generated by the parsed annotation data.

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:

    • id — (String)

      The store's ID.

    • 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"
    • storeArn — (String)

      The store's ARN.

    • name — (String)

      The store's name.

    • description — (String)

      The store's description.

    • sseConfig — (map)

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

      • type — required — (String)

        The encryption type.

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

        An encryption key ARN.

    • creationTime — (Date)

      When the store was created.

    • updateTime — (Date)

      When the store was updated.

    • tags — (map<String>)

      The store's tags.

    • 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.

    • storeFormat — (String)

      The store's annotation file format.

      Possible values include:
      • "GFF"
      • "TSV"
      • "VCF"
    • statusMessage — (String)

      A status message.

    • storeSizeBytes — (Integer)

      The store's size in bytes.

    • numVersions — (Integer)

      An integer indicating how many versions of an annotation store exist.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• annotationStoreCreated

• annotationStoreDeleted

var params = {
  name: 'STRING_VALUE', /* required */
  versionName: 'STRING_VALUE' /* required */
};
omics.getAnnotationStoreVersion(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 name given to an annotation store version to distinguish it from others.

  • versionName — (String)

    The name given to an annotation store version to distinguish it from others.

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:

    • storeId — (String)

      The store ID for annotation store version.

    • id — (String)

      The annotation store version ID.

    • status — (String)

      The status of an annotation store version.

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

      The Arn for the annotation store.

    • name — (String)

      The name of the annotation store.

    • versionName — (String)

      The name given to an annotation store version to distinguish it from others.

    • description — (String)

      The description for an annotation store version.

    • creationTime — (Date)

      The time stamp for when an annotation store version was created.

    • updateTime — (Date)

      The time stamp for when an annotation store version was updated.

    • tags — (map<String>)

      Any tags associated with an annotation store version.

    • versionOptions — (map)

      The options for an annotation store version.

      • tsvVersionOptions — (map)

        File settings for a version of a TSV store.

        • annotationType — (String)

          The store version'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 annotation store version's header key to column name mapping.

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

          The TSV schema for an annotation store version.

    • statusMessage — (String)

      The status of an annotation store version.

    • versionSizeBytes — (Integer)

      The size of the annotation store version in Bytes.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• annotationStoreVersionCreated

• annotationStoreVersionDeleted

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: {}) —
  • id — (String)

    The read set's ID.

  • sequenceStoreId — (String)

    The read set's sequence store ID.

  • file — (String)

    The file to retrieve.

    Possible values include:
    • "SOURCE1"
    • "SOURCE2"
    • "INDEX"
  • partNumber — (Integer)

    The part number to retrieve.

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:

    • id — (String)

      The job's ID.

    • 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.

    • creationTime — (Date)

      When the job was created.

    • completionTime — (Date)

      When the job completed.

    • 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.

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: {}) —
  • sequenceStoreId — (String)

    The job's sequence store ID.

  • id — (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:

    • id — (String)

      The job's ID.

    • sequenceStoreId — (String)

      The job's sequence store ID.

    • destination — (String)

      The job's destination in Amazon S3.

    • 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.

    • creationTime — (Date)

      When the job was created.

    • completionTime — (Date)

      When the job completed.

    • 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.

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:

    • id — (String)

      The job's ID.

    • sequenceStoreId — (String)

      The job's sequence store ID.

    • roleArn — (String)

      The job's service role ARN.

    • 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.

    • creationTime — (Date)

      When the job was created.

    • completionTime — (Date)

      When the job completed.

    • sources — (Array<map>)

      The job's source files.

      • 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.

      • sourceFileType — required — (String)

        The source's file type.

        Possible values include:
        • "FASTQ"
        • "BAM"
        • "CRAM"
        • "UBAM"
      • 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.

      • sampleId — required — (String)

        The source's sample ID.

      • generatedFrom — (String)

        Where the source originated.

      • referenceArn — (String)

        The source's genome reference ARN.

      • name — (String)

        The source's name.

      • description — (String)

        The source's description.

      • tags — (map<String>)

        The source's tags.

      • readSetId — (String)

        The source's read set ID.

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:

    • id — (String)

      The read set's ID.

    • arn — (String)

      The read set's ARN.

    • sequenceStoreId — (String)

      The read set's sequence store ID.

    • subjectId — (String)

      The read set's subject ID.

    • sampleId — (String)

      The read set's sample ID.

    • status — (String)

      The read set's status.

      Possible values include:
      • "ARCHIVED"
      • "ACTIVATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "PROCESSING_UPLOAD"
      • "UPLOAD_FAILED"
    • name — (String)

      The read set's name.

    • description — (String)

      The read set's description.

    • fileType — (String)

      The read set's file type.

      Possible values include:
      • "FASTQ"
      • "BAM"
      • "CRAM"
      • "UBAM"
    • creationTime — (Date)

      When the read set was created.

    • sequenceInformation — (map)

      The read set's sequence information.

      • totalReadCount — (Integer)

        The sequence's total read count.

      • totalBaseCount — (Integer)

        The sequence's total base count.

      • generatedFrom — (String)

        Where the sequence originated.

      • alignment — (String)

        The sequence's alignment setting.

    • referenceArn — (String)

      The read set's genome reference ARN.

    • files — (map)

      The read set's files.

      • source1 — (map)

        The location of the first file in Amazon S3.

        • totalParts — (Integer)

          The file's total parts.

        • partSize — (Integer)

          The file's part size.

        • contentLength — (Integer)

          The file's content length.

        • s3Access — (map)

          The S3 URI metadata of a sequence store.

          • s3Uri — (String)

            The S3 URI for each read set file.

      • source2 — (map)

        The location of the second file in Amazon S3.

        • totalParts — (Integer)

          The file's total parts.

        • partSize — (Integer)

          The file's part size.

        • contentLength — (Integer)

          The file's content length.

        • s3Access — (map)

          The S3 URI metadata of a sequence store.

          • s3Uri — (String)

            The S3 URI for each read set file.

      • index — (map)

        The files' index.

        • totalParts — (Integer)

          The file's total parts.

        • partSize — (Integer)

          The file's part size.

        • contentLength — (Integer)

          The file's content length.

        • s3Access — (map)

          The S3 URI metadata of a sequence store.

          • s3Uri — (String)

            The S3 URI for each read set file.

    • statusMessage — (String)

      The status message for a read set. It provides more detail as to why the read set has a status.

    • creationType — (String)

      The creation type of the read set.

      Possible values include:
      • "IMPORT"
      • "UPLOAD"
    • etag — (map)

      The entity tag (ETag) is a hash of the object meant to represent its semantic content.

      • algorithm — (String)

        The algorithm used to calculate the read set’s ETag(s).

        Possible values include:
        • "FASTQ_MD5up"
        • "BAM_MD5up"
        • "CRAM_MD5up"
        • "FASTQ_SHA256up"
        • "BAM_SHA256up"
        • "CRAM_SHA256up"
        • "FASTQ_SHA512up"
        • "BAM_SHA512up"
        • "CRAM_SHA512up"
      • source1 — (String)

        The ETag hash calculated on Source1 of the read set.

      • source2 — (String)

        The ETag hash calculated on Source2 of the read set.

    • creationJobId — (String)

      The read set's creation job 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: {}) —
  • id — (String)

    The reference's ID.

  • referenceStoreId — (String)

    The reference's store ID.

  • range — (String)

    The range to retrieve.

  • partNumber — (Integer)

    The part number to retrieve.

  • file — (String)

    The file to retrieve.

    Possible values include:
    • "SOURCE"
    • "INDEX"

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:

    • id — (String)

      The job's ID.

    • referenceStoreId — (String)

      The job's reference store ID.

    • roleArn — (String)

      The job's service role ARN.

    • 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.

    • creationTime — (Date)

      When the job was created.

    • completionTime — (Date)

      When the job completed.

    • sources — (Array<map>)

      The job's source files.

      • 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.

      • name — (String)

        The source's name.

      • description — (String)

        The source's description.

      • tags — (map<String>)

        The source's tags.

      • referenceId — (String)

        The source's reference ID.

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:

    • id — (String)

      The reference's ID.

    • arn — (String)

      The reference's ARN.

    • referenceStoreId — (String)

      The reference's reference store ID.

    • md5 — (String)

      The reference's MD5 checksum.

    • status — (String)

      The reference's status.

      Possible values include:
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • name — (String)

      The reference's name.

    • description — (String)

      The reference's description.

    • creationTime — (Date)

      When the reference was created.

    • updateTime — (Date)

      When the reference was updated.

    • files — (map)

      The reference's files.

      • source — (map)

        The source file's location in Amazon S3.

        • totalParts — (Integer)

          The file's total parts.

        • partSize — (Integer)

          The file's part size.

        • contentLength — (Integer)

          The file's content length.

        • s3Access — (map)

          The S3 URI metadata of a sequence store.

          • s3Uri — (String)

            The S3 URI for each read set file.

      • index — (map)

        The files' index.

        • totalParts — (Integer)

          The file's total parts.

        • partSize — (Integer)

          The file's part size.

        • contentLength — (Integer)

          The file's content length.

        • s3Access — (map)

          The S3 URI metadata of a sequence store.

          • s3Uri — (String)

            The S3 URI for each read set file.

    • creationType — (String)

      The reference's creation type.

      Possible values include:
      • "IMPORT"
    • creationJobId — (String)

      The reference's creation job ID.

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:

    • id — (String)

      The store's ID.

    • arn — (String)

      The store's ARN.

    • name — (String)

      The store's name.

    • description — (String)

      The store's description.

    • sseConfig — (map)

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

      • type — required — (String)

        The encryption type.

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

        An encryption key ARN.

    • creationTime — (Date)

      When the store was created.

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: {}) —
  • id — (String)

    The run's ID.

  • export — (Array<String>)

    The run's export format.

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.

    • id — (String)

      The run's ID.

    • status — (String)

      The run's status.

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

      The run's workflow ID.

    • workflowType — (String)

      The run's workflow type.

      Possible values include:
      • "PRIVATE"
      • "READY2RUN"
    • runId — (String)

      The run's ID.

    • roleArn — (String)

      The run's service role ARN.

    • name — (String)

      The run's name.

    • runGroupId — (String)

      The run's group ID.

    • priority — (Integer)

      The run's priority.

    • definition — (String)

      The run's definition.

    • digest — (String)

      The run's digest.

    • parameters — (map)

      The run's parameters.

    • storageCapacity — (Integer)

      The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

    • outputUri — (String)

      The run's output URI.

    • logLevel — (String)

      The run's log level.

      Possible values include:
      • "OFF"
      • "FATAL"
      • "ERROR"
      • "ALL"
    • resourceDigests — (map<String>)

      The run's resource digests.

    • startedBy — (String)

      Who started the run.

    • creationTime — (Date)

      When the run was created.

    • startTime — (Date)

      When the run started.

    • stopTime — (Date)

      The run's stop time.

    • statusMessage — (String)

      The run's status message.

    • tags — (map<String>)

      The run's tags.

    • accelerators — (String)

      The computational accelerator used to run the workflow.

      Possible values include:
      • "GPU"
    • retentionMode — (String)

      The run's retention mode.

      Possible values include:
      • "RETAIN"
      • "REMOVE"
    • failureReason — (String)

      The reason a run has failed.

    • logLocation — (map)

      The location of the run log.

      • engineLogStream — (String)

        The log stream ARN for the engine log.

      • runLogStream — (String)

        The log stream ARN for the run log.

    • uuid — (String)

      The universally unique identifier for a run.

    • runOutputUri — (String)

      The destination for workflow outputs.

    • storageType — (String)

      The run's storage type.

      Possible values include:
      • "STATIC"
      • "DYNAMIC"
    • workflowOwnerId — (String)

      The ID of the workflow owner.

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.

    • id — (String)

      The group's ID.

    • name — (String)

      The group's name.

    • maxCpus — (Integer)

      The group's maximum number of CPUs to use.

    • maxRuns — (Integer)

      The maximum number of concurrent runs for the group.

    • maxDuration — (Integer)

      The group's maximum run time in minutes.

    • creationTime — (Date)

      When the group was created.

    • tags — (map<String>)

      The group's tags.

    • maxGpus — (Integer)

      The maximum GPUs that can be used by a run group.

Returns:

• (AWS.Request) —

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