Amazon CodeBuild · JSON Structure

Amazon Codebuild Describe Code Coverages Input Structure

DescribeCodeCoveragesInput schema from Amazon CodeBuild

Type: object Properties: 7 Required: 1
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

DescribeCodeCoveragesInput is a JSON Structure definition published by Amazon CodeBuild, describing 7 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reportArn nextToken maxResults sortOrder sortBy minLineCoveragePercentage maxLineCoveragePercentage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-describe-code-coverages-input-structure.json",
  "name": "DescribeCodeCoveragesInput",
  "description": "DescribeCodeCoveragesInput schema from Amazon CodeBuild",
  "type": "object",
  "properties": {
    "reportArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": " The ARN of the report for which test cases are returned. "
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The <code>nextToken</code> value returned from a previous call to <code>DescribeCodeCoverages</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": "The maximum number of results to return."
        }
      ]
    },
    "sortOrder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortOrderType"
        },
        {
          "description": "Specifies if the results are sorted in ascending or descending order."
        }
      ]
    },
    "sortBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReportCodeCoverageSortByType"
        },
        {
          "description": "<p>Specifies how the results are sorted. Possible values are:</p> <dl> <dt>FILE_PATH</dt> <dd> <p>The results are sorted by file path.</p> </dd> <dt>LINE_COVERAGE_PERCENTAGE</dt> <dd> <p>The results are sorted by the percentage of lines that are covered.</p> </dd> </dl>"
        }
      ]
    },
    "minLineCoveragePercentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": "The minimum line coverage percentage to report."
        }
      ]
    },
    "maxLineCoveragePercentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": "The maximum line coverage percentage to report."
        }
      ]
    }
  },
  "required": [
    "reportArn"
  ]
}