Amazon Config · Schema

GetAggregateComplianceDetailsByConfigRuleRequest

GetAggregateComplianceDetailsByConfigRuleRequest schema

AuditingComplianceConfiguration ManagementGovernanceSecurity

Properties

Name Type Description
ConfigurationAggregatorName object
ConfigRuleName object
AccountId object
AwsRegion object
ComplianceType object
Limit object
NextToken object
View JSON Schema on GitHub

JSON Schema

config-get-aggregate-compliance-details-by-config-rule-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-schema/config-get-aggregate-compliance-details-by-config-rule-request-schema.json",
  "title": "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"
  ]
}