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

.. py:module:: laceworksdk.api.v2.schemas

.. autoapi-nested-parse::

   Lacework Schemas API wrapper.



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

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.schemas.SchemasAPI




.. py:class:: SchemasAPI(session)


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

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

   Get details about the available Lacework schemas.

   .. py:property:: session

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

   .. py:method:: get(type=None, subtype=None)

      A method to get schema objects. Using no args will get all schemas.

      :param type: The schema type to retrieve. Valid values are any API resource listed in the Lacework API          `documentation <https://docs.lacework.net/api/v2/docs/>`_ .Examples include "AlertChannels", "CloudAccounts",           "AgentAccessTokens", etc..
      :type type: str, optional
      :param subtype: The subtype to retrieve. Subtypes are only available for API resources that have           "type" like fields. For instance the "AlertChannels" resource has subtypes such as "AwsS3", "SlackChannel",           etc. See the Lacework API `documentation <https://docs.lacework.net/api/v2/docs/>`_ for more info.
      :type subtype: str, optional

      :returns: The requested schema
      :rtype: dict


   .. py:method:: get_by_subtype(type, subtype)

      A method to fetch a specific subtype schema.

      :param type: The schema type to retrieve. Valid values are any API resource listed in the Lacework API          `documentation <https://docs.lacework.net/api/v2/docs/>`_ .Examples include "AlertChannels", "CloudAccounts",           "AgentAccessTokens", etc..
      :type type: str
      :param subtype: The subtype to retrieve. Subtypes are only available for API resources that have           "type" like fields. For instance the "AlertChannels" resource has subtypes such as "AwsS3", "SlackChannel",           etc. See the Lacework API `documentation <https://docs.lacework.net/api/v2/docs/>`_ for more info.
      :type subtype: str

      :returns: The requested schema
      :rtype: dict