get_organization_config_rule_detailed_status ¶

def get_organization_config_rule_detailed_status(
    self,
    organization_config_rule_name: "capo_config_service.types.organization_config_rule_name.OrganizationConfigRuleName",
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
    filters: Optional[
        "capo_config_service.types.status_detail_filters.StatusDetailFilters"
    ] = None,
    limit: Optional[
        "capo_config_service.types.cosmos_page_limit.CosmosPageLimit"
    ] = None,
    next_token: Optional["capo_config_service.types.string.String"] = None,
) -> "capo_config_service.types.get_organization_config_rule_detailed_status_response.GetOrganizationConfigRuleDetailedStatusResponse":
    """<p>Returns detailed status for each member account within an organization for a given organization Config rule.</p>

    Args:
        organization_config_rule_name: <p>The name of your organization Config rule for which you want status details for member accounts.</p>
        filters: <p>A <code>StatusDetailFilters</code> object.</p>
        limit: <p>The maximum number of <code>OrganizationConfigRuleDetailedStatus</code> returned on each page. If you do not specify a number, Config uses the default. The default is 100.</p>
        next_token: <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>

    Raises:
        capo_config_service.errors.invalid_limit_exception.InvalidLimitException: <p>The specified limit is outside the allowable range.</p>
        capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
        capo_config_service.errors.no_such_organization_config_rule_exception.NoSuchOrganizationConfigRuleException: <p>The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>
        capo_config_service.errors.organization_access_denied_exception.OrganizationAccessDeniedException: <p>For <code>PutConfigurationAggregator</code> API, you can see this exception for the following reasons:</p> <ul> <li> <p>No permission to call <code>EnableAWSServiceAccess</code> API</p> </li> <li> <p>The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.</p> </li> <li> <p>The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.</p> </li> <li> <p>You are not a registered delegated administrator for Config with permissions to call <code>ListDelegatedAdministrators</code> API. Ensure that the management account registers delagated administrator for Config service principal name before the delegated administrator creates an aggregator.</p> </li> </ul> <p>For all <code>OrganizationConfigRule</code> and <code>OrganizationConformancePack</code> APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_config_service.types.get_organization_config_rule_detailed_status_request.GetOrganizationConfigRuleDetailedStatusRequest]",
    ) -> OperationResponse[
        "capo_config_service.types.get_organization_config_rule_detailed_status_response.GetOrganizationConfigRuleDetailedStatusResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.get_organization_config_rule_detailed_status

        output, http_response = (
            capo_config_service._operations.starling_dove_service.get_organization_config_rule_detailed_status.get_organization_config_rule_detailed_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetOrganizationConfigRuleDetailedStatus"),
    )
    input_: capo_config_service.types.get_organization_config_rule_detailed_status_request.GetOrganizationConfigRuleDetailedStatusRequest = {
        "organization_config_rule_name": organization_config_rule_name
    }
    if filters is not None:
        input_["filters"] = filters
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output