Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListReports

Returns a list of ARNs for the reports in the current AWS account.

Request Syntax


{
   "filter": { 
      "status": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "sortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

filter

A ReportFilter object used to filter the returned reports.

Type: ReportFilter object

Required: No

maxResults

The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

Type: Integer

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

Required: No

nextToken

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Type: String

Required: No

sortOrder

Specifies the sort order for the list of returned reports. Valid values are:

ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax


{
   "nextToken": "string",
   "reports": [ "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.

nextToken

Type: String

reports

The list of returned ARNs for the reports in the current AWS account.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1.

Errors

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

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400