Retrieves one or more code coverage reports¶

Description¶

Retrieves one or more code coverage reports.

Usage¶

codebuild_describe_code_coverages(reportArn, nextToken, maxResults,
  sortOrder, sortBy, minLineCoveragePercentage, maxLineCoveragePercentage)

Arguments¶

• reportArn

  [required] The ARN of the report for which test cases are returned.

• nextToken

  The nextToken value returned from a previous call to describe_code_coverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

• maxResults

  The maximum number of results to return.

• sortOrder

  Specifies if the results are sorted in ascending or descending order.

• 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.

• minLineCoveragePercentage

  The minimum line coverage percentage to report.

• maxLineCoveragePercentage

  The maximum line coverage percentage to report.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  codeCoverages = list(
    list(
      id = "string",
      reportARN = "string",
      filePath = "string",
      lineCoveragePercentage = 123.0,
      linesCovered = 123,
      linesMissed = 123,
      branchCoveragePercentage = 123.0,
      branchesCovered = 123,
      branchesMissed = 123,
      expired = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$describe_code_coverages(
  reportArn = "string",
  nextToken = "string",
  maxResults = 123,
  sortOrder = "ASCENDING"|"DESCENDING",
  sortBy = "LINE_COVERAGE_PERCENTAGE"|"FILE_PATH",
  minLineCoveragePercentage = 123.0,
  maxLineCoveragePercentage = 123.0
)