Omics / Client / list_run_caches

list_run_caches#

Omics.Client.list_run_caches(**kwargs)#

Retrieves a list of your run caches.

See also: AWS API Documentation

Request Syntax

response = client.list_run_caches(
    maxResults=123,
    startingToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return.

  • startingToken (string) – Optional pagination token returned from a prior call to the ListRunCaches API operation.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
            'cacheS3Uri': 'string',
            'creationTime': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'DELETED'|'FAILED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Details about each run cache in the response.

      • (dict) –

        List entry for one run cache.

        • arn (string) –

          Unique resource identifier for the run cache.

        • cacheBehavior (string) –

          Default cache behavior for the run cache.

        • cacheS3Uri (string) –

          The S3 uri for the run cache data.

        • creationTime (datetime) –

          The time that this run cache was created (an ISO 8601 formatted string).

        • id (string) –

          The identifier for this run cache.

        • name (string) –

          The name of the run cache.

        • status (string) –

          The run cache status.

    • nextToken (string) –

      Pagination token to retrieve additional run caches. If the response does not have a ``nextToken``value, you have reached to the end of the list.

Exceptions