:doc:`Inspector2 <../../inspector2>` / Client / stop_cis_session

****************
stop_cis_session
****************



.. py:method:: Inspector2.Client.stop_cis_session(**kwargs)

  

  Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/StopCisSession>`_  


  **Request Syntax**
  ::

    response = client.stop_cis_session(
        scanJobId='string',
        sessionToken='string',
        message={
            'status': 'SUCCESS'|'FAILED'|'INTERRUPTED'|'UNSUPPORTED_OS',
            'reason': 'string',
            'progress': {
                'totalChecks': 123,
                'successfulChecks': 123,
                'failedChecks': 123,
                'notEvaluatedChecks': 123,
                'unknownChecks': 123,
                'notApplicableChecks': 123,
                'informationalChecks': 123,
                'errorChecks': 123
            },
            'computePlatform': {
                'vendor': 'string',
                'product': 'string',
                'version': 'string'
            },
            'benchmarkVersion': 'string',
            'benchmarkProfile': 'string'
        }
    )
    
  :type scanJobId: string
  :param scanJobId: **[REQUIRED]** 

    A unique identifier for the scan job.

    

  
  :type sessionToken: string
  :param sessionToken: **[REQUIRED]** 

    The unique token that identifies the CIS session.

    

  
  :type message: dict
  :param message: **[REQUIRED]** 

    The stop CIS session message.

    

  
    - **status** *(string) --* **[REQUIRED]** 

      The status of the message.

      

    
    - **reason** *(string) --* 

      The reason for the message.

      

    
    - **progress** *(dict) --* **[REQUIRED]** 

      The progress of the message.

      

    
      - **totalChecks** *(integer) --* 

        The progress' total checks.

        

      
      - **successfulChecks** *(integer) --* 

        The progress' successful checks.

        

      
      - **failedChecks** *(integer) --* 

        The progress' failed checks.

        

      
      - **notEvaluatedChecks** *(integer) --* 

        The progress' not evaluated checks.

        

      
      - **unknownChecks** *(integer) --* 

        The progress' unknown checks.

        

      
      - **notApplicableChecks** *(integer) --* 

        The progress' not applicable checks.

        

      
      - **informationalChecks** *(integer) --* 

        The progress' informational checks.

        

      
      - **errorChecks** *(integer) --* 

        The progress' error checks.

        

      
    
    - **computePlatform** *(dict) --* 

      The message compute platform.

      

    
      - **vendor** *(string) --* 

        The compute platform vendor.

        

      
      - **product** *(string) --* 

        The compute platform product.

        

      
      - **version** *(string) --* 

        The compute platform version.

        

      
    
    - **benchmarkVersion** *(string) --* 

      The message benchmark version.

      

    
    - **benchmarkProfile** *(string) --* 

      The message benchmark profile.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Inspector2.Client.exceptions.ConflictException`

  
  *   :py:class:`Inspector2.Client.exceptions.ValidationException`

  
  *   :py:class:`Inspector2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Inspector2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Inspector2.Client.exceptions.InternalServerException`

  