AWS Config
API Reference (API Version 2014-11-12)

OrganizationConfigRuleStatus

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

Contents

ErrorCode

An error code that is returned when organization config rule creation or deletion has failed.

Type: String

Required: No

ErrorMessage

An error message indicating that organization config rule creation or deletion failed due to an error.

Type: String

Required: No

LastUpdateTime

The timestamp of the last update.

Type: Timestamp

Required: No

OrganizationConfigRuleName

The name that you assign to organization config rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*\S.*

Required: Yes

OrganizationRuleStatus

Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master 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 master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

AWS Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when an organization config rule has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization config rule creation is in progress.

  • CREATE_FAILED when an organization config rule creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization config rule deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization config rule deletion is in progress.

  • DELETE_SUCCESSFUL when an organization config rule has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization config rule has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization config rule update is in progress.

  • UPDATE_FAILED when an organization config rule update failed in one or more member accounts within that organization.

Type: String

Valid Values: CREATE_SUCCESSFUL | CREATE_IN_PROGRESS | CREATE_FAILED | UPDATE_SUCCESSFUL | UPDATE_FAILED | UPDATE_IN_PROGRESS | DELETE_SUCCESSFUL | DELETE_FAILED | DELETE_IN_PROGRESS

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: