aws_sdk_omics/client/

start_run.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartRun`](crate::operation::start_run::builders::StartRunFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workflow_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_workflow_id):<br>required: **false**<br><p>The run's workflow ID. The <code>workflowId</code> is not the UUID.</p><br>
    ///   - [`workflow_type(WorkflowType)`](crate::operation::start_run::builders::StartRunFluentBuilder::workflow_type) / [`set_workflow_type(Option<WorkflowType>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_workflow_type):<br>required: **false**<br><p>The run's workflow type. The <code>workflowType</code> must be specified if you are running a <code>READY2RUN</code> workflow. If you are running a <code>PRIVATE</code> workflow (default), you do not need to include the workflow type.</p><br>
    ///   - [`run_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_run_id):<br>required: **false**<br><p>The ID of a run to duplicate.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_role_arn):<br>required: **true**<br><p>A service role for the run. The <code>roleArn</code> requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example <code>roleArn</code> is <code>arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ</code>. In this example, the AWS account ID is <code>123456789012</code> and the role name is <code>omics-service-role-serviceRole-W8O1XMPL7QZ</code>.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_name):<br>required: **false**<br><p>A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.</p><br>
    ///   - [`cache_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::cache_id) / [`set_cache_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_cache_id):<br>required: **false**<br><p>Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.</p><br>
    ///   - [`cache_behavior(CacheBehavior)`](crate::operation::start_run::builders::StartRunFluentBuilder::cache_behavior) / [`set_cache_behavior(Option<CacheBehavior>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_cache_behavior):<br>required: **false**<br><p>The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    ///   - [`run_group_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::run_group_id) / [`set_run_group_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_run_group_id):<br>required: **false**<br><p>The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.</p><br>
    ///   - [`priority(i32)`](crate::operation::start_run::builders::StartRunFluentBuilder::priority) / [`set_priority(Option<i32>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_priority):<br>required: **false**<br><p>Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority">Run priority</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    ///   - [`parameters(Document)`](crate::operation::start_run::builders::StartRunFluentBuilder::parameters) / [`set_parameters(Option<Document>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_parameters):<br>required: **false**<br><p>Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.</p><br>
    ///   - [`storage_capacity(i32)`](crate::operation::start_run::builders::StartRunFluentBuilder::storage_capacity) / [`set_storage_capacity(Option<i32>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_storage_capacity):<br>required: **false**<br><p>The <code>STATIC</code> storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is <code>DYNAMIC</code> (the system ignores any value that you enter).</p><br>
    ///   - [`output_uri(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::output_uri) / [`set_output_uri(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_output_uri):<br>required: **true**<br><p>An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.</p><br>
    ///   - [`log_level(RunLogLevel)`](crate::operation::start_run::builders::StartRunFluentBuilder::log_level) / [`set_log_level(Option<RunLogLevel>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_log_level):<br>required: **false**<br><p>A log level for the run.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_tags):<br>required: **false**<br><p>Tags for the run. You can add up to 50 tags per run. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html">Adding a tag</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    ///   - [`request_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_request_id):<br>required: **true**<br><p>An idempotency token used to dedupe retry requests so that duplicate runs are not created.</p><br>
    ///   - [`retention_mode(RunRetentionMode)`](crate::operation::start_run::builders::StartRunFluentBuilder::retention_mode) / [`set_retention_mode(Option<RunRetentionMode>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_retention_mode):<br>required: **false**<br><p>The retention mode for the run. The default value is <code>RETAIN</code>.</p> <p>Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (<code>RETAIN</code>), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to <code>REMOVE</code>, Amazon Web Services HealthOmics automatically removes runs (that have mode set to <code>REMOVE</code>) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.</p> <p>For more information about retention mode, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Specifying run retention mode</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    ///   - [`storage_type(StorageType)`](crate::operation::start_run::builders::StartRunFluentBuilder::storage_type) / [`set_storage_type(Option<StorageType>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_storage_type):<br>required: **false**<br><p>The storage type for the run. If you set the storage type to <code>DYNAMIC</code>, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses <code>STATIC</code> storage type, which allocates a fixed amount of storage. For more information about <code>DYNAMIC</code> and <code>STATIC</code> storage, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    ///   - [`workflow_owner_id(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::workflow_owner_id) / [`set_workflow_owner_id(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_workflow_owner_id):<br>required: **false**<br><p>The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the <code>GetShare</code> API operation. If you are the workflow owner, you do not need to include this ID.</p><br>
    ///   - [`workflow_version_name(impl Into<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::workflow_version_name) / [`set_workflow_version_name(Option<String>)`](crate::operation::start_run::builders::StartRunFluentBuilder::set_workflow_version_name):<br>required: **false**<br><p>The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
    /// - On success, responds with [`StartRunOutput`](crate::operation::start_run::StartRunOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::start_run::StartRunOutput::arn): <p>Unique resource identifier for the run.</p>
    ///   - [`id(Option<String>)`](crate::operation::start_run::StartRunOutput::id): <p>The run's ID.</p>
    ///   - [`status(Option<RunStatus>)`](crate::operation::start_run::StartRunOutput::status): <p>The run's status.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::start_run::StartRunOutput::tags): <p>The run's tags.</p>
    ///   - [`uuid(Option<String>)`](crate::operation::start_run::StartRunOutput::uuid): <p>The universally unique identifier for a run.</p>
    ///   - [`run_output_uri(Option<String>)`](crate::operation::start_run::StartRunOutput::run_output_uri): <p>The destination for workflow outputs.</p>
    /// - On failure, responds with [`SdkError<StartRunError>`](crate::operation::start_run::StartRunError)
    pub fn start_run(&self) -> crate::operation::start_run::builders::StartRunFluentBuilder {
        crate::operation::start_run::builders::StartRunFluentBuilder::new(self.handle.clone())
    }
}