RunBatchListItem - HealthOmics API Reference

RunBatchListItem

A single run entry returned by ListRunsInBatch.

Contents

runArn

The unique ARN of the workflow run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:.+

Required: No

runId

The HealthOmics-generated identifier for the workflow run. Empty if submission failed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

runInternalUuid

The universally unique identifier (UUID) for the run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

runSettingId

The customer-provided identifier for the run configuration. Use this to correlate results back to the input configuration provided in inlineSettings or s3UriSettings.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

submissionFailureMessage

A detailed message describing the submission failure.

Type: String

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

submissionFailureReason

The error category for a failed submission. See the run-level failure table in the HealthOmics User Guide for details on each value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

submissionStatus

The submission outcome for this run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: SUCCESS | FAILED | CANCEL_SUCCESS | CANCEL_FAILED | DELETE_SUCCESS | DELETE_FAILED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: