:doc:`StorageGateway <../../storagegateway>` / Paginator / ListCacheReports

****************
ListCacheReports
****************



.. py:class:: StorageGateway.Paginator.ListCacheReports

  ::

    
    paginator = client.get_paginator('list_cache_reports')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`StorageGateway.Client.list_cache_reports`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListCacheReports>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'CacheReportList': [
                {
                    'CacheReportARN': 'string',
                    'CacheReportStatus': 'IN_PROGRESS'|'COMPLETED'|'CANCELED'|'FAILED'|'ERROR',
                    'ReportCompletionPercent': 123,
                    'EndTime': datetime(2015, 1, 1),
                    'Role': 'string',
                    'FileShareARN': 'string',
                    'LocationARN': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'InclusionFilters': [
                        {
                            'Name': 'UploadState'|'UploadFailureReason',
                            'Values': [
                                'string',
                            ]
                        },
                    ],
                    'ExclusionFilters': [
                        {
                            'Name': 'UploadState'|'UploadFailureReason',
                            'Values': [
                                'string',
                            ]
                        },
                    ],
                    'ReportName': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CacheReportList** *(list) --* 

          A list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the ``DescribeCacheReport`` action, such as report status, completion progress, start time, end time, filters, and tags.

          
          

          - *(dict) --* 

            Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.

            
            

            - **CacheReportARN** *(string) --* 

              The Amazon Resource Name (ARN) of the cache report you want to describe.

              
            

            - **CacheReportStatus** *(string) --* 

              The status of the specified cache report.

              
            

            - **ReportCompletionPercent** *(integer) --* 

              The percentage of the report generation process that has been completed at time of inquiry.

              
            

            - **EndTime** *(datetime) --* 

              The time at which the gateway stopped generating the cache report.

              
            

            - **Role** *(string) --* 

              The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

              
            

            - **FileShareARN** *(string) --* 

              The Amazon Resource Name (ARN) of the file share.

              
            

            - **LocationARN** *(string) --* 

              The ARN of the Amazon S3 bucket location where the cache report is saved.

              
            

            - **StartTime** *(datetime) --* 

              The time at which the gateway started generating the cache report.

              
            

            - **InclusionFilters** *(list) --* 

              The list of filters and parameters that determine which files are included in the report.

              
              

              - *(dict) --* 

                A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a ``StartCacheReport`` request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.

                
                

                - **Name** *(string) --* 

                  The parameter name for a filter that determines which files are included or excluded from a cache report.

                   

                  **Valid Names:**

                   

                  UploadFailureReason | UploadState

                  
                

                - **Values** *(list) --* 

                  The parameter value for a filter that determines which files are included or excluded from a cache report.

                   

                  Valid ``UploadFailureReason`` Values:

                   

                  ``InaccessibleStorageClass`` | ``InvalidObjectState`` | ``ObjectMissing`` | ``S3AccessDenied``

                   

                  Valid ``UploadState`` Values:

                   

                  ``FailingUpload``

                  
                  

                  - *(string) --* 
              
            
          
            

            - **ExclusionFilters** *(list) --* 

              The list of filters and parameters that determine which files are excluded from the report.

              
              

              - *(dict) --* 

                A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a ``StartCacheReport`` request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.

                
                

                - **Name** *(string) --* 

                  The parameter name for a filter that determines which files are included or excluded from a cache report.

                   

                  **Valid Names:**

                   

                  UploadFailureReason | UploadState

                  
                

                - **Values** *(list) --* 

                  The parameter value for a filter that determines which files are included or excluded from a cache report.

                   

                  Valid ``UploadFailureReason`` Values:

                   

                  ``InaccessibleStorageClass`` | ``InvalidObjectState`` | ``ObjectMissing`` | ``S3AccessDenied``

                   

                  Valid ``UploadState`` Values:

                   

                  ``FailingUpload``

                  
                  

                  - *(string) --* 
              
            
          
            

            - **ReportName** *(string) --* 

              The file name of the completed cache report object stored in Amazon S3.

              
            

            - **Tags** *(list) --* 

              The list of key/value tags associated with the report.

              
              

              - *(dict) --* 

                A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

                
                

                - **Key** *(string) --* 

                  Tag key. The key can't start with aws:.

                  
                

                - **Value** *(string) --* 

                  Value of the tag key.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    