DescribeCodeCoverages
Retrieves one or more code coverage reports.
Request Syntax
{
"maxLineCoveragePercentage": number,
"maxResults": number,
"minLineCoveragePercentage": number,
"nextToken": "string",
"reportArn": "string",
"sortBy": "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.
- reportArn
-
The ARN of the report for which test cases are returned.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- maxLineCoveragePercentage
-
The maximum line coverage percentage to report.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- maxResults
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- minLineCoveragePercentage
-
The minimum line coverage percentage to report.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- nextToken
-
The
nextTokenvalue returned from a previous call toDescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.Type: String
Required: No
- sortBy
-
Specifies how the results are sorted. Possible values are:
- FILE_PATH
-
The results are sorted by file path.
- LINE_COVERAGE_PERCENTAGE
-
The results are sorted by the percentage of lines that are covered.
Type: String
Valid Values:
LINE_COVERAGE_PERCENTAGE | FILE_PATHRequired: No
- sortOrder
-
Specifies if the results are sorted in ascending or descending order.
Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
Response Syntax
{
"codeCoverages": [
{
"branchCoveragePercentage": number,
"branchesCovered": number,
"branchesMissed": number,
"expired": number,
"filePath": "string",
"id": "string",
"lineCoveragePercentage": number,
"linesCovered": number,
"linesMissed": number,
"reportARN": "string"
}
],
"nextToken": "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.
- codeCoverages
-
An array of
CodeCoverageobjects that contain the results.Type: Array of CodeCoverage objects
- nextToken
-
If there are more items to return, this contains a token that is passed to a subsequent call to
DescribeCodeCoveragesto retrieve the next set of items.Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
