describe_organization_overview ¶

def describe_organization_overview(
    self,
    from_time: "capo_devops_guru.types.timestamp.Timestamp",
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    to_time: Optional["capo_devops_guru.types.timestamp.Timestamp"] = 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,
) -> "capo_devops_guru.types.describe_organization_overview_response.DescribeOrganizationOverviewResponse":
    """<p>Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.</p>

    Args:
        from_time: <p> The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day. </p>
        to_time: <p> The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used. </p>
        account_ids: <p>The ID of the Amazon Web Services account.</p>
        organizational_unit_ids: <p>The ID of the organizational unit.</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_overview_request.DescribeOrganizationOverviewRequest]",
    ) -> OperationResponse[
        "capo_devops_guru.types.describe_organization_overview_response.DescribeOrganizationOverviewResponse"
    ]:
        import capo_devops_guru._operations.capstone_control_plane_service.describe_organization_overview

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOrganizationOverview")
    )
    input_: capo_devops_guru.types.describe_organization_overview_request.DescribeOrganizationOverviewRequest = {
        "from_time": from_time
    }
    if to_time is not None:
        input_["to_time"] = to_time
    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

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