Amazon CodeBuild · JSON Structure

Amazon Codebuild List Report Groups Input Structure

ListReportGroupsInput schema from Amazon CodeBuild

Type: object Properties: 4
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

ListReportGroupsInput is a JSON Structure definition published by Amazon CodeBuild, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

sortOrder sortBy nextToken maxResults

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-list-report-groups-input-structure.json",
  "name": "ListReportGroupsInput",
  "description": "ListReportGroupsInput schema from Amazon CodeBuild",
  "type": "object",
  "properties": {
    "sortOrder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortOrderType"
        },
        {
          "description": " Used to specify the order to sort the list of returned report groups. Valid values are <code>ASCENDING</code> and <code>DESCENDING</code>. "
        }
      ]
    },
    "sortBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReportGroupSortByType"
        },
        {
          "description": "<p> The criterion to be used to list build report groups. Valid values include: </p> <ul> <li> <p> <code>CREATED_TIME</code>: List based on when each report group was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List based on when each report group was last changed.</p> </li> <li> <p> <code>NAME</code>: List based on each report group's name.</p> </li> </ul>"
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. "
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": " The maximum number of paginated report groups returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. "
        }
      ]
    }
  }
}