Inspector2 / Client / stop_cis_session

stop_cis_session#

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 start a CIS scan session for the scan ID supplied by the service.

See also: AWS API Documentation

Request Syntax

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

  • message (dict) –

    [REQUIRED]

    The stop CIS session message.

    • benchmarkProfile (string) –

      The message benchmark profile.

    • benchmarkVersion (string) –

      The message benchmark version.

    • computePlatform (dict) –

      The message compute platform.

      • product (string) –

        The compute platform product.

      • vendor (string) –

        The compute platform vendor.

      • version (string) –

        The compute platform version.

    • progress (dict) – [REQUIRED]

      The progress of the message.

      • errorChecks (integer) –

        The progress’ error checks.

      • failedChecks (integer) –

        The progress’ failed checks.

      • informationalChecks (integer) –

        The progress’ informational checks.

      • notApplicableChecks (integer) –

        The progress’ not applicable checks.

      • notEvaluatedChecks (integer) –

        The progress’ not evaluated checks.

      • successfulChecks (integer) –

        The progress’ successful checks.

      • totalChecks (integer) –

        The progress’ total checks.

      • unknownChecks (integer) –

        The progress’ unknown checks.

    • reason (string) –

      The reason for the message.

    • status (string) – [REQUIRED]

      The status of the message.

  • scanJobId (string) –

    [REQUIRED]

    A unique identifier for the scan job.

  • sessionToken (string) –

    [REQUIRED]

    The unique token that identifies the CIS session.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions