aws-sdk-omics 1.107.0

AWS SDK for Amazon Omics
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetBatch`](crate::operation::get_batch::builders::GetBatchFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`batch_id(impl Into<String>)`](crate::operation::get_batch::builders::GetBatchFluentBuilder::batch_id) / [`set_batch_id(Option<String>)`](crate::operation::get_batch::builders::GetBatchFluentBuilder::set_batch_id):<br>required: **true**<br><p>The identifier portion of the run batch ARN.</p><br>
    /// - On success, responds with [`GetBatchOutput`](crate::operation::get_batch::GetBatchOutput) with field(s):
    ///   - [`id(Option<String>)`](crate::operation::get_batch::GetBatchOutput::id): <p>The identifier portion of the run batch ARN.</p>
    ///   - [`arn(Option<String>)`](crate::operation::get_batch::GetBatchOutput::arn): <p>The unique ARN of the run batch.</p>
    ///   - [`uuid(Option<String>)`](crate::operation::get_batch::GetBatchOutput::uuid): <p>The universally unique identifier (UUID) for the run batch.</p>
    ///   - [`name(Option<String>)`](crate::operation::get_batch::GetBatchOutput::name): <p>The optional user-friendly name of the batch.</p>
    ///   - [`status(Option<BatchStatus>)`](crate::operation::get_batch::GetBatchOutput::status): <p>The current status of the run batch.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_batch::GetBatchOutput::tags): <p>AWS tags associated with the run batch.</p>
    ///   - [`total_runs(Option<i32>)`](crate::operation::get_batch::GetBatchOutput::total_runs): <p>The total number of runs in the batch.</p>
    ///   - [`default_run_setting(Option<DefaultRunSetting>)`](crate::operation::get_batch::GetBatchOutput::default_run_setting): <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    ///   - [`submission_summary(Option<SubmissionSummary>)`](crate::operation::get_batch::GetBatchOutput::submission_summary): <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    ///   - [`run_summary(Option<RunSummary>)`](crate::operation::get_batch::GetBatchOutput::run_summary): <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(Option<DateTime>)`](crate::operation::get_batch::GetBatchOutput::creation_time): <p>The timestamp when the batch was created.</p>
    ///   - [`submitted_time(Option<DateTime>)`](crate::operation::get_batch::GetBatchOutput::submitted_time): <p>The timestamp when all run submissions completed.</p>
    ///   - [`processed_time(Option<DateTime>)`](crate::operation::get_batch::GetBatchOutput::processed_time): <p>The timestamp when all run executions completed.</p>
    ///   - [`failed_time(Option<DateTime>)`](crate::operation::get_batch::GetBatchOutput::failed_time): <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::get_batch::GetBatchOutput::failure_reason): <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    /// - On failure, responds with [`SdkError<GetBatchError>`](crate::operation::get_batch::GetBatchError)
    pub fn get_batch(&self) -> crate::operation::get_batch::builders::GetBatchFluentBuilder {
        crate::operation::get_batch::builders::GetBatchFluentBuilder::new(self.handle.clone())
    }
}