run_caches

Creates, updates, deletes, gets or lists a run_caches resource.

Overview

Name	run_caches
Type	Resource
Id	aws.omics.run_caches

Fields

The following fields are returned by SELECT queries:

get_run_cache

Name	Datatype	Description
id	string	The run cache ID. (pattern: <code>[0-9]+</code>)
name	string	The run cache name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	Unique resource identifier for the run cache. (pattern: <code>arn:.+</code>)
cache_behavior	string	The default cache behavior for runs using this cache. (CACHE_ON_FAILURE, CACHE_ALWAYS)
cache_bucket_owner_id	string	The identifier of the bucket owner. (pattern: <code>[0-9]+</code>)
cache_s3_uri	string	Uri to a S3 object or bucket (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?</code>)
creation_time	string (date-time)	Creation time of the run cache (an ISO 8601 formatted string).
description	string	The run cache description. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
status	string	The run cache status. (ACTIVE, DELETED, FAILED)
tags	object	The tags associated with the run cache.

list_run_caches

Name	Datatype	Description
id	string	The identifier for this run cache. (pattern: <code>[0-9]+</code>)
name	string	The name of the run cache. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	Unique resource identifier for the run cache. (pattern: <code>arn:.+</code>)
cache_behavior	string	Default cache behavior for the run cache. (CACHE_ON_FAILURE, CACHE_ALWAYS)
cache_s3_uri	string	Uri to a S3 object or bucket (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?</code>)
creation_time	string (date-time)	The time that this run cache was created (an ISO 8601 formatted string).
status	string	The run cache status. (ACTIVE, DELETED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_run_cache	select	id, region		Retrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.
list_run_caches	select	region	maxResults, startingToken	Retrieves a list of your run caches and the metadata for each cache.
create_run_cache	insert	region, cacheS3Location, requestId		Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.
update_run_cache	update	id, region		Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation. For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.
delete_run_cache	delete	id, region		Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations. For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	Run cache identifier for the cache you want to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return.
startingToken	string	Optional pagination token returned from a prior call to the ListRunCaches API operation.

SELECT examples

get_run_cache

Retrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

SELECT
id,
name,
arn,
cache_behavior,
cache_bucket_owner_id,
cache_s3_uri,
creation_time,
description,
status,
tags
FROM aws.omics.run_caches
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_run_caches

Retrieves a list of your run caches and the metadata for each cache.

SELECT
id,
name,
arn,
cache_behavior,
cache_s3_uri,
creation_time,
status
FROM aws.omics.run_caches
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND startingToken = '{{ startingToken }}'
;

INSERT examples

create_run_cache

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.

INSERT INTO aws.omics.run_caches (
cacheBehavior,
cacheS3Location,
description,
name,
requestId,
tags,
cacheBucketOwnerId,
region
)
SELECT 
'{{ cacheBehavior }}',
'{{ cacheS3Location }}' /* required */,
'{{ description }}',
'{{ name }}',
'{{ requestId }}' /* required */,
'{{ tags }}',
'{{ cacheBucketOwnerId }}',
'{{ region }}'
RETURNING
id,
arn,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: run_caches
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the run_caches resource.
  - name: cacheBehavior
    value: "{{ cacheBehavior }}"
    valid_values: ['CACHE_ON_FAILURE', 'CACHE_ALWAYS']
  - name: cacheS3Location
    value: "{{ cacheS3Location }}"
    description: |
      Uri to a S3 object or bucket
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: tags
    value: "{{ tags }}"
  - name: cacheBucketOwnerId
    value: "{{ cacheBucketOwnerId }}"

UPDATE examples

update_run_cache

Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation. For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.

UPDATE aws.omics.run_caches
SET 
cacheBehavior = '{{ cacheBehavior }}',
description = '{{ description }}',
name = '{{ name }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_run_cache

Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations. For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

DELETE FROM aws.omics.run_caches
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;