ConfigService / Paginator / GetOrganizationConfigRuleDetailedStatus

GetOrganizationConfigRuleDetailedStatus

class ConfigService.Paginator.GetOrganizationConfigRuleDetailedStatus

paginator = client.get_paginator('get_organization_config_rule_detailed_status')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationConfigRuleName='string',
    Filters={
        'AccountId': 'string',
        'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OrganizationConfigRuleName (string) –

  [REQUIRED]

  The name of your organization Config rule for which you want status details for member accounts.

• Filters (dict) –

  A StatusDetailFilters object.

  • AccountId (string) –

    The 12-digit account ID of the member account within an organization.

  • MemberAccountRuleStatus (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.

• 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

{
    'OrganizationConfigRuleDetailedStatus': [
        {
            'AccountId': 'string',
            'ConfigRuleName': 'string',
            'MemberAccountRuleStatus': '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) –

  • OrganizationConfigRuleDetailedStatus (list) –

    A list of MemberAccountStatus objects.

    • (dict) –

      Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

      • AccountId (string) –

        The 12-digit account ID of a member account.

      • ConfigRuleName (string) –

        The name of Config rule deployed in the member account.

      • MemberAccountRuleStatus (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.

      • ErrorCode (string) –

        An error code that is returned when Config rule creation or deletion failed in the member account.

      • ErrorMessage (string) –

        An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.

      • LastUpdateTime (datetime) –

        The timestamp of the last status update.