Amazon Config · JSON Structure

Config Get Aggregate Compliance Details By Config Rule Request Structure

GetAggregateComplianceDetailsByConfigRuleRequest schema

Type: object Properties: 7 Required: 4
AuditingComplianceConfiguration ManagementGovernanceSecurity

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

Properties

ConfigurationAggregatorName ConfigRuleName AccountId AwsRegion ComplianceType Limit NextToken

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-config/refs/heads/main/json-structure/config-get-aggregate-compliance-details-by-config-rule-request-structure.json",
  "name": "GetAggregateComplianceDetailsByConfigRuleRequest",
  "description": "GetAggregateComplianceDetailsByConfigRuleRequest schema",
  "type": "object",
  "properties": {
    "ConfigurationAggregatorName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationAggregatorName"
        },
        {
          "description": "The name of the configuration aggregator."
        }
      ]
    },
    "ConfigRuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigRuleName"
        },
        {
          "description": "The name of the Config rule for which you want compliance information."
        }
      ]
    },
    "AccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountId"
        },
        {
          "description": "The 12-digit account ID of the source account."
        }
      ]
    },
    "AwsRegion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsRegion"
        },
        {
          "description": "The source region from where the data is aggregated."
        }
      ]
    },
    "ComplianceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComplianceType"
        },
        {
          "description": "<p>The resource compliance status.</p> <note> <p>For the <code>GetAggregateComplianceDetailsByConfigRuleRequest</code> data type, Config supports only the <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. Config does not support the <code>NOT_APPLICABLE</code> and <code>INSUFFICIENT_DATA</code> values.</p> </note>"
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limit"
        },
        {
          "description": "The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response."
        }
      ]
    }
  },
  "required": [
    "ConfigurationAggregatorName",
    "ConfigRuleName",
    "AccountId",
    "AwsRegion"
  ]
}