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

ListReports

List available reports.

Request Syntax


GET /v1/report/list?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

Maximum number of resources to return in the paginated response.

Valid Range: Minimum value of 1. Maximum value of 300.

nextToken

Pagination token to request the next page of resources.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "reports": [ 
      { 
         "acceptanceType": "string",
         "arn": "string",
         "category": "string",
         "companyName": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "periodEnd": "string",
         "periodStart": "string",
         "productName": "string",
         "series": "string",
         "state": "string",
         "statusMessage": "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.

nextToken

Pagination token to request the next page of resources.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

reports

List of report resources.

Type: Array of ReportSummary objects

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