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

.. py:module:: laceworksdk.api.v2.cloud_activities

.. autoapi-nested-parse::

   Lacework CloudActivities API wrapper.



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

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.cloud_activities.CloudActivitiesAPI




.. py:class:: CloudActivitiesAPI(session)


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

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

   Get information about cloud activities for the integrated AWS cloud accounts in your Lacework instance.

   .. py:property:: session

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

   .. py:method:: get(start_time=None, end_time=None, **request_params)

      A method to get cloud activities objects.

      :param start_time: A "%Y-%m-%dT%H:%M:%SZ" structured timestamp to begin from.
      :type start_time: str
      :param end_time: A "%Y-%m-%dT%H:%M:%S%Z" structured timestamp to end at.
      :type end_time: str
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :returns: The requested cloud activity data.
      :rtype: dict


   .. py:method:: get_pages(start_time=None, end_time=None, **request_params)

      A method to get an iterator of activities

      A helper method that yields a generator which allows you to iterate through the resulting pages of         activities. Call this instead of the "get" method if you don't want to write your own code to get the paginated        results.

      :param start_time: A "%Y-%m-%dT%H:%M:%SZ" structured timestamp to begin from.
      :type start_time: str
      :param end_time: A "%Y-%m-%dT%H:%M:%S%Z" structured timestamp to end at.
      :type end_time: str
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :Yields: *dict* -- a generator which yields a dict of cloud activities.


   .. py:method:: get_data_items(start_time=None, end_time=None, **request_params)

      A method to get an iterator of activities

      A helper method that yields a generator which allows you to iterate through the resulting pages of
      activities. Call this instead of the "get" method if you don't want to write your own code to get the paginated
      results.

      :param start_time: A "%Y-%m-%dT%H:%M:%SZ" structured timestamp to begin from.
      :type start_time: str
      :param end_time: A "%Y-%m-%dT%H:%M:%S%Z" structured timestamp to end at.
      :type end_time: str
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :Yields: *dict* -- a generator which yields multipe dicts of cloud activities.


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

      A method to search cloud activities.

      :param json: A list of dictionaries containing the desired search parameters:

                   - 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.
      :type json: list of dicts

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