:doc:`StorageGateway <../../storagegateway>` / Client / describe_cache_report

*********************
describe_cache_report
*********************



.. py:method:: StorageGateway.Client.describe_cache_report(**kwargs)

  

  Returns information about the specified cache report, including completion status and generation progress.

  

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


  **Request Syntax**
  ::

    response = client.describe_cache_report(
        CacheReportARN='string'
    )
    
  :type CacheReportARN: string
  :param CacheReportARN: **[REQUIRED]** 

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

    

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

    
    ::

      {
          'CacheReportInfo': {
              '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'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CacheReportInfo** *(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.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  