Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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

Unique resource ID for the report resource.

Pattern: report-[a-zA-Z0-9]{16}

Required: Yes

reportVersion

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

Report resource detail.

Type: ReportDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unknown server exception has occurred.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Request fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400