Omics / Client / get_batch

get_batch

Omics.Client.get_batch(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_batch(
    batchId='string'
)

Parameters:

batchId (string) –

[REQUIRED]

The identifier portion of the run batch ARN.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'uuid': 'string',
    'name': 'string',
    'status': 'PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
    'tags': {
        'string': 'string'
    },
    'totalRuns': 123,
    'defaultRunSetting': {
        'workflowId': 'string',
        'workflowType': 'PRIVATE'|'READY2RUN',
        'roleArn': 'string',
        'name': 'string',
        'cacheId': 'string',
        'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
        'runGroupId': 'string',
        'priority': 123,
        'parameters': {...}|[...]|123|123.4|'string'|True|None,
        'storageCapacity': 123,
        'outputUri': 'string',
        'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
        'runTags': {
            'string': 'string'
        },
        'retentionMode': 'RETAIN'|'REMOVE',
        'storageType': 'STATIC'|'DYNAMIC',
        'workflowOwnerId': 'string',
        'outputBucketOwnerId': 'string',
        'workflowVersionName': 'string'
    },
    'submissionSummary': {
        'successfulStartSubmissionCount': 123,
        'failedStartSubmissionCount': 123,
        'pendingStartSubmissionCount': 123,
        'successfulCancelSubmissionCount': 123,
        'failedCancelSubmissionCount': 123,
        'successfulDeleteSubmissionCount': 123,
        'failedDeleteSubmissionCount': 123
    },
    'runSummary': {
        'pendingRunCount': 123,
        'startingRunCount': 123,
        'runningRunCount': 123,
        'stoppingRunCount': 123,
        'completedRunCount': 123,
        'deletedRunCount': 123,
        'failedRunCount': 123,
        'cancelledRunCount': 123
    },
    'creationTime': datetime(2015, 1, 1),
    'submittedTime': datetime(2015, 1, 1),
    'processedTime': datetime(2015, 1, 1),
    'failedTime': datetime(2015, 1, 1),
    'failureReason': 'string'
}

Response Structure

• (dict) –

  • id (string) –

    The identifier portion of the run batch ARN.

  • arn (string) –

    The unique ARN of the run batch.

  • uuid (string) –

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

  • name (string) –

    The optional user-friendly name of the batch.

  • status (string) –

    The current status of the run batch.

  • tags (dict) –

    AWS tags associated with the run batch.

    • (string) –

      • (string) –

  • totalRuns (integer) –

    The total number of runs in the batch.

  • defaultRunSetting (dict) –

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

    • workflowId (string) –

      The identifier of the workflow to run.

    • workflowType (string) –

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

    • roleArn (string) –

      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.

    • name (string) –

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

    • cacheId (string) –

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

    • cacheBehavior (string) –

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

    • runGroupId (string) –

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

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

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

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

    • logLevel (string) –

      The verbosity level for CloudWatch Logs emitted during each run.

    • runTags (dict) –

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

      • (string) –

        • (string) –

    • retentionMode (string) –

      The retention behavior for runs after completion.

    • storageType (string) –

      The storage type for the workflow runs.

    • workflowOwnerId (string) –

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

    • outputBucketOwnerId (string) –

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

    • workflowVersionName (string) –

      The version name of the specified workflow.

  • submissionSummary (dict) –

    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 (dict) –

    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 (datetime) –

    The timestamp when the batch was created.

  • submittedTime (datetime) –

    The timestamp when all run submissions completed.

  • processedTime (datetime) –

    The timestamp when all run executions completed.

  • failedTime (datetime) –

    The timestamp when the batch transitioned to a FAILED status.

  • failureReason (string) –

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

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException