aws_sdk_omics/client/
get_run.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetRun`](crate::operation::get_run::builders::GetRunFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::get_run::builders::GetRunFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_run::builders::GetRunFluentBuilder::set_id):<br>required: **true**<br><p>The run's ID.</p><br>
7    ///   - [`export(RunExport)`](crate::operation::get_run::builders::GetRunFluentBuilder::export) / [`set_export(Option<Vec::<RunExport>>)`](crate::operation::get_run::builders::GetRunFluentBuilder::set_export):<br>required: **false**<br><p>The run's export format.</p><br>
8    /// - On success, responds with [`GetRunOutput`](crate::operation::get_run::GetRunOutput) with field(s):
9    ///   - [`arn(Option<String>)`](crate::operation::get_run::GetRunOutput::arn): <p>The run's ARN.</p>
10    ///   - [`id(Option<String>)`](crate::operation::get_run::GetRunOutput::id): <p>The run's ID.</p>
11    ///   - [`cache_id(Option<String>)`](crate::operation::get_run::GetRunOutput::cache_id): <p>The run cache associated with the run.</p>
12    ///   - [`cache_behavior(Option<CacheBehavior>)`](crate::operation::get_run::GetRunOutput::cache_behavior): <p>The run cache behavior for the run.</p>
13    ///   - [`engine_version(Option<String>)`](crate::operation::get_run::GetRunOutput::engine_version): <p>The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.</p>
14    ///   - [`status(Option<RunStatus>)`](crate::operation::get_run::GetRunOutput::status): <p>The run's status.</p>
15    ///   - [`workflow_id(Option<String>)`](crate::operation::get_run::GetRunOutput::workflow_id): <p>The run's workflow ID.</p>
16    ///   - [`workflow_type(Option<WorkflowType>)`](crate::operation::get_run::GetRunOutput::workflow_type): <p>The run's workflow type.</p>
17    ///   - [`run_id(Option<String>)`](crate::operation::get_run::GetRunOutput::run_id): <p>The run's ID.</p>
18    ///   - [`role_arn(Option<String>)`](crate::operation::get_run::GetRunOutput::role_arn): <p>The run's service role ARN.</p>
19    ///   - [`name(Option<String>)`](crate::operation::get_run::GetRunOutput::name): <p>The run's name.</p>
20    ///   - [`run_group_id(Option<String>)`](crate::operation::get_run::GetRunOutput::run_group_id): <p>The run's group ID.</p>
21    ///   - [`priority(Option<i32>)`](crate::operation::get_run::GetRunOutput::priority): <p>The run's priority.</p>
22    ///   - [`definition(Option<String>)`](crate::operation::get_run::GetRunOutput::definition): <p>The run's definition.</p>
23    ///   - [`digest(Option<String>)`](crate::operation::get_run::GetRunOutput::digest): <p>The run's digest.</p>
24    ///   - [`parameters(Option<Document>)`](crate::operation::get_run::GetRunOutput::parameters): <p>The run's parameters.</p>
25    ///   - [`storage_capacity(Option<i32>)`](crate::operation::get_run::GetRunOutput::storage_capacity): <p>The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.</p>
26    ///   - [`output_uri(Option<String>)`](crate::operation::get_run::GetRunOutput::output_uri): <p>The run's output URI.</p>
27    ///   - [`log_level(Option<RunLogLevel>)`](crate::operation::get_run::GetRunOutput::log_level): <p>The run's log level.</p>
28    ///   - [`resource_digests(Option<HashMap::<String, String>>)`](crate::operation::get_run::GetRunOutput::resource_digests): <p>The run's resource digests.</p>
29    ///   - [`started_by(Option<String>)`](crate::operation::get_run::GetRunOutput::started_by): <p>Who started the run.</p>
30    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_run::GetRunOutput::creation_time): <p>When the run was created.</p>
31    ///   - [`start_time(Option<DateTime>)`](crate::operation::get_run::GetRunOutput::start_time): <p>When the run started.</p>
32    ///   - [`stop_time(Option<DateTime>)`](crate::operation::get_run::GetRunOutput::stop_time): <p>The run's stop time.</p>
33    ///   - [`status_message(Option<String>)`](crate::operation::get_run::GetRunOutput::status_message): <p>The run's status message.</p>
34    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_run::GetRunOutput::tags): <p>The run's tags.</p>
35    ///   - [`accelerators(Option<Accelerators>)`](crate::operation::get_run::GetRunOutput::accelerators): <p>The computational accelerator used to run the workflow.</p>
36    ///   - [`retention_mode(Option<RunRetentionMode>)`](crate::operation::get_run::GetRunOutput::retention_mode): <p>The run's retention mode.</p>
37    ///   - [`failure_reason(Option<String>)`](crate::operation::get_run::GetRunOutput::failure_reason): <p>The reason a run has failed.</p>
38    ///   - [`log_location(Option<RunLogLocation>)`](crate::operation::get_run::GetRunOutput::log_location): <p>The location of the run log.</p>
39    ///   - [`uuid(Option<String>)`](crate::operation::get_run::GetRunOutput::uuid): <p>The universally unique identifier for a run.</p>
40    ///   - [`run_output_uri(Option<String>)`](crate::operation::get_run::GetRunOutput::run_output_uri): <p>The destination for workflow outputs.</p>
41    ///   - [`storage_type(Option<StorageType>)`](crate::operation::get_run::GetRunOutput::storage_type): <p>The run's storage type.</p>
42    ///   - [`workflow_owner_id(Option<String>)`](crate::operation::get_run::GetRunOutput::workflow_owner_id): <p>The ID of the workflow owner.</p>
43    ///   - [`workflow_version_name(Option<String>)`](crate::operation::get_run::GetRunOutput::workflow_version_name): <p>The workflow version name.</p>
44    ///   - [`workflow_uuid(Option<String>)`](crate::operation::get_run::GetRunOutput::workflow_uuid): <p>The universally unique identifier (UUID) value for the workflow.</p>
45    /// - On failure, responds with [`SdkError<GetRunError>`](crate::operation::get_run::GetRunError)
46    pub fn get_run(&self) -> crate::operation::get_run::builders::GetRunFluentBuilder {
47        crate::operation::get_run::builders::GetRunFluentBuilder::new(self.handle.clone())
48    }
49}
aws_sdk_omics/client/get_run.rs

aws_sdk_omics/client/
get_run.rs
