# GetReportMetadata


Get the metadata for a single report.

## Request Syntax


```
GET /v1/report/getMetadata?reportId=reportId&reportVersion=reportVersion HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [reportId](#API_GetReportMetadata_RequestSyntax) **   <a name="artifact-GetReportMetadata-request-uri-reportId"></a>
Unique resource ID for the report resource.  
Pattern: `report-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [reportVersion](#API_GetReportMetadata_RequestSyntax) **   <a name="artifact-GetReportMetadata-request-uri-reportVersion"></a>
Version for the report resource.  
Valid Range: Minimum value of 1.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "reportDetails": { 
      "acceptanceType": "string",
      "arn": "string",
      "category": "string",
      "companyName": "string",
      "createdAt": "string",
      "deletedAt": "string",
      "description": "string",
      "id": "string",
      "lastModifiedAt": "string",
      "name": "string",
      "periodEnd": "string",
      "periodStart": "string",
      "productName": "string",
      "sequenceNumber": number,
      "series": "string",
      "state": "string",
      "statusMessage": "string",
      "termArn": "string",
      "uploadState": "string",
      "version": number
   }
}
```

## 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.

 ** [reportDetails](#API_GetReportMetadata_ResponseSyntax) **   <a name="artifact-GetReportMetadata-response-reportDetails"></a>
Report resource detail.  
Type: [ReportDetail](API_ReportDetail.md) object

## Errors


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

 ** AccessDeniedException **   
User does not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unknown server exception has occurred.    
 ** retryAfterSeconds **   
Number of seconds in which the caller can retry the request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource which does not exist.    
 ** resourceId **   
Identifier of the affected resource.  
 ** resourceType **   
Type of the affected resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.    
 ** quotaCode **   
Code for the affected quota.  
 ** resourceId **   
Identifier of the affected resource.  
 ** resourceType **   
Type of the affected resource.  
 ** serviceCode **   
Code for the affected service.
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied due to request throttling.    
 ** quotaCode **   
Code for the affected quota.  
 ** retryAfterSeconds **   
Number of seconds in which the caller can retry the request.  
 ** serviceCode **   
Code for the affected service.
HTTP Status Code: 429

 ** ValidationException **   
Request fails to satisfy the constraints specified by an AWS service.    
 ** fieldList **   
The field that caused the error, if applicable.  
 ** reason **   
Reason the request failed validation.
HTTP Status Code: 400

## 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/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/artifact-2018-05-10/GetReportMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/artifact-2018-05-10/GetReportMetadata)