:py:mod:`laceworksdk.api.v2.reports`
====================================

.. py:module:: laceworksdk.api.v2.reports

.. autoapi-nested-parse::

   Lacework Reports API wrapper.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.reports.ReportsAPI




.. py:class:: ReportsAPI(session)


   Bases: :py:obj:`laceworksdk.api.base_endpoint.BaseEndpoint`

   A class used to represent the `Reports API endpoint <https://docs.lacework.net/api/v2/docs/#tag/Reports>`_

   Lacework combines details about non-compliant resources that are in violation into reports. You must configure at
   least one cloud integration with AWS, Azure, or GCP to receive these reports.

   .. py:property:: session

      Get the :class:`HttpSession` instance the object is using.

   .. py:method:: get(primary_query_id=None, secondary_query_id=None, format=None, report_type=None, **request_params)

      A method to get Reports objects.

      :param primary_query_id: The primary ID that is used to fetch the report. (AWS Account ID or Azure Tenant ID)
      :type primary_query_id: str
      :param secondary_query_id: The secondary ID that is used to fetch the report. (GCP Project ID or Azure Subscription ID)
      :type secondary_query_id: str
      :param format: The format of the report. Valid values: "csv", "html", "json", "pdf"
      :type format: str, optional
      :param report_type: The type of the report. See `available reports <https://docs.lacework.net/console/compliance-frameworks>`_ for a list of report types.          Valid values are in the "API Format" column.
      :type report_type: str
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :returns: The details of the report
      :rtype: dict