describe_organization_resource_collection_health ¶

def describe_organization_resource_collection_health(
    self,
    organization_resource_collection_type: "capo_devops_guru.types.organization_resource_collection_type.OrganizationResourceCollectionType",
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    account_ids: Optional[
        "capo_devops_guru.types.account_id_list.AccountIdList"
    ] = None,
    organizational_unit_ids: Optional[
        "capo_devops_guru.types.organizational_unit_id_list.OrganizationalUnitIdList"
    ] = None,
    next_token: Optional[
        "capo_devops_guru.types.uuid_next_token.UuidNextToken"
    ] = None,
    max_results: Optional[
        "capo_devops_guru.types.organization_resource_collection_max_results.OrganizationResourceCollectionMaxResults"
    ] = None,
) -> "capo_devops_guru.types.describe_organization_resource_collection_health_response.DescribeOrganizationResourceCollectionHealthResponse":
    """<p>Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the <code>AccountIds</code> field.</p>

    Args:
        organization_resource_collection_type: <p> An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
        account_ids: <p>The ID of the Amazon Web Services account.</p>
        organizational_unit_ids: <p>The ID of the organizational unit.</p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>

    Raises:
        capo_devops_guru.errors.access_denied_exception.AccessDeniedException: <p> You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </p>
        capo_devops_guru.errors.internal_server_exception.InternalServerException: <p>An internal failure in an Amazon service occurred.</p>
        capo_devops_guru.errors.throttling_exception.ThrottlingException: <p>The request was denied due to a request throttling.</p>
        capo_devops_guru.errors.validation_exception.ValidationException: <p> Contains information about data passed in to a field during a request that is not valid. </p>
        capo_devops_guru.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_devops_guru.types.describe_organization_resource_collection_health_request.DescribeOrganizationResourceCollectionHealthRequest]",
    ) -> OperationResponse[
        "capo_devops_guru.types.describe_organization_resource_collection_health_response.DescribeOrganizationResourceCollectionHealthResponse"
    ]:
        import capo_devops_guru._operations.capstone_control_plane_service.describe_organization_resource_collection_health

        output, http_response = (
            capo_devops_guru._operations.capstone_control_plane_service.describe_organization_resource_collection_health.describe_organization_resource_collection_health(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeOrganizationResourceCollectionHealth"),
    )
    input_: capo_devops_guru.types.describe_organization_resource_collection_health_request.DescribeOrganizationResourceCollectionHealthRequest = {
        "organization_resource_collection_type": organization_resource_collection_type
    }
    if account_ids is not None:
        input_["account_ids"] = account_ids
    if organizational_unit_ids is not None:
        input_["organizational_unit_ids"] = organizational_unit_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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