ConfigService / Paginator / DescribeOrganizationConfigRuleStatuses

DescribeOrganizationConfigRuleStatuses

class ConfigService.Paginator.DescribeOrganizationConfigRuleStatuses

paginator = client.get_paginator('describe_organization_config_rule_statuses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConfigService.Client.describe_organization_config_rule_statuses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationConfigRuleNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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)
        },
    ],

}

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.