We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Omics

Inherits:
AWS.Service show all
Identifier:
omics
API Version:
2022-11-28
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

Sending a Request Using Omics

var omics = new AWS.Omics();
omics.abortMultipartReadSetUpload(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Omics object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var omics = new AWS.Omics({apiVersion: '2022-11-28'});

You can also set the API version globally in AWS.config.apiVersions using the omics service identifier:

AWS.config.apiVersions = {
  omics: '2022-11-28',
  // other service API versions
};

var omics = new AWS.Omics();

Version:

  • 2022-11-28

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

annotationImportJobCreated, annotationStoreCreated, annotationStoreDeleted, annotationStoreVersionCreated, annotationStoreVersionDeleted, readSetActivationJobCompleted, readSetExportJobCompleted, readSetImportJobCompleted, referenceImportJobCompleted, runCompleted, runRunning, taskCompleted, taskRunning, variantImportJobCreated, variantStoreCreated, variantStoreDeleted, workflowActive

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Omics(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Omics object

var omics = new AWS.Omics({apiVersion: '2022-11-28'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Omics.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Omics.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Omics.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

abortMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Stops a multipart upload.

Service Reference:

Examples:

Calling the abortMultipartReadSetUpload operation

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE' /* required */
};
omics.abortMultipartReadSetUpload(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.

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.

acceptShare(params = {}, callback) ⇒ AWS.Request

Accept a resource share request.

Service Reference:

Examples:

Calling the acceptShare operation

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.

batchDeleteReadSet(params = {}, callback) ⇒ AWS.Request

Deletes one or more read sets.

Service Reference:

Examples:

Calling the batchDeleteReadSet operation

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.

        • idrequired — (String)

          The error's ID.

        • coderequired — (String)

          The error's code.

        • messagerequired — (String)

          The error's message.

Returns:

  • (AWS.Request)

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

cancelAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Cancels an annotation import job.

Service Reference:

Examples:

Calling the cancelAnnotationImportJob operation

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.

cancelRun(params = {}, callback) ⇒ AWS.Request

Cancels a run.

Service Reference:

Examples:

Calling the cancelRun operation

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.

cancelVariantImportJob(params = {}, callback) ⇒ AWS.Request

Cancels a variant import job.

Service Reference:

Examples:

Calling the cancelVariantImportJob operation

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.

completeMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Concludes a multipart upload once you have uploaded all the components.

Service Reference:

Examples:

Calling the completeMultipartReadSetUpload operation

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.

      • partNumberrequired — (Integer)

        A number identifying the part in a read set upload.

      • partSourcerequired — (String)

        The source file of the part being uploaded.

        Possible values include:
        • "SOURCE1"
        • "SOURCE2"
      • checksumrequired — (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.

createAnnotationStore(params = {}, callback) ⇒ AWS.Request

Creates an annotation store.

Service Reference:

Examples:

Calling the createAnnotationStore operation

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.

      • typerequired — (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.

createAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of an annotation store.

Service Reference:

Examples:

Calling the createAnnotationStoreVersion operation

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.

createMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Begins a multipart read set upload.

Service Reference:

Examples:

Calling the createMultipartReadSetUpload operation

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.

createReferenceStore(params = {}, callback) ⇒ AWS.Request

Creates a reference store.

Service Reference:

Examples:

Calling the createReferenceStore operation

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.

      • typerequired — (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.

        • typerequired — (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.

createRunGroup(params = {}, callback) ⇒ AWS.Request

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

Service Reference:

Examples:

Calling the createRunGroup operation

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.

createSequenceStore(params = {}, callback) ⇒ AWS.Request

Creates a sequence store.

Service Reference:

Examples:

Calling the createSequenceStore operation

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.

      • typerequired — (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.

        • typerequired — (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.

createShare(params = {}, callback) ⇒ AWS.Request

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

  • HealthOmics variant stores

  • HealthOmics annotation stores

  • Private workflows

Service Reference:

Examples:

Calling the createShare operation

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.

createVariantStore(params = {}, callback) ⇒ AWS.Request

Creates a variant store.

Service Reference:

Examples:

Calling the createVariantStore operation

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.

      • typerequired — (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.

createWorkflow(params = {}, callback) ⇒ AWS.Request

Creates a workflow.

Service Reference:

Examples:

Calling the createWorkflow operation

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.

deleteAnnotationStore(params = {}, callback) ⇒ AWS.Request

Deletes an annotation store.

Service Reference:

Examples:

Calling the deleteAnnotationStore operation

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.

deleteAnnotationStoreVersions(params = {}, callback) ⇒ AWS.Request

Deletes one or multiple versions of an annotation store.

Service Reference:

Examples:

Calling the deleteAnnotationStoreVersions operation

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.

        • versionNamerequired — (String)

          The name given to an annotation store version.

        • messagerequired — (String)

          The message explaining the error in annotation store deletion.

Returns:

  • (AWS.Request)

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

deleteReference(params = {}, callback) ⇒ AWS.Request

Deletes a genome reference.

Service Reference:

Examples:

Calling the deleteReference operation

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.

deleteReferenceStore(params = {}, callback) ⇒ AWS.Request

Deletes a genome reference store.

Service Reference:

Examples:

Calling the deleteReferenceStore operation

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.

deleteRun(params = {}, callback) ⇒ AWS.Request

Deletes a workflow run.

Service Reference:

Examples:

Calling the deleteRun operation

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.

deleteRunGroup(params = {}, callback) ⇒ AWS.Request

Deletes a workflow run group.

Service Reference:

Examples:

Calling the deleteRunGroup operation

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.

deleteSequenceStore(params = {}, callback) ⇒ AWS.Request

Deletes a sequence store.

Service Reference:

Examples:

Calling the deleteSequenceStore operation

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.

deleteShare(params = {}, callback) ⇒ AWS.Request

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

Service Reference:

Examples:

Calling the deleteShare operation

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.

deleteVariantStore(params = {}, callback) ⇒ AWS.Request

Deletes a variant store.

Service Reference:

Examples:

Calling the deleteVariantStore operation

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.

deleteWorkflow(params = {}, callback) ⇒ AWS.Request

Deletes a workflow.

Service Reference:

Examples:

Calling the deleteWorkflow operation

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.

getAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about an annotation import job.

Service Reference:

Examples:

Calling the getAnnotationImportJob operation

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.

        • sourcerequired — (String)

          The source file's location in Amazon S3.

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

getAnnotationStore(params = {}, callback) ⇒ AWS.Request

Gets information about an annotation store.

Service Reference:

Examples:

Calling the getAnnotationStore operation

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.

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

getAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Retrieves the metadata for an annotation store version.

Service Reference:

Examples:

Calling the getAnnotationStoreVersion operation

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:

getReadSet(params = {}, callback) ⇒ AWS.Request

Gets a file from a read set.

Service Reference:

Examples:

Calling the getReadSet operation

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.

getReadSetActivationJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set activation job.

Service Reference:

Examples:

Calling the getReadSetActivationJob operation

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.

        • readSetIdrequired — (String)

          The source's read set ID.

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

getReadSetExportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set export job.

Service Reference:

Examples:

Calling the getReadSetExportJob operation

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.

        • idrequired — (String)

          The set's ID.

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

getReadSetImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set import job.

Service Reference:

Examples:

Calling the getReadSetImportJob operation

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.

        • sourceFilesrequired — (map)

          The source files' location in Amazon S3.

          • source1required — (String)

            The location of the first file in Amazon S3.

          • source2 — (String)

            The location of the second file in Amazon S3.

        • sourceFileTyperequired — (String)

          The source's file type.

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

          The source's status.

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

          The source's status message.

        • subjectIdrequired — (String)

          The source's subject ID.

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

getReadSetMetadata(params = {}, callback) ⇒ AWS.Request

Gets details about a read set.

Service Reference:

Examples:

Calling the getReadSetMetadata operation

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.

getReference(params = {}, callback) ⇒ AWS.Request

Gets a reference file.

Service Reference:

Examples:

Calling the getReference operation

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.

getReferenceImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a reference import job.

Service Reference:

Examples:

Calling the getReferenceImportJob operation

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.

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

getReferenceMetadata(params = {}, callback) ⇒ AWS.Request

Gets information about a genome reference's metadata.

Service Reference:

Examples:

Calling the getReferenceMetadata operation

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.

getReferenceStore(params = {}, callback) ⇒ AWS.Request

Gets information about a reference store.

Service Reference:

Examples:

Calling the getReferenceStore operation

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.

        • typerequired — (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.

getRun(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

Service Reference:

Examples:

Calling the getRun operation

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:

getRunGroup(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run group.

Service Reference:

Examples:

Calling the getRunGroup operation

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.

getRunTask(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run task.

Service Reference:

Examples:

Calling the getRunTask operation

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 workflow run 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:

      • taskId — (String)

        The task's ID.

      • status — (String)

        The task's status.

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

        The task's name.

      • cpus — (Integer)

        The task's CPU usage.

      • memory — (Integer)

        The task's memory use in gigabytes.

      • creationTime — (Date)

        When the task was created.

      • startTime — (Date)

        The task's start time.

      • stopTime — (Date)

        The task's stop time.

      • statusMessage — (String)

        The task's status message.

      • logStream — (String)

        The task's log stream.

      • gpus — (Integer)

        The number of Graphics Processing Units (GPU) specified in the task.

      • instanceType — (String)

        The instance type for a task.

      • failureReason — (String)

        The reason a task has failed.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

getSequenceStore(params = {}, callback) ⇒ AWS.Request

Gets information about a sequence store.

Service Reference:

Examples:

Calling the getSequenceStore operation

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:

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

        • typerequired — (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.

      • s3Access — (map)

        The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.

        • s3Uri — (String)

          The S3 URI of the sequence store.

        • s3AccessPointArn — (String)

          This is ARN of the access point associated with the S3 bucket storing read sets.

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

getShare(params = {}, callback) ⇒ AWS.Request

Retrieves the metadata for the specified resource share.

Service Reference:

Examples:

Calling the getShare operation

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

      • share — (map)

        A resource share details object. The object includes the status, the resourceArn, and ownerId.

        • shareId — (String)

          The ID of the resource share.

        • resourceArn — (String)

          The Arn of the shared resource.

        • resourceId — (String)

          The ID of the shared resource.

        • principalSubscriber — (String)

          The principal subscriber is the account that is sharing the resource.

        • ownerId — (String)

          The account ID for the data owner. The owner creates the resource share.

        • status — (String)

          The status of the share.

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

          The status message for a resource share. It provides additional details about the share status.

        • shareName — (String)

          The name of the resource share.

        • creationTime — (Date)

          The timestamp of when the resource share was created.

        • updateTime — (Date)

          The timestamp of the resource share update.

Returns:

  • (AWS.Request)

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

getVariantImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a variant import job.

Service Reference:

Examples:

Calling the getVariantImportJob operation

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:

      • id — (String)

        The job's ID.

      • destinationName — (String)

        The job's destination variant store.

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

        • sourcerequired — (String)

          The source file's location in Amazon S3.

        • jobStatusrequired — (String)

          The item's job status.

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

          A message that provides additional context about a job

      • runLeftNormalization — (Boolean)

        The job's left normalization 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:

getVariantStore(params = {}, callback) ⇒ AWS.Request

Gets information about a variant store.

Service Reference:

Examples:

Calling the getVariantStore operation

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:

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

        • typerequired — (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.

      • statusMessage — (String)

        The store's status message.

      • storeSizeBytes — (Integer)

        The store's size in bytes.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

getWorkflow(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

Service Reference:

Examples:

Calling the getWorkflow operation

var params = {
  id: 'STRING_VALUE', /* required */
  export: [
    DEFINITION,
    /* more items */
  ],
  type: PRIVATE | READY2RUN,
  workflowOwnerId: 'STRING_VALUE'
};
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: {})
    • id — (String)

      The workflow's ID.

    • type — (String)

      The workflow's type.

      Possible values include:
      • "PRIVATE"
      • "READY2RUN"
    • export — (Array<String>)

      The export format for the workflow.

    • workflowOwnerId — (String)

      The ID of the workflow owner.

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

        The workflow's type.

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

        The workflow's name.

      • description — (String)

        The workflow's description.

      • engine — (String)

        The workflow's engine.

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

        The workflow's definition.

      • main — (String)

        The path of the main definition file for the workflow.

      • digest — (String)

        The workflow's digest.

      • parameterTemplate — (map<map>)

        The workflow's parameter template.

        • description — (String)

          The parameter's description.

        • optional — (Boolean)

          Whether the parameter is optional.

      • storageCapacity — (Integer)

        The workflow's default run storage capacity in gibibytes.

      • creationTime — (Date)

        When the workflow was created.

      • statusMessage — (String)

        The workflow's status message.

      • tags — (map<String>)

        The workflow's tags.

      • metadata — (map<String>)

        Gets metadata for workflow.

      • accelerators — (String)

        The computational accelerator specified to run the workflow.

        Possible values include:
        • "GPU"

Returns:

  • (AWS.Request)

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

Waiter Resource States:

listAnnotationImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of annotation import jobs.

Service Reference:

Examples:

Calling the listAnnotationImportJobs operation

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: {})
    • maxResults — (Integer)

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

    • ids — (Array<String>)

      IDs of annotation import jobs to retrieve.

    • nextToken — (String)

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

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

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.

        • idrequired — (String)

          The job's ID.

        • destinationNamerequired — (String)

          The job's destination annotation store.

        • versionNamerequired — (String)

          The name of the annotation store version.

        • roleArnrequired — (String)

          The job's service role ARN.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • updateTimerequired — (Date)

          When the job was updated.

        • completionTime — (Date)

          When the job completed.

        • runLeftNormalization — (Boolean)

          The job's left normalization setting.

        • annotationFields — (map<String>)

          The annotation schema generated by the parsed annotation data.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

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

listAnnotationStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of annotation stores.

Service Reference:

Examples:

Calling the listAnnotationStores operation

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: {})
    • 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.

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        A status to filter on.

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

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.

        • idrequired — (String)

          The store's ID.

        • referencerequired — (map)

          The store's genome reference.

          • referenceArn — (String)

            The reference's ARN.

        • statusrequired — (String)

          The store's status.

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

          The store's ARN.

        • namerequired — (String)

          The store's name.

        • storeFormatrequired — (String)

          The store's file format.

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

          The store's description.

        • sseConfigrequired — (map)

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

          • typerequired — (String)

            The encryption type.

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

            An encryption key ARN.

        • creationTimerequired — (Date)

          The store's creation time.

        • updateTimerequired — (Date)

          When the store was updated.

        • statusMessagerequired — (String)

          The store's status message.

        • storeSizeBytesrequired — (Integer)

          The store's size in bytes.

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

listAnnotationStoreVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of an annotation store.

Service Reference:

Examples:

Calling the listAnnotationStoreVersions operation

var params = {
  name: 'STRING_VALUE', /* required */
  filter: {
    status: CREATING | UPDATING | DELETING | ACTIVE | FAILED
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listAnnotationStoreVersions(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.

    • maxResults — (Integer)

      The maximum number of annotation store versions to return in one page of results.

    • nextToken — (String)

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

    • filter — (map)

      A filter to apply to the list of annotation store versions.

      • status — (String)

        The status of an annotation store version.

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

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:

      • annotationStoreVersions — (Array<map>)

        Lists all versions of an annotation store.

        • storeIdrequired — (String)

          The store ID for an annotation store version.

        • idrequired — (String)

          The annotation store version ID.

        • statusrequired — (String)

          The status of an annotation store version.

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

          The Arn for an annotation store version.

        • namerequired — (String)

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

        • versionNamerequired — (String)

          The name of an annotation store version.

        • descriptionrequired — (String)

          The description of an annotation store version.

        • creationTimerequired — (Date)

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

        • updateTimerequired — (Date)

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

        • statusMessagerequired — (String)

          The status of an annotation store version.

        • versionSizeBytesrequired — (Integer)

          The size of an annotation store version in Bytes.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

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

listMultipartReadSetUploads(params = {}, callback) ⇒ AWS.Request

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

Service Reference:

Examples:

Calling the listMultipartReadSetUploads operation

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listMultipartReadSetUploads(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 used for the multipart uploads.

    • maxResults — (Integer)

      The maximum number of multipart uploads returned in a page.

    • nextToken — (String)

      Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get 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:

      • nextToken — (String)

        Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

      • uploads — (Array<map>)

        An array of multipart uploads.

        • sequenceStoreIdrequired — (String)

          The sequence store ID used for the multipart upload.

        • uploadIdrequired — (String)

          The ID for the initiated multipart upload.

        • sourceFileTyperequired — (String)

          The type of file the read set originated from.

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

          The read set source's subject ID.

        • sampleIdrequired — (String)

          The read set source's sample ID.

        • generatedFromrequired — (String)

          The source of an uploaded part.

        • referenceArnrequired — (String)

          The source's reference ARN.

        • name — (String)

          The name of a read set.

        • description — (String)

          The description of a read set.

        • tags — (map<String>)

          Any tags you wish to add to a read set.

        • creationTimerequired — (Date)

          The time stamp for when a direct upload was created.

Returns:

  • (AWS.Request)

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

listReadSetActivationJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set activation jobs.

Service Reference:

Examples:

Calling the listReadSetActivationJobs operation

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

      The read set's sequence store ID.

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

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        The filter's status.

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

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • activationJobs — (Array<map>)

        A list of jobs.

        • idrequired — (String)

          The job's ID.

        • sequenceStoreIdrequired — (String)

          The job's sequence store ID.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • completionTime — (Date)

          When the job completed.

Returns:

  • (AWS.Request)

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

listReadSetExportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set export jobs.

Service Reference:

Examples:

Calling the listReadSetExportJobs operation

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

      The jobs' sequence store ID.

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

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        A status to filter on.

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

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • exportJobs — (Array<map>)

        A list of jobs.

        • idrequired — (String)

          The job's ID.

        • sequenceStoreIdrequired — (String)

          The job's sequence store ID.

        • destinationrequired — (String)

          The job's destination in Amazon S3.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • completionTime — (Date)

          When the job completed.

Returns:

  • (AWS.Request)

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

listReadSetImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set import jobs.

Service Reference:

Examples:

Calling the listReadSetImportJobs operation

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: {})
    • 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.

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        A status to filter on.

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

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • importJobs — (Array<map>)

        A list of jobs.

        • idrequired — (String)

          The job's ID.

        • sequenceStoreIdrequired — (String)

          The job's sequence store ID.

        • roleArnrequired — (String)

          The job's service role ARN.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • completionTime — (Date)

          When the job completed.

Returns:

  • (AWS.Request)

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

listReadSets(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read sets.

Service Reference:

Examples:

Calling the listReadSets operation

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,
    creationType: IMPORT | UPLOAD,
    generatedFrom: 'STRING_VALUE',
    name: 'STRING_VALUE',
    referenceArn: 'STRING_VALUE',
    sampleId: 'STRING_VALUE',
    status: ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED | PROCESSING_UPLOAD | UPLOAD_FAILED,
    subjectId: 'STRING_VALUE'
  },
  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: {})
    • sequenceStoreId — (String)

      The jobs' sequence store ID.

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

    • filter — (map)

      A filter to apply to the list.

      • name — (String)

        A name to filter on.

      • status — (String)

        A status to filter on.

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

        A genome reference ARN to filter on.

      • createdAfter — (Date)

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

      • sampleId — (String)

        The read set source's sample ID.

      • subjectId — (String)

        The read set source's subject ID.

      • generatedFrom — (String)

        Where the source originated.

      • creationType — (String)

        The creation type of the read set.

        Possible values include:
        • "IMPORT"
        • "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:

      • nextToken — (String)

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

      • readSets — (Array<map>)

        A list of read sets.

        • idrequired — (String)

          The read set's ID.

        • arnrequired — (String)

          The read set's ARN.

        • sequenceStoreIdrequired — (String)

          The read set's sequence store ID.

        • subjectId — (String)

          The read set's subject ID.

        • sampleId — (String)

          The read set's sample ID.

        • statusrequired — (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.

        • referenceArn — (String)

          The read set's genome reference ARN.

        • fileTyperequired — (String)

          The read set's file type.

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

          Details about a sequence.

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

        • creationTimerequired — (Date)

          When the read set was created.

        • statusMessage — (String)

          The status 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 representing 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.

Returns:

  • (AWS.Request)

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

listReadSetUploadParts(params = {}, callback) ⇒ AWS.Request

This operation will list all parts in a requested multipart upload for a sequence store.

Service Reference:

Examples:

Calling the listReadSetUploadParts operation

var params = {
  partSource: SOURCE1 | SOURCE2, /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  uploadId: '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
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReadSetUploadParts(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 used for the multipart uploads.

    • uploadId — (String)

      The ID for the initiated multipart upload.

    • partSource — (String)

      The source file for the upload part.

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

      The maximum number of read set upload parts returned in a page.

    • nextToken — (String)

      Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

    • filter — (map)

      Attributes used to filter for a specific subset of read set part uploads.

      • createdAfter — (Date)

        Filters for read set uploads after a specified time.

      • createdBefore — (Date)

        Filters for read set part uploads before a specified time.

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)

        Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

      • parts — (Array<map>)

        An array of upload parts.

        • partNumberrequired — (Integer)

          The number identifying the part in an upload.

        • partSizerequired — (Integer)

          The size of the the part in an upload.

        • partSourcerequired — (String)

          The origin of the part being direct uploaded.

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

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

        • creationTime — (Date)

          The time stamp for when a direct upload was created.

        • lastUpdatedTime — (Date)

          The time stamp for the most recent update to an uploaded part.

Returns:

  • (AWS.Request)

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

listReferenceImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of reference import jobs.

Service Reference:

Examples:

Calling the listReferenceImportJobs operation

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: {})
    • 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.

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        A status to filter on.

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

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • importJobs — (Array<map>)

        A lis of jobs.

        • idrequired — (String)

          The job's ID.

        • referenceStoreIdrequired — (String)

          The job's reference store ID.

        • roleArnrequired — (String)

          The job's service role ARN.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • completionTime — (Date)

          When the job completed.

Returns:

  • (AWS.Request)

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

listReferences(params = {}, callback) ⇒ AWS.Request

Retrieves a list of references.

Service Reference:

Examples:

Calling the listReferences operation

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

      The references' reference store ID.

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

    • filter — (map)

      A filter to apply to the list.

      • name — (String)

        A name to filter on.

      • md5 — (String)

        An MD5 checksum to filter on.

      • createdAfter — (Date)

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

        • idrequired — (String)

          The reference's ID.

        • arnrequired — (String)

          The reference's ARN.

        • referenceStoreIdrequired — (String)

          The reference's store ID.

        • md5required — (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.

        • creationTimerequired — (Date)

          When the reference was created.

        • updateTimerequired — (Date)

          When the reference was updated.

Returns:

  • (AWS.Request)

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

listReferenceStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of reference stores.

Service Reference:

Examples:

Calling the listReferenceStores operation

var params = {
  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'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listReferenceStores(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: {})
    • 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.

    • filter — (map)

      A filter to apply to the list.

      • name — (String)

        The name to filter on.

      • createdAfter — (Date)

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • referenceStores — (Array<map>)

        A list of reference stores.

        • arnrequired — (String)

          The store's ARN.

        • idrequired — (String)

          The store's ID.

        • name — (String)

          The store's name.

        • description — (String)

          The store's description.

        • sseConfig — (map)

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

          • typerequired — (String)

            The encryption type.

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

            An encryption key ARN.

        • creationTimerequired — (Date)

          When the store was created.

Returns:

  • (AWS.Request)

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

listRunGroups(params = {}, callback) ⇒ AWS.Request

Retrieves a list of run groups.

Service Reference:

Examples:

Calling the listRunGroups operation

var params = {
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  startingToken: 'STRING_VALUE'
};
omics.listRunGroups(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 run groups' name.

    • startingToken — (String)

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

    • maxResults — (Integer)

      The maximum number of run groups to return in one 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:

      • items — (Array<map>)

        A list of groups.

        • arn — (String)

          The group's ARN.

        • id — (String)

          The group's ID.

        • name — (String)

          The group's name.

        • maxCpus — (Integer)

          The group's maximum CPU count setting.

        • maxRuns — (Integer)

          The group's maximum concurrent run setting.

        • maxDuration — (Integer)

          The group's maximum duration setting in minutes.

        • creationTime — (Date)

          When the group was created.

        • maxGpus — (Integer)

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

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

listRuns(params = {}, callback) ⇒ AWS.Request

Retrieves a list of runs.

Service Reference:

Examples:

Calling the listRuns operation

var params = {
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  runGroupId: 'STRING_VALUE',
  startingToken: 'STRING_VALUE',
  status: PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED
};
omics.listRuns(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)

      Filter the list by run name.

    • runGroupId — (String)

      Filter the list by run group ID.

    • startingToken — (String)

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

    • maxResults — (Integer)

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

    • status — (String)

      The status of a run.

      Possible values include:
      • "PENDING"
      • "STARTING"
      • "RUNNING"
      • "STOPPING"
      • "COMPLETED"
      • "DELETED"
      • "CANCELLED"
      • "FAILED"

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:

      • items — (Array<map>)

        A list of runs.

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

        • name — (String)

          The run's name.

        • priority — (Integer)

          The run's priority.

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

        • creationTime — (Date)

          When the run was created.

        • startTime — (Date)

          When the run started.

        • stopTime — (Date)

          When the run stopped.

        • storageType — (String)

          The run's storage type.

          Possible values include:
          • "STATIC"
          • "DYNAMIC"
      • 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.

listRunTasks(params = {}, callback) ⇒ AWS.Request

Retrieves a list of tasks for a run.

Service Reference:

Examples:

Calling the listRunTasks operation

var params = {
  id: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  startingToken: 'STRING_VALUE',
  status: PENDING | STARTING | RUNNING | STOPPING | COMPLETED | CANCELLED | FAILED
};
omics.listRunTasks(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.

    • status — (String)

      Filter the list by status.

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

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

    • maxResults — (Integer)

      The maximum number of run tasks to return in one 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:

      • items — (Array<map>)

        A list of tasks.

        • taskId — (String)

          The task's ID.

        • status — (String)

          The task's status.

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

          The task's name.

        • cpus — (Integer)

          The task's CPU count.

        • memory — (Integer)

          The task's memory use in gigabyes.

        • creationTime — (Date)

          When the task was created.

        • startTime — (Date)

          When the task started.

        • stopTime — (Date)

          When the task stopped.

        • gpus — (Integer)

          The number of Graphics Processing Units (GPU) specified for the task.

        • instanceType — (String)

          The instance type for a task.

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

listSequenceStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of sequence stores.

Service Reference:

Examples:

Calling the listSequenceStores operation

var params = {
  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'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listSequenceStores(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: {})
    • 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.

    • filter — (map)

      A filter to apply to the list.

      • name — (String)

        A name to filter on.

      • createdAfter — (Date)

        The filter's start date.

      • createdBefore — (Date)

        The filter's end date.

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.

      • sequenceStores — (Array<map>)

        A list of sequence stores.

        • arnrequired — (String)

          The store's ARN.

        • idrequired — (String)

          The store's ID.

        • name — (String)

          The store's name.

        • description — (String)

          The store's description.

        • sseConfig — (map)

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

          • typerequired — (String)

            The encryption type.

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

            An encryption key ARN.

        • creationTimerequired — (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.

listShares(params = {}, callback) ⇒ AWS.Request

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

Service Reference:

Examples:

Calling the listShares operation

var params = {
  resourceOwner: SELF | OTHER, /* required */
  filter: {
    resourceArns: [
      'STRING_VALUE',
      /* more items */
    ],
    status: [
      PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED,
      /* more items */
    ],
    type: [
      VARIANT_STORE | ANNOTATION_STORE | WORKFLOW,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listShares(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: {})
    • resourceOwner — (String)

      The account that owns the resource shares.

      Possible values include:
      • "SELF"
      • "OTHER"
    • filter — (map)

      Attributes that you use to filter for a specific subset of resource shares.

      • resourceArns — (Array<String>)

        Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.

      • status — (Array<String>)

        Filter based on the resource status. You can specify up to 10 values.

      • type — (Array<String>)

        The type of resources to be filtered. You can specify one or more of the resource types.

    • nextToken — (String)

      Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

    • maxResults — (Integer)

      The maximum number of shares to return in one 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:

      • shares — (Array<map>)

        The shares available and their metadata details.

        • shareId — (String)

          The ID of the resource share.

        • resourceArn — (String)

          The Arn of the shared resource.

        • resourceId — (String)

          The ID of the shared resource.

        • principalSubscriber — (String)

          The principal subscriber is the account that is sharing the resource.

        • ownerId — (String)

          The account ID for the data owner. The owner creates the resource share.

        • status — (String)

          The status of the share.

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

          The status message for a resource share. It provides additional details about the share status.

        • shareName — (String)

          The name of the resource share.

        • creationTime — (Date)

          The timestamp of when the resource share was created.

        • updateTime — (Date)

          The timestamp of the resource share update.

      • nextToken — (String)

        Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves a list of tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
omics.listTagsForResource(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 resource's 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:

      • tags — (map<String>)

        A list of tags.

Returns:

  • (AWS.Request)

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

listVariantImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of variant import jobs.

Service Reference:

Examples:

Calling the listVariantImportJobs operation

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.listVariantImportJobs(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: {})
    • maxResults — (Integer)

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

    • ids — (Array<String>)

      A list of job IDs.

    • nextToken — (String)

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

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

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:

      • variantImportJobs — (Array<map>)

        A list of jobs.

        • idrequired — (String)

          The job's ID.

        • destinationNamerequired — (String)

          The job's destination variant store.

        • roleArnrequired — (String)

          The job's service role ARN.

        • statusrequired — (String)

          The job's status.

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

          When the job was created.

        • updateTimerequired — (Date)

          When the job was updated.

        • completionTime — (Date)

          When the job completed.

        • runLeftNormalization — (Boolean)

          The job's left normalization setting.

        • annotationFields — (map<String>)

          The annotation schema generated by the parsed annotation data.

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

listVariantStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of variant stores.

Service Reference:

Examples:

Calling the listVariantStores operation

var params = {
  filter: {
    status: CREATING | UPDATING | DELETING | ACTIVE | FAILED
  },
  ids: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
omics.listVariantStores(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: {})
    • maxResults — (Integer)

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

    • ids — (Array<String>)

      A list of store IDs.

    • nextToken — (String)

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

    • filter — (map)

      A filter to apply to the list.

      • status — (String)

        A status to filter on.

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

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:

      • variantStores — (Array<map>)

        A list of variant stores.

        • idrequired — (String)

          The store's ID.

        • referencerequired — (map)

          The store's genome reference.

          • referenceArn — (String)

            The reference's ARN.

        • statusrequired — (String)

          The store's status.

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

          The store's ARN.

        • namerequired — (String)

          The store's name.

        • descriptionrequired — (String)

          The store's description.

        • sseConfigrequired — (map)

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

          • typerequired — (String)

            The encryption type.

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

            An encryption key ARN.

        • creationTimerequired — (Date)

          When the store was created.

        • updateTimerequired — (Date)

          When the store was updated.

        • statusMessagerequired — (String)

          The store's status message.

        • storeSizeBytesrequired — (Integer)

          The store's size in bytes.

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

listWorkflows(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflows.

Service Reference:

Examples:

Calling the listWorkflows operation

var params = {
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  startingToken: 'STRING_VALUE',
  type: PRIVATE | READY2RUN
};
omics.listWorkflows(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: {})
    • type — (String)

      Filter the list by workflow type.

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

      Filter the list by workflow name.

    • startingToken — (String)

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

    • maxResults — (Integer)

      The maximum number of workflows to return in one 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:

      • items — (Array<map>)

        A list of workflow items.

        • arn — (String)

          The workflow's ARN.

        • id — (String)

          The workflow's ID.

        • name — (String)

          The workflow's name.

        • status — (String)

          The workflow's status.

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

          The workflow's type.

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

          The workflow's digest.

        • creationTime — (Date)

          When the workflow was created.

        • metadata — (map<String>)

          Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

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

startAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Starts an annotation import job.

Service Reference:

Examples:

Calling the startAnnotationImportJob operation

var params = {
  destinationName: 'STRING_VALUE', /* required */
  items: [ /* required */
    {
      source: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE', /* required */
  annotationFields: {
    '<AnnotationFieldMapKeyString>': 'STRING_VALUE',
    /* '<AnnotationFieldMapKeyString>': ... */
  },
  formatOptions: {
    tsvOptions: {
      readOptions: {
        comment: 'STRING_VALUE',
        encoding: 'STRING_VALUE',
        escape: 'STRING_VALUE',
        escapeQuotes: true || false,
        header: true || false,
        lineSep: 'STRING_VALUE',
        quote: 'STRING_VALUE',
        quoteAll: true || false,
        sep: 'STRING_VALUE'
      }
    },
    vcfOptions: {
      ignoreFilterField: true || false,
      ignoreQualField: true || false
    }
  },
  runLeftNormalization: true || false,
  versionName: 'STRING_VALUE'
};
omics.startAnnotationImportJob(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: {})
    • destinationName — (String)

      A destination annotation store for the job.

    • roleArn — (String)

      A service role for the job.

    • items — (Array<map>)

      Items to import.

      • sourcerequired — (String)

        The source file's location in Amazon S3.

    • versionName — (String)

      The name of the annotation store version.

    • formatOptions — (map)

      Formatting options for the annotation 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.

    • runLeftNormalization — (Boolean)

      The job's left normalization setting.

    • annotationFields — (map<String>)

      The annotation schema generated by the parsed annotation data.

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:

      • jobId — (String)

        The job's ID.

Returns:

  • (AWS.Request)

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

startReadSetActivationJob(params = {}, callback) ⇒ AWS.Request

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

Service Reference:

Examples:

Calling the startReadSetActivationJob operation

var params = {
  sequenceStoreId: 'STRING_VALUE', /* required */
  sources: [ /* required */
    {
      readSetId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
omics.startReadSetActivationJob(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 read set's sequence store ID.

    • clientToken — (String)

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

    • sources — (Array<map>)

      The job's source files.

      • readSetIdrequired — (String)

        The source's read set 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 read set's sequence store ID.

      • status — (String)

        The job's status.

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

        When the job was created.

Returns:

  • (AWS.Request)

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

startReadSetExportJob(params = {}, callback) ⇒ AWS.Request

Exports a read set to Amazon S3.

Service Reference:

Examples:

Calling the startReadSetExportJob operation

var params = {
  destination: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  sources: [ /* required */
    {
      readSetId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
omics.startReadSetExportJob(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 read set's sequence store ID.

    • destination — (String)

      A location for exported files in Amazon S3.

    • roleArn — (String)

      A service role for the job.

    • clientToken — (String)

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

    • sources — (Array<map>)

      The job's source files.

      • readSetIdrequired — (String)

        The set'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 read set's sequence store ID.

      • destination — (String)

        The job's output location.

      • status — (String)

        The job's status.

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

        When the job was created.

Returns:

  • (AWS.Request)

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

startReadSetImportJob(params = {}, callback) ⇒ AWS.Request

Starts a read set import job.

Service Reference:

Examples:

Calling the startReadSetImportJob operation

var params = {
  roleArn: 'STRING_VALUE', /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  sources: [ /* required */
    {
      sampleId: 'STRING_VALUE', /* required */
      sourceFileType: FASTQ | BAM | CRAM | UBAM, /* required */
      sourceFiles: { /* required */
        source1: 'STRING_VALUE', /* required */
        source2: 'STRING_VALUE'
      },
      subjectId: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE',
      generatedFrom: 'STRING_VALUE',
      name: 'STRING_VALUE',
      referenceArn: 'STRING_VALUE',
      tags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
omics.startReadSetImportJob(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 read set's sequence store ID.

    • roleArn — (String)

      A service role for the job.

    • clientToken — (String)

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

    • sources — (Array<map>)

      The job's source files.

      • sourceFilesrequired — (map)

        The source files' location in Amazon S3.

        • source1required — (String)

          The location of the first file in Amazon S3.

        • source2 — (String)

          The location of the second file in Amazon S3.

      • sourceFileTyperequired — (String)

        The source's file type.

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

        The source's subject ID.

      • sampleIdrequired — (String)

        The source's sample ID.

      • generatedFrom — (String)

        Where the source originated.

      • referenceArn — (String)

        The source's reference ARN.

      • name — (String)

        The source's name.

      • description — (String)

        The source's description.

      • tags — (map<String>)

        The source's tags.

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 read set'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"
      • creationTime — (Date)

        When the job was created.

Returns:

  • (AWS.Request)

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

startReferenceImportJob(params = {}, callback) ⇒ AWS.Request

Starts a reference import job.

Service Reference:

Examples:

Calling the startReferenceImportJob operation

var params = {
  referenceStoreId: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  sources: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      sourceFile: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE',
      tags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
omics.startReferenceImportJob(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: {})
    • referenceStoreId — (String)

      The job's reference store ID.

    • roleArn — (String)

      A service role for the job.

    • clientToken — (String)

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

    • sources — (Array<map>)

      The job's source files.

      • sourceFilerequired — (String)

        The source file's location in Amazon S3.

      • namerequired — (String)

        The source's name.

      • description — (String)

        The source's description.

      • tags — (map<String>)

        The source's tags.

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"
      • creationTime — (Date)

        When the job was created.

Returns:

  • (AWS.Request)

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

startRun(params = {}, callback) ⇒ AWS.Request

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.

StartRun will not support re-run for a workflow that is shared with you.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

Service Reference:

Examples:

Calling the startRun operation

var params = {
  requestId: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  logLevel: OFF | FATAL | ERROR | ALL,
  name: 'STRING_VALUE',
  outputUri: 'STRING_VALUE',
  parameters: {
  },
  priority: 'NUMBER_VALUE',
  retentionMode: RETAIN | REMOVE,
  runGroupId: 'STRING_VALUE',
  runId: 'STRING_VALUE',
  storageCapacity: 'NUMBER_VALUE',
  storageType: STATIC | DYNAMIC,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workflowId: 'STRING_VALUE',
  workflowOwnerId: 'STRING_VALUE',
  workflowType: PRIVATE | READY2RUN
};
omics.startRun(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: {})
    • workflowId — (String)

      The run's workflow ID.

    • workflowType — (String)

      The run's workflow type.

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

      The ID of a run to duplicate.

    • roleArn — (String)

      A service role for the run.

    • name — (String)

      A name for the run.

    • runGroupId — (String)

      The run's group ID.

    • priority — (Integer)

      A priority for the run.

    • parameters — (map)

      Parameters for the run.

    • storageCapacity — (Integer)

      A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

    • outputUri — (String)

      An output URI for the run.

    • logLevel — (String)

      A log level for the run.

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

      Tags for the run.

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

      The retention mode for the run.

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

      The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

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

      The ID of the workflow owner.

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

        The run's tags.

      • uuid — (String)

        The universally unique identifier for a run.

      • runOutputUri — (String)

        The destination for workflow outputs.

Returns:

  • (AWS.Request)

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

startVariantImportJob(params = {}, callback) ⇒ AWS.Request

Starts a variant import job.

Service Reference:

Examples:

Calling the startVariantImportJob operation

var params = {
  destinationName: 'STRING_VALUE', /* required */
  items: [ /* required */
    {
      source: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE', /* required */
  annotationFields: {
    '<AnnotationFieldMapKeyString>': 'STRING_VALUE',
    /* '<AnnotationFieldMapKeyString>': ... */
  },
  runLeftNormalization: true || false
};
omics.startVariantImportJob(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: {})
    • destinationName — (String)

      The destination variant store for the job.

    • roleArn — (String)

      A service role for the job.

    • items — (Array<map>)

      Items to import.

      • sourcerequired — (String)

        The source file's location in Amazon S3.

    • runLeftNormalization — (Boolean)

      The job's left normalization setting.

    • annotationFields — (map<String>)

      The annotation schema generated by the parsed annotation data.

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:

      • jobId — (String)

        The job's ID.

Returns:

  • (AWS.Request)

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

tagResource(params = {}, callback) ⇒ AWS.Request

Tags a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
omics.tagResource(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 resource's ARN.

    • tags — (map<String>)

      Tags for the resource.

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
omics.untagResource(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 resource's ARN.

    • tagKeys — (Array<String>)

      Keys of tags to remove.

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.

updateAnnotationStore(params = {}, callback) ⇒ AWS.Request

Updates an annotation store.

Service Reference:

Examples:

Calling the updateAnnotationStore operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
omics.updateAnnotationStore(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.

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.

      • description — (String)

        The store's description.

      • creationTime — (Date)

        When the store was created.

      • updateTime — (Date)

        When the store was updated.

      • storeOptions — (map)

        Parsing options for the 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.

      • storeFormat — (String)

        The annotation file format of the store.

        Possible values include:
        • "GFF"
        • "TSV"
        • "VCF"

Returns:

  • (AWS.Request)

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

updateAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Updates the description of an annotation store version.

Service Reference:

Examples:

Calling the updateAnnotationStoreVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  versionName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
omics.updateAnnotationStoreVersion(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.

    • versionName — (String)

      The name of an annotation store version.

    • description — (String)

      The description of an annotation 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:

      • storeId — (String)

        The annotation store ID.

      • id — (String)

        The annotation store version ID.

      • status — (String)

        The status of an annotation store version.

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

        The name of an annotation store.

      • versionName — (String)

        The name of an annotation store version.

      • description — (String)

        The description of 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.

Returns:

  • (AWS.Request)

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

updateRunGroup(params = {}, callback) ⇒ AWS.Request

Updates a run group.

Service Reference:

Examples:

Calling the updateRunGroup operation

var params = {
  id: 'STRING_VALUE', /* required */
  maxCpus: 'NUMBER_VALUE',
  maxDuration: 'NUMBER_VALUE',
  maxGpus: 'NUMBER_VALUE',
  maxRuns: 'NUMBER_VALUE',
  name: 'STRING_VALUE'
};
omics.updateRunGroup(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.

    • name — (String)

      A name for the group.

    • maxCpus — (Integer)

      The maximum number of CPUs to use.

    • maxRuns — (Integer)

      The maximum number of concurrent runs for the group.

    • maxDuration — (Integer)

      A maximum run time for the group in minutes.

    • maxGpus — (Integer)

      The maximum GPUs that can be used by a 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.

Returns:

  • (AWS.Request)

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

updateVariantStore(params = {}, callback) ⇒ AWS.Request

Updates a variant store.

Service Reference:

Examples:

Calling the updateVariantStore operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
omics.updateVariantStore(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.

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.

      • description — (String)

        The store's description.

      • creationTime — (Date)

        When the store was created.

      • updateTime — (Date)

        When the store was updated.

Returns:

  • (AWS.Request)

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

updateWorkflow(params = {}, callback) ⇒ AWS.Request

Updates a workflow.

Service Reference:

Examples:

Calling the updateWorkflow operation

var params = {
  id: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
omics.updateWorkflow(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.

    • name — (String)

      A name for the workflow.

    • description — (String)

      A description 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.

Returns:

  • (AWS.Request)

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

uploadReadSetPart(params = {}, callback) ⇒ AWS.Request

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

Service Reference:

Examples:

Calling the uploadReadSetPart operation

var params = {
  partNumber: 'NUMBER_VALUE', /* required */
  partSource: SOURCE1 | SOURCE2, /* required */
  payload: Buffer.from('...') || 'STRING_VALUE' || streamObject, /* required */
  sequenceStoreId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE' /* required */
};
omics.uploadReadSetPart(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 used for the multipart upload.

    • uploadId — (String)

      The ID for the initiated multipart upload.

    • partSource — (String)

      The source file for an upload part.

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

      The number of the part being uploaded.

    • payload — (Buffer, Typed Array, Blob, String, ReadableStream)

      The read set data to upload for a part.

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:

      • checksum — (String)

        An identifier used to confirm that parts are being added to the intended upload.

Returns:

  • (AWS.Request)

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

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Omics resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the annotationImportJobCreated state

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

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

Waiter Resource Details

omics.waitFor('annotationImportJobCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationImportJobCreated state by periodically calling the underlying Omics.getAnnotationImportJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the annotationImportJobCreated state

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

Parameters:

  • params (Object)
    • 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.

        • sourcerequired — (String)

          The source file's location in Amazon S3.

        • jobStatusrequired — (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.

See Also:

omics.waitFor('annotationStoreCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreCreated state by periodically calling the underlying Omics.getAnnotationStore() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the annotationStoreCreated state

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

Parameters:

  • params (Object)
    • 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.

        • typerequired — (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.

See Also:

omics.waitFor('annotationStoreDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreDeleted state by periodically calling the underlying Omics.getAnnotationStore() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the annotationStoreDeleted state

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

Parameters:

  • params (Object)
    • 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.

        • typerequired — (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.

See Also:

omics.waitFor('annotationStoreVersionCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreVersionCreated state by periodically calling the underlying Omics.getAnnotationStoreVersion() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the annotationStoreVersionCreated state

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

Parameters:

  • params (Object)
    • 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.

See Also:

omics.waitFor('annotationStoreVersionDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreVersionDeleted state by periodically calling the underlying Omics.getAnnotationStoreVersion() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the annotationStoreVersionDeleted state

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

Parameters:

  • params (Object)
    • 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.

See Also:

omics.waitFor('readSetActivationJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetActivationJobCompleted state by periodically calling the underlying Omics.getReadSetActivationJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the readSetActivationJobCompleted state

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

Parameters:

  • params (Object)
    • 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.

        • readSetIdrequired — (String)

          The source's read set ID.

        • statusrequired — (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.

See Also:

omics.waitFor('readSetExportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetExportJobCompleted state by periodically calling the underlying Omics.getReadSetExportJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the readSetExportJobCompleted state

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

Parameters:

  • params (Object)
    • 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.

        • idrequired — (String)

          The set's ID.

        • statusrequired — (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.

See Also:

omics.waitFor('readSetImportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetImportJobCompleted state by periodically calling the underlying Omics.getReadSetImportJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the readSetImportJobCompleted state

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

Parameters:

  • params (Object)
    • 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.

        • sourceFilesrequired — (map)

          The source files' location in Amazon S3.

          • source1required — (String)

            The location of the first file in Amazon S3.

          • source2 — (String)

            The location of the second file in Amazon S3.

        • sourceFileTyperequired — (String)

          The source's file type.

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

          The source's status.

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

          The source's status message.

        • subjectIdrequired — (String)

          The source's subject ID.

        • sampleIdrequired — (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.

See Also:

omics.waitFor('referenceImportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the referenceImportJobCompleted state by periodically calling the underlying Omics.getReferenceImportJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the referenceImportJobCompleted state

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

Parameters:

  • params (Object)
    • 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.

        • statusrequired — (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.

See Also:

omics.waitFor('runCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the runCompleted state by periodically calling the underlying Omics.getRun() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the runCompleted state

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

Parameters:

  • params (Object)
    • 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.

See Also:

omics.waitFor('runRunning', params = {}, [callback]) ⇒ AWS.Request

Waits for the runRunning state by periodically calling the underlying Omics.getRun() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the runRunning state

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

Parameters:

  • params (Object)
    • 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.

See Also:

omics.waitFor('taskCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the taskCompleted state by periodically calling the underlying Omics.getRunTask() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the taskCompleted state

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

Parameters:

  • params (Object)
    • id — (String)

      The workflow run 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:

      • taskId — (String)

        The task's ID.

      • status — (String)

        The task's status.

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

        The task's name.

      • cpus — (Integer)

        The task's CPU usage.

      • memory — (Integer)

        The task's memory use in gigabytes.

      • creationTime — (Date)

        When the task was created.

      • startTime — (Date)

        The task's start time.

      • stopTime — (Date)

        The task's stop time.

      • statusMessage — (String)

        The task's status message.

      • logStream — (String)

        The task's log stream.

      • gpus — (Integer)

        The number of Graphics Processing Units (GPU) specified in the task.

      • instanceType — (String)

        The instance type for a task.

      • failureReason — (String)

        The reason a task has failed.

Returns:

  • (AWS.Request)

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

See Also:

omics.waitFor('taskRunning', params = {}, [callback]) ⇒ AWS.Request

Waits for the taskRunning state by periodically calling the underlying Omics.getRunTask() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the taskRunning state

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

Parameters:

  • params (Object)
    • id — (String)

      The workflow run 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:

      • taskId — (String)

        The task's ID.

      • status — (String)

        The task's status.

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

        The task's name.

      • cpus — (Integer)

        The task's CPU usage.

      • memory — (Integer)

        The task's memory use in gigabytes.

      • creationTime — (Date)

        When the task was created.

      • startTime — (Date)

        The task's start time.

      • stopTime — (Date)

        The task's stop time.

      • statusMessage — (String)

        The task's status message.

      • logStream — (String)

        The task's log stream.

      • gpus — (Integer)

        The number of Graphics Processing Units (GPU) specified in the task.

      • instanceType — (String)

        The instance type for a task.

      • failureReason — (String)

        The reason a task has failed.

Returns:

  • (AWS.Request)

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

See Also:

omics.waitFor('variantImportJobCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantImportJobCreated state by periodically calling the underlying Omics.getVariantImportJob() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the variantImportJobCreated state

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

Parameters:

  • params (Object)
    • 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 variant store.

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

        • sourcerequired — (String)

          The source file's location in Amazon S3.

        • jobStatusrequired — (String)

          The item's job status.

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

          A message that provides additional context about a job

      • runLeftNormalization — (Boolean)

        The job's left normalization 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.

See Also:

omics.waitFor('variantStoreCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantStoreCreated state by periodically calling the underlying Omics.getVariantStore() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the variantStoreCreated state

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

Parameters:

  • params (Object)
    • 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.

        • typerequired — (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.

      • statusMessage — (String)

        The store's status message.

      • storeSizeBytes — (Integer)

        The store's size in bytes.

Returns:

  • (AWS.Request)

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

See Also:

omics.waitFor('variantStoreDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantStoreDeleted state by periodically calling the underlying Omics.getVariantStore() operation every 30 seconds (at most 20 times).

Examples:

Waiting for the variantStoreDeleted state

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

Parameters:

  • params (Object)
    • 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.

        • typerequired — (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.

      • statusMessage — (String)

        The store's status message.

      • storeSizeBytes — (Integer)

        The store's size in bytes.

Returns:

  • (AWS.Request)

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

See Also:

omics.waitFor('workflowActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the workflowActive state by periodically calling the underlying Omics.getWorkflow() operation every 3 seconds (at most 10 times).

Examples:

Waiting for the workflowActive state

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

Parameters:

  • params (Object)
    • id — (String)

      The workflow's ID.

    • type — (String)

      The workflow's type.

      Possible values include:
      • "PRIVATE"
      • "READY2RUN"
    • export — (Array<String>)

      The export format for the workflow.

    • workflowOwnerId — (String)

      The ID of the workflow owner.

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

        The workflow's type.

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

        The workflow's name.

      • description — (String)

        The workflow's description.

      • engine — (String)

        The workflow's engine.

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

        The workflow's definition.

      • main — (String)

        The path of the main definition file for the workflow.

      • digest — (String)

        The workflow's digest.

      • parameterTemplate — (map<map>)

        The workflow's parameter template.

        • description — (String)

          The parameter's description.

        • optional — (Boolean)

          Whether the parameter is optional.

      • storageCapacity — (Integer)

        The workflow's default run storage capacity in gibibytes.

      • creationTime — (Date)

        When the workflow was created.

      • statusMessage — (String)

        The workflow's status message.

      • tags — (map<String>)

        The workflow's tags.

      • metadata — (map<String>)

        Gets metadata for workflow.

      • accelerators — (String)

        The computational accelerator specified to run the workflow.

        Possible values include:
        • "GPU"

Returns:

  • (AWS.Request)

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

See Also: