aws_sdk_omics/client/
create_run_cache.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 [`CreateRunCache`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cache_behavior(CacheBehavior)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::cache_behavior) / [`set_cache_behavior(Option<CacheBehavior>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_cache_behavior):<br>required: **false**<br><p>Default cache behavior for runs that use this cache. Supported values are:</p> <p><code>CACHE_ON_FAILURE</code>: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.</p> <p><code>CACHE_ALWAYS</code>: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.</p> <p>If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.</p> <p>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 AWS HealthOmics User Guide.</p><br>
7    ///   - [`cache_s3_location(impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::cache_s3_location) / [`set_cache_s3_location(Option<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_cache_s3_location):<br>required: **true**<br><p>Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_description):<br>required: **false**<br><p>Enter a description of the run cache.</p><br>
9    ///   - [`name(impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_name):<br>required: **false**<br><p>Enter a user-friendly name for the run cache.</p><br>
10    ///   - [`request_id(impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_request_id):<br>required: **true**<br><p>A unique request token, to ensure idempotency. If you don't specify a token, HealthOmics automatically generates a universally unique identifier (UUID) for the request.</p><br>
11    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_tags):<br>required: **false**<br><p>Specify one or more tags to associate with this run cache.</p><br>
12    ///   - [`cache_bucket_owner_id(impl Into<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::cache_bucket_owner_id) / [`set_cache_bucket_owner_id(Option<String>)`](crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::set_cache_bucket_owner_id):<br>required: **false**<br><p>The AWS account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.</p><br>
13    /// - On success, responds with [`CreateRunCacheOutput`](crate::operation::create_run_cache::CreateRunCacheOutput) with field(s):
14    ///   - [`arn(Option<String>)`](crate::operation::create_run_cache::CreateRunCacheOutput::arn): <p>Unique resource identifier for the run cache.</p>
15    ///   - [`id(Option<String>)`](crate::operation::create_run_cache::CreateRunCacheOutput::id): <p>Identifier for the run cache.</p>
16    ///   - [`status(Option<RunCacheStatus>)`](crate::operation::create_run_cache::CreateRunCacheOutput::status): <p>Run cache status.</p>
17    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_run_cache::CreateRunCacheOutput::tags): <p>The tags associated with this run cache.</p>
18    /// - On failure, responds with [`SdkError<CreateRunCacheError>`](crate::operation::create_run_cache::CreateRunCacheError)
19    pub fn create_run_cache(&self) -> crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder {
20        crate::operation::create_run_cache::builders::CreateRunCacheFluentBuilder::new(self.handle.clone())
21    }
22}