Amazon CodeBuild · JSON Structure

Amazon Codebuild Delete Report Group Input Structure

DeleteReportGroupInput schema from Amazon CodeBuild

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

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

Properties

arn deleteReports

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-delete-report-group-input-structure.json",
  "name": "DeleteReportGroupInput",
  "description": "DeleteReportGroupInput schema from Amazon CodeBuild",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The ARN of the report group to delete. "
        }
      ]
    },
    "deleteReports": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "<p>If <code>true</code>, deletes any reports that belong to a report group before deleting the report group. </p> <p>If <code>false</code>, you must delete any reports in the report group. Use <a href=\"https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html\">ListReportsForReportGroup</a> to get the reports in a report group. Use <a href=\"https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html\">DeleteReport</a> to delete the reports. If you call <code>DeleteReportGroup</code> for a report group that contains one or more reports, an exception is thrown. </p>"
        }
      ]
    }
  },
  "required": [
    "arn"
  ]
}