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

*******************
cancel_cache_report
*******************



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

  

  Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.

  

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


  **Request Syntax**
  ::

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

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

    

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

    
    ::

      {
          'CacheReportARN': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

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

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

  