# DescribeCacheReport


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

## Request Syntax


```
{
   "CacheReportARN": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CacheReportARN](#API_DescribeCacheReport_RequestSyntax) **   <a name="StorageGateway-DescribeCacheReport-request-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to describe.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax


```
{
   "CacheReportInfo": { 
      "CacheReportARN": "string",
      "CacheReportStatus": "string",
      "EndTime": number,
      "ExclusionFilters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ],
      "FileShareARN": "string",
      "InclusionFilters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ],
      "LocationARN": "string",
      "ReportCompletionPercent": number,
      "ReportName": "string",
      "Role": "string",
      "StartTime": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportInfo](#API_DescribeCacheReport_ResponseSyntax) **   <a name="StorageGateway-DescribeCacheReport-response-CacheReportInfo"></a>
Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.  
Type: [CacheReportInfo](API_CacheReportInfo.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples


### Get information about a cache report


The following example gets information about the cache report with the specified ARN.

#### Sample Request


```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeCacheReport

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

#### Sample Response


```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportInfo": {
        "CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share-ABCD1234/cache-report/report-ABCD1234",
        "CacheReportStatus": "COMPLETED",
        "ReportCompletionPercent": 100,
        "EndTime": "2025-02-11T21:32:09.535000+00:00",
        "Role": "arn:aws:iam::123456789012:role/bucket-access-role",
        "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234",
        "LocationARN": "arn:aws:s3:::bucket-name",
        "StartTime": "2025-02-11T21:31:42.081000+00:00",
        "InclusionFilters": [
            {
                "Name": "UploadFailureReason",
                "Values": [
                    "InaccessibleStorageClass",
                    "ObjectMissing"
                ]
            }
        ],
        "ReportName": "cache_report-ABCD1234_1739309502081.csv",
        "Tags": []
    }
}
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeCacheReport)