ConfigService / Client / describe_organization_config_rule_statuses

describe_organization_config_rule_statuses

ConfigService.Client.describe_organization_config_rule_statuses(**kwargs)

Provides organization Config rule deployment status for an organization.

Note

The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization_config_rule_statuses(
    OrganizationConfigRuleNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters:

• OrganizationConfigRuleNames (list) –

  The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

  • (string) –

• Limit (integer) – The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

• NextToken (string) – The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationConfigRuleStatuses': [
        {
            'OrganizationConfigRuleName': 'string',
            'OrganizationRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • OrganizationConfigRuleStatuses (list) –

    A list of OrganizationConfigRuleStatus objects.

    • (dict) –

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

      • OrganizationConfigRuleName (string) –

        The name that you assign to organization Config rule.

      • OrganizationRuleStatus (string) –

        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.

      • ErrorCode (string) –

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

      • ErrorMessage (string) –

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

      • LastUpdateTime (datetime) –

        The timestamp of the last update.

  • NextToken (string) –

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Exceptions

• ConfigService.Client.exceptions.NoSuchOrganizationConfigRuleException

• ConfigService.Client.exceptions.InvalidLimitException

• ConfigService.Client.exceptions.InvalidNextTokenException

• ConfigService.Client.exceptions.OrganizationAccessDeniedException