GetBatchResponse ¶

class GetBatchResponse(TypedDict, closed=True):
    id: NotRequired["capo_omics.types.batch_id.BatchId"]
    """<p>The identifier portion of the run batch ARN.</p>"""
    arn: NotRequired["capo_omics.types.batch_arn.BatchArn"]
    """<p>The unique ARN of the run batch.</p>"""
    uuid: NotRequired["capo_omics.types.batch_uuid.BatchUuid"]
    """<p>The universally unique identifier (UUID) for the run batch.</p>"""
    name: NotRequired["capo_omics.types.batch_name.BatchName"]
    """<p>The optional user-friendly name of the batch.</p>"""
    status: NotRequired["capo_omics.types.batch_status.BatchStatus"]
    """<p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETE_FAILED</code> (run deletion failed for some or all runs), <code>RUNS_DELETED</code> (runs deleted).</p>"""
    tags: NotRequired["capo_omics.types.tag_map.TagMap"]
    """<p>Amazon Web Services tags associated with the run batch.</p>"""
    total_runs: NotRequired["int"]
    """<p>The total number of runs in the batch.</p>"""
    default_run_setting: NotRequired[
        "capo_omics.types.default_run_setting.DefaultRunSetting"
    ]
    """<p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>"""
    submission_summary: NotRequired[
        "capo_omics.types.submission_summary.SubmissionSummary"
    ]
    """<p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>"""
    run_summary: NotRequired["capo_omics.types.run_summary.RunSummary"]
    """<p>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 <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>"""
    creation_time: NotRequired["capo_omics.types.batch_timestamp.BatchTimestamp"]
    """<p>The timestamp when the batch was created.</p>"""
    submitted_time: NotRequired["capo_omics.types.batch_timestamp.BatchTimestamp"]
    """<p>The timestamp when all run submissions completed.</p>"""
    processed_time: NotRequired["capo_omics.types.batch_timestamp.BatchTimestamp"]
    """<p>The timestamp when all run executions completed.</p>"""
    failed_time: NotRequired["capo_omics.types.batch_timestamp.BatchTimestamp"]
    """<p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>"""
    failure_reason: NotRequired["str"]
    """<p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>"""