Amazon Config · JSON Structure

Config Describe Compliance By Resource Request Structure

Type: object Properties: 5
AuditingComplianceConfiguration ManagementGovernanceSecurity

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

Properties

ResourceType ResourceId ComplianceTypes 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-describe-compliance-by-resource-request-structure.json",
  "name": "DescribeComplianceByResourceRequest",
  "description": "<p/>",
  "type": "object",
  "properties": {
    "ResourceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringWithCharLimit256"
        },
        {
          "description": "The types of Amazon Web Services resources for which you want compliance information (for example, <code>AWS::EC2::Instance</code>). For this action, you can specify that the resource type is an Amazon Web Services account by specifying <code>AWS::::Account</code>."
        }
      ]
    },
    "ResourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BaseResourceId"
        },
        {
          "description": "The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>."
        }
      ]
    },
    "ComplianceTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComplianceTypes"
        },
        {
          "description": "Filters the results by compliance."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limit"
        },
        {
          "description": "The maximum number of evaluation results returned on each page. The default is 10. 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."
        }
      ]
    }
  }
}