organization_config_rule_detailed_status

Creates, updates, deletes, gets or lists an organization_config_rule_detailed_status resource.

Overview

Name	organization_config_rule_detailed_status
Type	Resource
Id	aws.config.organization_config_rule_detailed_status

Fields

The following fields are returned by SELECT queries:

get_organization_config_rule_detailed_status

Name	Datatype	Description
account_id	string	The 12-digit account ID of a member account. (pattern: <code>\d{12}</code>)
config_rule_name	string	The name of Config rule deployed in the member account.
error_code	string	An error code that is returned when Config rule creation or deletion failed in the member account.
error_message	string	An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.
last_update_time	string (date-time)	The timestamp of the last status update.
member_account_rule_status	string	Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com. Config sets the state of the rule to: CREATE_SUCCESSFUL when Config rule has been created in the member account. CREATE_IN_PROGRESS when Config rule is being created in the member account. CREATE_FAILED when Config rule creation has failed in the member account. DELETE_FAILED when Config rule deletion has failed in the member account. DELETE_IN_PROGRESS when Config rule is being deleted in the member account. DELETE_SUCCESSFUL when Config rule has been deleted in the member account. UPDATE_SUCCESSFUL when Config rule has been updated in the member account. UPDATE_IN_PROGRESS when Config rule is being updated in the member account. UPDATE_FAILED when Config rule deletion has failed in the member account. (CREATE_SUCCESSFUL, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_SUCCESSFUL, DELETE_FAILED, DELETE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_IN_PROGRESS, UPDATE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_organization_config_rule_detailed_status	select	region		Returns detailed status for each member account within an organization for a given organization Config rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_organization_config_rule_detailed_status

Returns detailed status for each member account within an organization for a given organization Config rule.

SELECT
account_id,
config_rule_name,
error_code,
error_message,
last_update_time,
member_account_rule_status
FROM aws.config.organization_config_rule_detailed_status
WHERE region = '{{ region }}' -- required
;