AWS.InspectorScan — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using InspectorScan

var inspectorscan = new AWS.InspectorScan();
inspectorscan.scanSbom(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the InspectorScan object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var inspectorscan = new AWS.InspectorScan({apiVersion: '2023-08-08'});

You can also set the API version globally in AWS.config.apiVersions using the inspectorscan service identifier:

AWS.config.apiVersions = {
  inspectorscan: '2023-08-08',
  // other service API versions
};

var inspectorscan = new AWS.InspectorScan();

Constructor Summarycollapse

• new AWS.InspectorScan(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• scanSbom(params = {}, callback) ⇒ AWS.Request
  Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.InspectorScan(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

scanSbom(params = {}, callback) ⇒ AWS.Request

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.