:doc:`Omics <../../omics>` / Client / list_run_caches

***************
list_run_caches
***************



.. py:method:: Omics.Client.list_run_caches(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunCaches>`_  


  **Request Syntax**
  ::

    response = client.list_run_caches(
        maxResults=123,
        startingToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return.

    

  
  :type startingToken: string
  :param startingToken: 

    Optional pagination token returned from a prior call to the ``ListRunCaches`` API operation.

    

  
  
  :rtype: 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**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  