ListReports
List reports for a service, or all reports owned by the account if serviceArn is not provided.
Request Syntax
GET /v2/list-reports?maxResults=maxResults&nextToken=nextToken&reportType=reportType&serviceArn=serviceArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
Pagination page size.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
Pagination token.
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
\S{1,2000} - reportType
-
Filter reports by type.
Valid Values:
FAILURE_MODE - serviceArn
-
Optional. If not provided, lists all reports owned by the account.
Length Constraints: Minimum length of 31.
Pattern:
arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"reportGenerationResults": [
{
"assessmentId": "string",
"createdAt": number,
"reportOutput": { ... },
"reportType": "string",
"serviceArn": "string",
"status": "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
-
Pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
\S{1,2000} - reportGenerationResults
-
The list of report generation results.
Type: Array of ReportGenerationResult objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Access denied — caller lacks required permissions.
HTTP Status Code: 403
- InternalServerException
-
Internal service error.
HTTP Status Code: 500
- ResourceNotFoundException
-
Resource not found.
- resourceId
-
The identifier of the resource that was not found.
- resourceType
-
The type of the resource that was not found.
HTTP Status Code: 404
- ThrottlingException
-
Too many requests — rate limit exceeded.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 429
- ValidationException
-
Validation error — invalid input parameters.
- fieldList
-
The list of fields that failed validation.
- reason
-
The reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
