get-batch¶

Description¶

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Synopsis¶

  get-batch
--batch-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--batch-id (string) [required]

The identifier portion of the run batch ARN.

Constraints:

min: 1

max: 18

pattern: [0-9]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

id -> (string)

The identifier portion of the run batch ARN.

Constraints:

min: 1

max: 18

pattern: [0-9]+

arn -> (string)

The unique ARN of the run batch.

Constraints:

min: 1

max: 128

pattern: arn:.+

uuid -> (string)

The universally unique identifier (UUID) for the run batch.

Constraints:

min: 1

max: 128

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

name -> (string)

The optional user-friendly name of the batch.

Constraints:

min: 1

max: 64

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

status -> (string)

The current status of the run batch.

Possible values:

PENDING

SUBMITTING

INPROGRESS

STOPPING

CANCELLED

FAILED

PROCESSED

RUNS_DELETING

RUNS_DELETED

Constraints:

min: 1

max: 64

tags -> (map)

AWS tags associated with the run batch.

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

totalRuns -> (integer)

The total number of runs in the batch.

defaultRunSetting -> (structure)

The shared configuration applied to all runs in the batch. See DefaultRunSetting .

workflowId -> (string) [required]

The identifier of the workflow to run.

Constraints:

min: 1

max: 18

pattern: [0-9]+

workflowType -> (string)

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Possible values:

PRIVATE

READY2RUN

Constraints:

min: 1

max: 64

roleArn -> (string) [required]

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Constraints:

min: 1

max: 128

pattern: arn:.+

name -> (string)

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Constraints:

min: 1

max: 128

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

cacheId -> (string)

The identifier of the run cache to associate with the runs.

Constraints:

min: 1

max: 18

pattern: [0-9]+

cacheBehavior -> (string)

The cache behavior for the runs. Requires cacheId to be set.

Possible values:

CACHE_ON_FAILURE

CACHE_ALWAYS

Constraints:

min: 1

max: 64

runGroupId -> (string)

The ID of the run group to contain all workflow runs in the batch.

Constraints:

min: 1

max: 18

pattern: [0-9]+

priority -> (integer)

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Constraints:

min: 0

max: 100000

parameters -> (document)

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

storageCapacity -> (integer)

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Constraints:

min: 0

max: 100000

outputUri -> (string)

The destination S3 URI for workflow outputs. Must begin with s3:// . The roleArn must grant write permissions to this bucket. Can be overridden per run.

Constraints:

min: 1

max: 750

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

logLevel -> (string)

The verbosity level for CloudWatch Logs emitted during each run.

Possible values:

OFF

FATAL

ERROR

ALL

Constraints:

min: 1

max: 64

runTags -> (map)

AWS tags to associate with each workflow run. Merged with per-run runTags ; run-specific values take precedence when keys overlap.

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

retentionMode -> (string)

The retention behavior for runs after completion.

Possible values:

RETAIN

REMOVE

Constraints:

min: 1

max: 64

storageType -> (string)

The storage type for the workflow runs.

Possible values:

STATIC

DYNAMIC

Constraints:

min: 1

max: 64

workflowOwnerId -> (string)

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Constraints:

pattern: [0-9]{12}

outputBucketOwnerId -> (string)

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Constraints:

min: 12

max: 12

pattern: [0-9]+

workflowVersionName -> (string)

The version name of the specified workflow.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

submissionSummary -> (structure)

A summary of run submission outcomes. See SubmissionSummary .

successfulStartSubmissionCount -> (integer)

The number of successful start submissions.

failedStartSubmissionCount -> (integer)

The number of failed start submissions.

pendingStartSubmissionCount -> (integer)

The number of pending start submissions.

successfulCancelSubmissionCount -> (integer)

The number of successful cancel submissions.

failedCancelSubmissionCount -> (integer)

The number of failed cancel submissions.

successfulDeleteSubmissionCount -> (integer)

The number of successful delete submissions.

failedDeleteSubmissionCount -> (integer)

The number of failed delete submissions.

runSummary -> (structure)

A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary .

pendingRunCount -> (integer)

The number of pending runs.

startingRunCount -> (integer)

The number of starting runs.

runningRunCount -> (integer)

The number of running runs.

stoppingRunCount -> (integer)

The number of stopping runs.

completedRunCount -> (integer)

The number of completed runs.

deletedRunCount -> (integer)

The number of deleted runs.

failedRunCount -> (integer)

The number of failed runs.

cancelledRunCount -> (integer)

The number of cancelled runs.

creationTime -> (timestamp)

The timestamp when the batch was created.

submittedTime -> (timestamp)

The timestamp when all run submissions completed.

processedTime -> (timestamp)

The timestamp when all run executions completed.

failedTime -> (timestamp)

The timestamp when the batch transitioned to a FAILED status.

failureReason -> (string)

A description of the batch failure. Present only when status is FAILED .

Table of Contents

Feedback

User Guide