inspectorscan
*************


Client
======

class inspectorscan.Client

   A low-level client representing Inspector Scan (inspector-scan)

   Amazon Inspector Scan is a vulnerability discovery service that
   scans a provided Software Bill of Materials (SBOM) for security
   vulnerabilities.

      import boto3

      client = boto3.client('inspector-scan')

These are the available methods:

* can_paginate

* close

* get_paginator

* get_waiter

* scan_sbom
inspectorscan / Client / get_paginator


get_paginator
*************

inspectorscan.Client.get_paginator(operation_name)

   Create a paginator for an operation.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Raises:
      **OperationNotPageableError** -- Raised if the operation is not
      pageable.  You can use the "client.can_paginate" method to check
      if an operation is pageable.

   Return type:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
inspectorscan / Client / scan_sbom


scan_sbom
*********

inspectorscan.Client.scan_sbom(**kwargs)

   Scans a provided CycloneDX 1.5 SBOM and reports on any
   vulnerabilities discovered in that SBOM. You can generate
   compatible SBOMs for your resources using the >>`<<Amazon Inspector
   SBOM generator.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.scan_sbom(
          sbom={...}|[...]|123|123.4|'string'|True|None,
          outputFormat='CYCLONE_DX_1_5'|'INSPECTOR'
      )

   Parameters:
      * **sbom** (*document*) --

        **[REQUIRED]**

        The JSON file for the SBOM you want to scan. The SBOM must be
        in CycloneDX 1.5 format.

      * **outputFormat** (*string*) -- The output format for the
        vulnerability report.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'sbom': {...}|[...]|123|123.4|'string'|True|None
         }

      **Response Structure**

      * *(dict) --*

        * **sbom** (*document*) --

          The vulnerability report for the scanned SBOM.

   **Exceptions**

   * "inspectorscan.Client.exceptions.InternalServerException"

   * "inspectorscan.Client.exceptions.ThrottlingException"

   * "inspectorscan.Client.exceptions.ValidationException"

   * "inspectorscan.Client.exceptions.AccessDeniedException"
inspectorscan / Client / can_paginate


can_paginate
************

inspectorscan.Client.can_paginate(operation_name)

   Check if an operation can be paginated.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Returns:
      "True" if the operation can be paginated, "False" otherwise.
inspectorscan / Client / get_waiter


get_waiter
**********

inspectorscan.Client.get_waiter(waiter_name)

   Returns an object that can wait for some condition.

   Parameters:
      **waiter_name** (*str*) -- The name of the waiter to get. See
      the waiters section of the service docs for a list of available
      waiters.

   Returns:
      The specified waiter object.

   Return type:
      "botocore.waiter.Waiter"
inspectorscan / Client / close


close
*****

inspectorscan.Client.close()

   Closes underlying endpoint connections.