Skip to content

OrganizationConfigRuleStatus

Source code in docs_src/capo_config_service/types/organization_config_rule_status.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class OrganizationConfigRuleStatus(TypedDict, closed=True):
    organization_config_rule_name: "capo_config_service.types.organization_config_rule_name.OrganizationConfigRuleName"
    """<p>The name that you assign to organization Config rule.</p>"""
    organization_rule_status: (
        "capo_config_service.types.organization_rule_status.OrganizationRuleStatus"
    )
    """<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>"""
    error_code: NotRequired["capo_config_service.types.string.String"]
    """<p>An error code that is returned when organization Config rule creation or deletion has failed.</p>"""
    error_message: NotRequired["capo_config_service.types.string.String"]
    """<p>An error message indicating that organization Config rule creation or deletion failed due to an error.</p>"""
    last_update_time: NotRequired["capo_config_service.types.date.Date"]
    """<p>The timestamp of the last update.</p>"""

error_code instance-attribute 

error_code: NotRequired[String]

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

error_message instance-attribute 

error_message: NotRequired[String]

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

last_update_time instance-attribute 

last_update_time: NotRequired[Date]

The timestamp of the last update.

organization_config_rule_name instance-attribute 

organization_config_rule_name: OrganizationConfigRuleName

The name that you assign to organization Config rule.

organization_rule_status instance-attribute 

organization_rule_status: OrganizationRuleStatus

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 config-multiaccountsetup.amazonaws.com.

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.