Amazon Config · JSON Structure

Config Organization Config Rule Status Structure

Returns the status for an organization Config rule in an organization.

Type: object Properties: 5 Required: 2
AuditingComplianceConfiguration ManagementGovernanceSecurity

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

Properties

OrganizationConfigRuleName OrganizationRuleStatus ErrorCode ErrorMessage LastUpdateTime

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-organization-config-rule-status-structure.json",
  "name": "OrganizationConfigRuleStatus",
  "description": "Returns the status for an organization Config rule in an organization.",
  "type": "object",
  "properties": {
    "OrganizationConfigRuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationConfigRuleName"
        },
        {
          "description": "The name that you assign to organization Config rule."
        }
      ]
    },
    "OrganizationRuleStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationRuleStatus"
        },
        {
          "description": "<p>Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when an organization Config rule has been successfully created in all the member accounts. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when an organization Config rule creation is in progress.</p> </li> <li> <p> <code>CREATE_FAILED</code> when an organization Config rule creation failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_FAILED</code> when an organization Config rule deletion failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when an organization Config rule deletion is in progress.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when an organization Config rule has been successfully deleted from all the member accounts.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when an organization Config rule has been successfully updated in all the member accounts.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when an organization Config rule update is in progress.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when an organization Config rule update failed in one or more member accounts within that organization.</p> </li> </ul>"
        }
      ]
    },
    "ErrorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "An error code that is returned when organization Config rule creation or deletion has failed."
        }
      ]
    },
    "ErrorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "An error message indicating that organization Config rule creation or deletion failed due to an error."
        }
      ]
    },
    "LastUpdateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Date"
        },
        {
          "description": "The timestamp of the last update."
        }
      ]
    }
  },
  "required": [
    "OrganizationConfigRuleName",
    "OrganizationRuleStatus"
  ]
}