Querying the Compliance of Config Rules

Function

This API is used to query the compliance of Config rules of an enrolled account.

URI

GET https://{endpoint}/v1/governance/managed-accounts/{managed_account_id}/config-rule-compliances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
managed_account_id	Yes	String	ID of an enrolled account.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
account_id	String	ID of an enrolled account.
config_rule_compliances	Array of ConfigRuleCompliance objects	Compliance of Config rules.

**Table 3** ConfigRuleCompliance
Parameter	Type	Description
rule_name	String	Compliance rules.
status	String	Compliance status.
region	String	Region information.
control_id	String	Governance policy ID.

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 5** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying the compliance of Config rules of an enrolled account in an organization

GET https://{endpoint}/v1/governance/managed-accounts/{managed_account_id}/config-rule-compliances

Example Responses

Status code: 200

Request succeeded.

{
  "account_id" : "string",
  "config_rule_compliances" : [ {
    "rule_name" : "string",
    "status" : "string",
    "region" : "string",
    "control_id" : "string"
  } ]
}