Skip to content

Stops a CIS session

Description

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.

Usage

inspector2_stop_cis_session(scanJobId, sessionToken, message)

Arguments

  • scanJobId

    [required] A unique identifier for the scan job.

  • sessionToken

    [required] The unique token that identifies the CIS session.

  • message

    [required] The stop CIS session message.

Value

An empty list.

Request syntax

svc$stop_cis_session(
  scanJobId = "string",
  sessionToken = "string",
  message = list(
    status = "SUCCESS"|"FAILED"|"INTERRUPTED"|"UNSUPPORTED_OS",
    reason = "string",
    progress = list(
      totalChecks = 123,
      successfulChecks = 123,
      failedChecks = 123,
      notEvaluatedChecks = 123,
      unknownChecks = 123,
      notApplicableChecks = 123,
      informationalChecks = 123,
      errorChecks = 123
    ),
    computePlatform = list(
      vendor = "string",
      product = "string",
      version = "string"
    ),
    benchmarkVersion = "string",
    benchmarkProfile = "string"
  )
)