By default, runs don't use a run cache. To use a cache for the run, you specify the run cache and the run cache behavior when you start the run.
After a run completes, you can invoke the GetRunTask and ListRunTask API operations to inspect the cacheHit response.
If one or more tasks in a run generate non-deterministic outputs, we strongly recommend that you don’t use call caching for the run, or you opt out these specific tasks from caching. For more information, see Shared responsibility model.
Note
You provide an IAM service role when you start a run. To use call caching, the service role needs permission to access the run cache Amazon S3 location. For more information, see Service roles for AWS HealthOmics.
Topics
Configuring a run with run cache using the console
From the console, you configure the run cache for a run when you start the run.
-
Open the HealthOmics console https://console.aws.amazon.com/omics/
. In the left navigation pane, choose Runs.
-
On the Runs page, choose the run to start.
-
Choose Start run and complete steps 1 and 2 of Start run as described in Starting a run using the console.
-
In step 3 of Start run, choose Select an existing run cache.
-
Select the cache from the Run cache ID drop-down list.
-
To override the default run cache behavior, choose the Cache behavior for the run. For more information, see Run cache behavior.
-
Continue to step 4 of Start run.
Configuring a run with run cache using the CLI
To start a run that uses a run cache, add the cache-id parameter to the start-run CLI command. Optionally, use the cache-behavior parameter to override the
default behavior that you configured for the run cache. The following example shows only the cache fields for
the command:
aws omics start-run \
...
--cache-id "xxxxxx" \
--cache-behavior CACHE_ALWAYS
If the operation is successful, you receive a response with no data fields.
Tracking your run cache hits
For runs that use call caching, HealthOmics creates a CloudWatch Logs entry when it:
creates a cache entry (CACHE_ENTRY_CREATED)
matches a cache entry (CACHE_HIT)
fails to match a cache entry (CACHE_MISS)
For more information about these logs, see Logs in CloudWatch .
Error cases for run caches
For the following scenarios, HealthOmics may not cache task outputs, even for a run with cache behavior set to Cache always.
-
If the run encounters an error before the first task completes successfully, there are no cache outputs to export.
-
If the export process fails, HealthOmics doesn't save the task outputs to the Amazon S3 cache location.
-
If the run fails due to a filesystem out of space error, call caching doesn't save any task outputs.
-
If you cancel a run, call caching doesn't save any task outputs.
-
If your run fails because of a run timeout, call caching doesn't save any task outputs.
