:py:mod:`laceworksdk`
=====================

.. py:module:: laceworksdk

.. autoapi-nested-parse::

   Community-developed Python SDK for interacting with Lacework APIs.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   api/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   config/index.rst
   exceptions/index.rst
   http_session/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.LaceworkClient




.. py:class:: LaceworkClient(account=None, subaccount=None, api_key=None, api_secret=None, api_token=None, instance=None, base_domain=None, profile=None)


   Lacework API wrapper for Python.

   .. py:property:: subaccount

      Returns the value of the session's subaccount.

   .. py:method:: set_org_level_access(org_level_access)

      A method to set whether the client should use organization-level API calls.


   .. py:method:: set_subaccount(subaccount)

      A method to update the subaccount the client should use for API calls.



.. py:exception:: ApiError(response)


   Bases: :py:obj:`LaceworkSDKException`

   Errors returned in response to requests sent to the Lacework APIs.

   Several data attributes are available for inspection.

   .. py:attribute:: response

      The :class:`requests.Response` object returned from the API call.

   .. py:attribute:: request

      The :class:`requests.PreparedRequest` of the API call.

   .. py:attribute:: status_code

      The HTTP status code from the API response.

   .. py:attribute:: status

      The HTTP status from the API response.

   .. py:attribute:: details

      The parsed JSON details from the API response.

   .. py:method:: with_traceback()

      Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.



.. py:exception:: LaceworkSDKException


   Bases: :py:obj:`Exception`

   Base class for all lacework package exceptions.

   .. py:method:: with_traceback()

      Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.