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

.. py:module:: laceworksdk.api.v2.inventory

.. autoapi-nested-parse::

   Lacework Inventory API wrapper.



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

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.inventory.InventoryAPI




.. py:class:: InventoryAPI(session)


   Bases: :py:obj:`laceworksdk.api.search_endpoint.SearchEndpoint`

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

   View and monitor in-use cloud resources' risk, compliance, and configuration changes.

   .. py:property:: session

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

   .. py:method:: scan(csp)

      A method to trigger a resource inventory scan.

      :param csp: The cloud service provider to run the scan on. Valid values are: "AWS" "Azure" "GCP"
      :type csp: string

      :returns: Status of scan
      :rtype: dict


   .. py:method:: status(csp)

      A method to get the status of a Resource Inventory scan.

      :param csp: The cloud service provider to run the scan on. Valid values are: "AWS" "Azure" "GCP"
      :type csp: string

      :returns: Status of scan
      :rtype: dict


   .. py:method:: search(json=None, resource=None)

      A method to search objects.

      See the API documentation for this API endpoint for valid fields to search against.

      NOTE: While the "value" and "values" fields are marked as "optional" you must use one of them,
      depending on the operation you are using.

      :param json: The desired search parameters:

                   - timeFilter (dict, optional): A dict containing the time frame for the search:

                       - startTime (str): The start time for the search
                       - endTime (str): The end time for the search

                   - filters (list of dict, optional): Filters based on field contents:

                       - field (str): The name of the data field to which the condition applies

                       - expression (str): The comparison operator for the filter condition. Valid values are:


                       "eq", "ne", "in", "not_in", "like", "ilike", "not_like", "not_ilike", "not_rlike", "rlike", "gt", "ge",                 "lt", "le", "between"


                       - value (str, optional):  The value that the condition checks for in the specified field. Use this attribute                 when using an operator that requires a single value.
                       - values (list of str, optional): The values that the condition checks for in the specified field. Use this                 attribute when using an operator that requires multiple values.
                   - returns (list of str, optional): The fields to return
      :type json: dict
      :param resource: The Lacework API resource to search (Example: "AlertChannels")
      :type resource: str

      :Yields: *dict* -- returns a generator which yields a page of objects at a time as returned by the Lacework API.