Omics / Client / get_run_cache

get_run_cache#

Omics.Client.get_run_cache(**kwargs)#

Retrieve the details for the specified run cache.

For more information, see Call caching for HealthOmics runs in the AWS HealthOmics User Guide.

Request Syntax

response = client.get_run_cache(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The identifier of the run cache to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
    'cacheBucketOwnerId': 'string',
    'cacheS3Uri': 'string',
    'creationTime': datetime(2015, 1, 1),
    'description': 'string',
    'id': 'string',
    'name': 'string',
    'status': 'ACTIVE'|'DELETED'|'FAILED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- arn (string) –
  
  Unique resource identifier for the run cache.
- cacheBehavior (string) –
  
  The default cache behavior for runs using this cache.
- cacheBucketOwnerId (string) –
  
  The identifier of the bucket owner.
- cacheS3Uri (string) –
  
  The S3 URI where the cache data is stored.
- creationTime (datetime) –
  
  Creation time of the run cache (an ISO 8601 formatted string).
- description (string) –
  
  The run cache description.
- id (string) –
  
  The run cache ID.
- name (string) –
  
  The run cache name.
- status (string) –
  
  The run cache status.
- tags (dict) –
  
  The tags associated with the run cache.
  - (string) –
    - (string) –

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException