You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Inspector2

Inherits:
AWS.Service show all
Identifier:
inspector2
API Version:
2020-06-08
Defined in:
(unknown)

Overview

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

Service Description

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

Sending a Request Using Inspector2

var inspector2 = new AWS.Inspector2();
inspector2.associateMember(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 Inspector2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var inspector2 = new AWS.Inspector2({apiVersion: '2020-06-08'});

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

AWS.config.apiVersions = {
  inspector2: '2020-06-08',
  // other service API versions
};

var inspector2 = new AWS.Inspector2();

Version:

  • 2020-06-08

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Inspector2 object

var inspector2 = new AWS.Inspector2({apiVersion: '2020-06-08'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Inspector2.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Inspector2.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Inspector2.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

Service Reference:

Examples:

Calling the associateMember operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
inspector2.associateMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      The Amazon Web Services account ID of the member account to be associated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountId — (String)

        The Amazon Web Services account ID of the successfully associated member account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

Service Reference:

Examples:

Calling the batchGetAccountStatus operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
inspector2.batchGetAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accounts — (Array<map>)

        An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

        • accountIdrequired — (String)

          The Amazon Web Services account ID.

        • resourceStaterequired — (map)

          An object detailing which resources Amazon Inspector is enabled to scan for the account.

          • ec2required — (map)

            An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.

            • errorCoderequired — (String)

              The error code explaining why the account failed to enable Amazon Inspector.

              Possible values include:
              • "ALREADY_ENABLED"
              • "ENABLE_IN_PROGRESS"
              • "DISABLE_IN_PROGRESS"
              • "SUSPEND_IN_PROGRESS"
              • "RESOURCE_NOT_FOUND"
              • "ACCESS_DENIED"
              • "INTERNAL_ERROR"
              • "SSM_UNAVAILABLE"
              • "SSM_THROTTLED"
              • "EVENTBRIDGE_UNAVAILABLE"
              • "EVENTBRIDGE_THROTTLED"
              • "RESOURCE_SCAN_NOT_DISABLED"
              • "DISASSOCIATE_ALL_MEMBERS"
              • "ACCOUNT_IS_ISOLATED"
            • errorMessagerequired — (String)

              The error message received when the account failed to enable Amazon Inspector.

            • statusrequired — (String)

              The status of Amazon Inspector for the account.

              Possible values include:
              • "ENABLING"
              • "ENABLED"
              • "DISABLING"
              • "DISABLED"
              • "SUSPENDING"
              • "SUSPENDED"
          • ecrrequired — (map)

            An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.

            • errorCoderequired — (String)

              The error code explaining why the account failed to enable Amazon Inspector.

              Possible values include:
              • "ALREADY_ENABLED"
              • "ENABLE_IN_PROGRESS"
              • "DISABLE_IN_PROGRESS"
              • "SUSPEND_IN_PROGRESS"
              • "RESOURCE_NOT_FOUND"
              • "ACCESS_DENIED"
              • "INTERNAL_ERROR"
              • "SSM_UNAVAILABLE"
              • "SSM_THROTTLED"
              • "EVENTBRIDGE_UNAVAILABLE"
              • "EVENTBRIDGE_THROTTLED"
              • "RESOURCE_SCAN_NOT_DISABLED"
              • "DISASSOCIATE_ALL_MEMBERS"
              • "ACCOUNT_IS_ISOLATED"
            • errorMessagerequired — (String)

              The error message received when the account failed to enable Amazon Inspector.

            • statusrequired — (String)

              The status of Amazon Inspector for the account.

              Possible values include:
              • "ENABLING"
              • "ENABLED"
              • "DISABLING"
              • "DISABLED"
              • "SUSPENDING"
              • "SUSPENDED"
          • lambda — (map)

            An object that described the state of Amazon Inspector scans for an account.

            • errorCoderequired — (String)

              The error code explaining why the account failed to enable Amazon Inspector.

              Possible values include:
              • "ALREADY_ENABLED"
              • "ENABLE_IN_PROGRESS"
              • "DISABLE_IN_PROGRESS"
              • "SUSPEND_IN_PROGRESS"
              • "RESOURCE_NOT_FOUND"
              • "ACCESS_DENIED"
              • "INTERNAL_ERROR"
              • "SSM_UNAVAILABLE"
              • "SSM_THROTTLED"
              • "EVENTBRIDGE_UNAVAILABLE"
              • "EVENTBRIDGE_THROTTLED"
              • "RESOURCE_SCAN_NOT_DISABLED"
              • "DISASSOCIATE_ALL_MEMBERS"
              • "ACCOUNT_IS_ISOLATED"
            • errorMessagerequired — (String)

              The error message received when the account failed to enable Amazon Inspector.

            • statusrequired — (String)

              The status of Amazon Inspector for the account.

              Possible values include:
              • "ENABLING"
              • "ENABLED"
              • "DISABLING"
              • "DISABLED"
              • "SUSPENDING"
              • "SUSPENDED"
        • staterequired — (map)

          An object detailing the status of Amazon Inspector for the account.

          • errorCoderequired — (String)

            The error code explaining why the account failed to enable Amazon Inspector.

            Possible values include:
            • "ALREADY_ENABLED"
            • "ENABLE_IN_PROGRESS"
            • "DISABLE_IN_PROGRESS"
            • "SUSPEND_IN_PROGRESS"
            • "RESOURCE_NOT_FOUND"
            • "ACCESS_DENIED"
            • "INTERNAL_ERROR"
            • "SSM_UNAVAILABLE"
            • "SSM_THROTTLED"
            • "EVENTBRIDGE_UNAVAILABLE"
            • "EVENTBRIDGE_THROTTLED"
            • "RESOURCE_SCAN_NOT_DISABLED"
            • "DISASSOCIATE_ALL_MEMBERS"
            • "ACCOUNT_IS_ISOLATED"
          • errorMessagerequired — (String)

            The error message received when the account failed to enable Amazon Inspector.

          • statusrequired — (String)

            The status of Amazon Inspector for the account.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
      • failedAccounts — (Array<map>)

        An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

        • accountIdrequired — (String)

          The Amazon Web Services account ID.

        • errorCoderequired — (String)

          The error code explaining why the account failed to enable Amazon Inspector.

          Possible values include:
          • "ALREADY_ENABLED"
          • "ENABLE_IN_PROGRESS"
          • "DISABLE_IN_PROGRESS"
          • "SUSPEND_IN_PROGRESS"
          • "RESOURCE_NOT_FOUND"
          • "ACCESS_DENIED"
          • "INTERNAL_ERROR"
          • "SSM_UNAVAILABLE"
          • "SSM_THROTTLED"
          • "EVENTBRIDGE_UNAVAILABLE"
          • "EVENTBRIDGE_THROTTLED"
          • "RESOURCE_SCAN_NOT_DISABLED"
          • "DISASSOCIATE_ALL_MEMBERS"
          • "ACCOUNT_IS_ISOLATED"
        • errorMessagerequired — (String)

          The error message received when the account failed to enable Amazon Inspector.

        • resourceStatus — (map)

          An object detailing which resources Amazon Inspector is enabled to scan for the account.

          • ec2required — (String)

            The status of Amazon Inspector scanning for Amazon EC2 resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • ecrrequired — (String)

            The status of Amazon Inspector scanning for Amazon ECR resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • lambda — (String)

            The status of Amazon Inspector scanning for AWS Lambda function resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
        • status — (String)

          The status of Amazon Inspector for the account.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "SUSPENDING"
          • "SUSPENDED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets free trial status for multiple Amazon Web Services accounts.

Service Reference:

Examples:

Calling the batchGetFreeTrialInfo operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
inspector2.batchGetFreeTrialInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      The account IDs to get free trial status for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accounts — (Array<map>)

        An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.

        • accountIdrequired — (String)

          The account associated with the Amazon Inspector free trial information.

        • freeTrialInforequired — (Array<map>)

          Contains information about the Amazon Inspector free trial for an account.

          • endrequired — (Date)

            The date and time that the Amazon Inspector free trail ends for a given account.

          • startrequired — (Date)

            The date and time that the Amazon Inspector free trail started for a given account.

          • statusrequired — (String)

            The order to sort results by.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • typerequired — (String)

            The type of scan covered by the Amazon Inspector free trail.

            Possible values include:
            • "EC2"
            • "ECR"
            • "LAMBDA"
      • failedAccounts — (Array<map>)

        An array of objects detailing any accounts that free trial data could not be returned for.

        • accountIdrequired — (String)

          The account associated with the Amazon Inspector free trial information.

        • coderequired — (String)

          The error code.

          Possible values include:
          • "ACCESS_DENIED"
          • "INTERNAL_ERROR"
        • messagerequired — (String)

          The error message returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Cancels the given findings report.

Service Reference:

Examples:

Calling the cancelFindingsReport operation

var params = {
  reportId: 'STRING_VALUE' /* required */
};
inspector2.cancelFindingsReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • reportId — (String)

      The ID of the report to be canceled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • reportId — (String)

        The ID of the canceled report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a filter resource using specified filter criteria.

Service Reference:

Examples:

Calling the createFilter operation

var params = {
  action: NONE | SUPPRESS, /* required */
  filterCriteria: { /* required */
    awsAccountId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceImageId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceSubnetId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceVpcId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageArchitecture: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageHash: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImagePushedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    ecrImageRegistry: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageRepositoryName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    exploitAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingStatus: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    firstObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    fixAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    inspectorScore: [
      {
        lowerInclusive: 'NUMBER_VALUE',
        upperInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    lambdaFunctionExecutionRoleArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionLastModifiedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    lambdaFunctionLayers: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lastObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    networkProtocol: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    portRange: [
      {
        beginInclusive: 'NUMBER_VALUE',
        endInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    relatedVulnerabilities: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    severity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    title: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    updatedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    vendorSeverity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilityId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilitySource: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerablePackages: [
      {
        architecture: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        epoch: {
          lowerInclusive: 'NUMBER_VALUE',
          upperInclusive: 'NUMBER_VALUE'
        },
        name: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        release: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLambdaLayerArn: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLayerHash: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        version: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ]
  },
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  reason: 'STRING_VALUE',
  tags: {
    '<MapKey>': 'STRING_VALUE',
    /* '<MapKey>': ... */
  }
};
inspector2.createFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • action — (String)

      Defines the action that is to be applied to the findings that match the filter.

      Possible values include:
      • "NONE"
      • "SUPPRESS"
    • description — (String)

      A description of the filter.

    • filterCriteria — (map)

      Defines the criteria to be used in the filter for querying findings.

      • awsAccountId — (Array<map>)

        Details of the Amazon Web Services account IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentId — (Array<map>)

        Details of the component IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentType — (Array<map>)

        Details of the component types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceImageId — (Array<map>)

        Details of the Amazon EC2 instance image IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceSubnetId — (Array<map>)

        Details of the Amazon EC2 instance subnet IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceVpcId — (Array<map>)

        Details of the Amazon EC2 instance VPC IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageArchitecture — (Array<map>)

        Details of the Amazon ECR image architecture types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageHash — (Array<map>)

        Details of the Amazon ECR image hashes used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImagePushedAt — (Array<map>)

        Details on the Amazon ECR image push date and time used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • ecrImageRegistry — (Array<map>)

        Details on the Amazon ECR registry used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageRepositoryName — (Array<map>)

        Details on the name of the Amazon ECR repository used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageTags — (Array<map>)

        The tags attached to the Amazon ECR container image.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • exploitAvailable — (Array<map>)

        Filters the list of AWS Lambda findings by the availability of exploits.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingArn — (Array<map>)

        Details on the finding ARNs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingStatus — (Array<map>)

        Details on the finding status types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingType — (Array<map>)

        Details on the finding types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • firstObservedAt — (Array<map>)

        Details on the date and time a finding was first seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • fixAvailable — (Array<map>)

        Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • inspectorScore — (Array<map>)

        The Amazon Inspector score to filter on.

        • lowerInclusive — (Float)

          The lowest number to be included in the filter.

        • upperInclusive — (Float)

          The highest number to be included in the filter.

      • lambdaFunctionExecutionRoleArn — (Array<map>)

        Filters the list of AWS Lambda functions by execution role.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionLastModifiedAt — (Array<map>)

        Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • lambdaFunctionLayers — (Array<map>)

        Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionName — (Array<map>)

        Filters the list of AWS Lambda functions by the name of the function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionRuntime — (Array<map>)

        Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lastObservedAt — (Array<map>)

        Details on the date and time a finding was last seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • networkProtocol — (Array<map>)

        Details on the ingress source addresses used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • portRange — (Array<map>)

        Details on the port ranges used to filter findings.

        • beginInclusive — (Integer)

          The port number the port range begins at.

        • endInclusive — (Integer)

          The port number the port range ends at.

      • relatedVulnerabilities — (Array<map>)

        Details on the related vulnerabilities used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceId — (Array<map>)

        Details on the resource IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceTags — (Array<map>)

        Details on the resource tags used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key used in the filter.

        • value — (String)

          The tag value used in the filter.

      • resourceType — (Array<map>)

        Details on the resource types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • severity — (Array<map>)

        Details on the severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • title — (Array<map>)

        Details on the finding title used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • updatedAt — (Array<map>)

        Details on the date and time a finding was last updated at used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • vendorSeverity — (Array<map>)

        Details on the vendor severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilityId — (Array<map>)

        Details on the vulnerability ID used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilitySource — (Array<map>)

        Details on the vulnerability type used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerablePackages — (Array<map>)

        Details on the vulnerable packages used to filter findings.

        • architecture — (map)

          An object that contains details on the package architecture type to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • epoch — (map)

          An object that contains details on the package epoch to filter on.

          • lowerInclusive — (Float)

            The lowest number to be included in the filter.

          • upperInclusive — (Float)

            The highest number to be included in the filter.

        • name — (map)

          An object that contains details on the name of the package to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • release — (map)

          An object that contains details on the package release to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLambdaLayerArn — (map)

          An object that describes the details of a string filter.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLayerHash — (map)

          An object that contains details on the source layer hash to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • version — (map)

          The package version to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

    • name — (String)

      The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

    • reason — (String)

      The reason for creating the filter.

    • tags — (map<String>)

      A list of tags for the filter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Number (ARN) of the successfully created filter.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a finding report.

Service Reference:

Examples:

Calling the createFindingsReport operation

var params = {
  reportFormat: CSV | JSON, /* required */
  s3Destination: { /* required */
    bucketName: 'STRING_VALUE', /* required */
    kmsKeyArn: 'STRING_VALUE', /* required */
    keyPrefix: 'STRING_VALUE'
  },
  filterCriteria: {
    awsAccountId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceImageId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceSubnetId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceVpcId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageArchitecture: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageHash: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImagePushedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    ecrImageRegistry: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageRepositoryName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    exploitAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingStatus: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    firstObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    fixAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    inspectorScore: [
      {
        lowerInclusive: 'NUMBER_VALUE',
        upperInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    lambdaFunctionExecutionRoleArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionLastModifiedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    lambdaFunctionLayers: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lastObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    networkProtocol: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    portRange: [
      {
        beginInclusive: 'NUMBER_VALUE',
        endInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    relatedVulnerabilities: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    severity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    title: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    updatedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    vendorSeverity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilityId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilitySource: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerablePackages: [
      {
        architecture: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        epoch: {
          lowerInclusive: 'NUMBER_VALUE',
          upperInclusive: 'NUMBER_VALUE'
        },
        name: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        release: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLambdaLayerArn: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLayerHash: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        version: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ]
  }
};
inspector2.createFindingsReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterCriteria — (map)

      The filter criteria to apply to the results of the finding report.

      • awsAccountId — (Array<map>)

        Details of the Amazon Web Services account IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentId — (Array<map>)

        Details of the component IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentType — (Array<map>)

        Details of the component types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceImageId — (Array<map>)

        Details of the Amazon EC2 instance image IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceSubnetId — (Array<map>)

        Details of the Amazon EC2 instance subnet IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceVpcId — (Array<map>)

        Details of the Amazon EC2 instance VPC IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageArchitecture — (Array<map>)

        Details of the Amazon ECR image architecture types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageHash — (Array<map>)

        Details of the Amazon ECR image hashes used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImagePushedAt — (Array<map>)

        Details on the Amazon ECR image push date and time used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • ecrImageRegistry — (Array<map>)

        Details on the Amazon ECR registry used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageRepositoryName — (Array<map>)

        Details on the name of the Amazon ECR repository used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageTags — (Array<map>)

        The tags attached to the Amazon ECR container image.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • exploitAvailable — (Array<map>)

        Filters the list of AWS Lambda findings by the availability of exploits.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingArn — (Array<map>)

        Details on the finding ARNs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingStatus — (Array<map>)

        Details on the finding status types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingType — (Array<map>)

        Details on the finding types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • firstObservedAt — (Array<map>)

        Details on the date and time a finding was first seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • fixAvailable — (Array<map>)

        Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • inspectorScore — (Array<map>)

        The Amazon Inspector score to filter on.

        • lowerInclusive — (Float)

          The lowest number to be included in the filter.

        • upperInclusive — (Float)

          The highest number to be included in the filter.

      • lambdaFunctionExecutionRoleArn — (Array<map>)

        Filters the list of AWS Lambda functions by execution role.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionLastModifiedAt — (Array<map>)

        Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • lambdaFunctionLayers — (Array<map>)

        Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionName — (Array<map>)

        Filters the list of AWS Lambda functions by the name of the function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionRuntime — (Array<map>)

        Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lastObservedAt — (Array<map>)

        Details on the date and time a finding was last seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • networkProtocol — (Array<map>)

        Details on the ingress source addresses used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • portRange — (Array<map>)

        Details on the port ranges used to filter findings.

        • beginInclusive — (Integer)

          The port number the port range begins at.

        • endInclusive — (Integer)

          The port number the port range ends at.

      • relatedVulnerabilities — (Array<map>)

        Details on the related vulnerabilities used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceId — (Array<map>)

        Details on the resource IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceTags — (Array<map>)

        Details on the resource tags used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key used in the filter.

        • value — (String)

          The tag value used in the filter.

      • resourceType — (Array<map>)

        Details on the resource types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • severity — (Array<map>)

        Details on the severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • title — (Array<map>)

        Details on the finding title used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • updatedAt — (Array<map>)

        Details on the date and time a finding was last updated at used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • vendorSeverity — (Array<map>)

        Details on the vendor severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilityId — (Array<map>)

        Details on the vulnerability ID used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilitySource — (Array<map>)

        Details on the vulnerability type used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerablePackages — (Array<map>)

        Details on the vulnerable packages used to filter findings.

        • architecture — (map)

          An object that contains details on the package architecture type to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • epoch — (map)

          An object that contains details on the package epoch to filter on.

          • lowerInclusive — (Float)

            The lowest number to be included in the filter.

          • upperInclusive — (Float)

            The highest number to be included in the filter.

        • name — (map)

          An object that contains details on the name of the package to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • release — (map)

          An object that contains details on the package release to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLambdaLayerArn — (map)

          An object that describes the details of a string filter.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLayerHash — (map)

          An object that contains details on the source layer hash to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • version — (map)

          The package version to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

    • reportFormat — (String)

      The format to generate the report in.

      Possible values include:
      • "CSV"
      • "JSON"
    • s3Destination — (map)

      The Amazon S3 export destination for the report.

      • bucketNamerequired — (String)

        The name of the Amazon S3 bucket to export findings to.

      • keyPrefix — (String)

        The prefix of the KMS key used to export findings.

      • kmsKeyArnrequired — (String)

        The ARN of the KMS key used to encrypt data when exporting findings.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • reportId — (String)

        The ID of the report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a filter resource.

Service Reference:

Examples:

Calling the deleteFilter operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
inspector2.deleteFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      The Amazon Resource Number (ARN) of the filter to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Number (ARN) of the filter that has been deleted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

Examples:

Calling the describeOrganizationConfiguration operation

var params = {
};
inspector2.describeOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • autoEnable — (map)

        The scan types are automatically enabled for new members of your organization.

        • ec2required — (Boolean)

          Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.

        • ecrrequired — (Boolean)

          Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.

        • lambda — (Boolean)

          Represents whether AWS Lambda scans are automatically enabled for new members of your Amazon Inspector organization.

      • maxAccountLimitReached — (Boolean)

        Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

Service Reference:

Examples:

Calling the disable operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceTypes: [
    EC2 | ECR | LAMBDA,
    /* more items */
  ]
};
inspector2.disable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      An array of account IDs you want to disable Amazon Inspector scans for.

    • resourceTypes — (Array<String>)

      The resource scan types you want to disable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accounts — (Array<map>)

        Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.

        • accountIdrequired — (String)

          The ID of the Amazon Web Services account.

        • resourceStatusrequired — (map)

          Details of the status of Amazon Inspector scans by resource type.

          • ec2required — (String)

            The status of Amazon Inspector scanning for Amazon EC2 resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • ecrrequired — (String)

            The status of Amazon Inspector scanning for Amazon ECR resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • lambda — (String)

            The status of Amazon Inspector scanning for AWS Lambda function resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
        • statusrequired — (String)

          The status of Amazon Inspector for the account.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "SUSPENDING"
          • "SUSPENDED"
      • failedAccounts — (Array<map>)

        Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.

        • accountIdrequired — (String)

          The Amazon Web Services account ID.

        • errorCoderequired — (String)

          The error code explaining why the account failed to enable Amazon Inspector.

          Possible values include:
          • "ALREADY_ENABLED"
          • "ENABLE_IN_PROGRESS"
          • "DISABLE_IN_PROGRESS"
          • "SUSPEND_IN_PROGRESS"
          • "RESOURCE_NOT_FOUND"
          • "ACCESS_DENIED"
          • "INTERNAL_ERROR"
          • "SSM_UNAVAILABLE"
          • "SSM_THROTTLED"
          • "EVENTBRIDGE_UNAVAILABLE"
          • "EVENTBRIDGE_THROTTLED"
          • "RESOURCE_SCAN_NOT_DISABLED"
          • "DISASSOCIATE_ALL_MEMBERS"
          • "ACCOUNT_IS_ISOLATED"
        • errorMessagerequired — (String)

          The error message received when the account failed to enable Amazon Inspector.

        • resourceStatus — (map)

          An object detailing which resources Amazon Inspector is enabled to scan for the account.

          • ec2required — (String)

            The status of Amazon Inspector scanning for Amazon EC2 resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • ecrrequired — (String)

            The status of Amazon Inspector scanning for Amazon ECR resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • lambda — (String)

            The status of Amazon Inspector scanning for AWS Lambda function resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
        • status — (String)

          The status of Amazon Inspector for the account.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "SUSPENDING"
          • "SUSPENDED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Disables the Amazon Inspector delegated administrator for your organization.

Service Reference:

Examples:

Calling the disableDelegatedAdminAccount operation

var params = {
  delegatedAdminAccountId: 'STRING_VALUE' /* required */
};
inspector2.disableDelegatedAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • delegatedAdminAccountId — (String)

      The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegatedAdminAccountId — (String)

        The Amazon Web Services account ID of the successfully disabled delegated administrator.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Disassociates a member account from an Amazon Inspector delegated administrator.

Service Reference:

Examples:

Calling the disassociateMember operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
inspector2.disassociateMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      The Amazon Web Services account ID of the member account to disassociate.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountId — (String)

        The Amazon Web Services account ID of the successfully disassociated member.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

Service Reference:

Examples:

Calling the enable operation

var params = {
  resourceTypes: [ /* required */
    EC2 | ECR | LAMBDA,
    /* more items */
  ],
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
inspector2.enable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      A list of account IDs you want to enable Amazon Inspector scans for.

    • clientToken — (String)

      The idempotency token for the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • resourceTypes — (Array<String>)

      The resource scan types you want to enable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accounts — (Array<map>)

        Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.

        • accountIdrequired — (String)

          The ID of the Amazon Web Services account.

        • resourceStatusrequired — (map)

          Details of the status of Amazon Inspector scans by resource type.

          • ec2required — (String)

            The status of Amazon Inspector scanning for Amazon EC2 resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • ecrrequired — (String)

            The status of Amazon Inspector scanning for Amazon ECR resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • lambda — (String)

            The status of Amazon Inspector scanning for AWS Lambda function resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
        • statusrequired — (String)

          The status of Amazon Inspector for the account.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "SUSPENDING"
          • "SUSPENDED"
      • failedAccounts — (Array<map>)

        Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.

        • accountIdrequired — (String)

          The Amazon Web Services account ID.

        • errorCoderequired — (String)

          The error code explaining why the account failed to enable Amazon Inspector.

          Possible values include:
          • "ALREADY_ENABLED"
          • "ENABLE_IN_PROGRESS"
          • "DISABLE_IN_PROGRESS"
          • "SUSPEND_IN_PROGRESS"
          • "RESOURCE_NOT_FOUND"
          • "ACCESS_DENIED"
          • "INTERNAL_ERROR"
          • "SSM_UNAVAILABLE"
          • "SSM_THROTTLED"
          • "EVENTBRIDGE_UNAVAILABLE"
          • "EVENTBRIDGE_THROTTLED"
          • "RESOURCE_SCAN_NOT_DISABLED"
          • "DISASSOCIATE_ALL_MEMBERS"
          • "ACCOUNT_IS_ISOLATED"
        • errorMessagerequired — (String)

          The error message received when the account failed to enable Amazon Inspector.

        • resourceStatus — (map)

          An object detailing which resources Amazon Inspector is enabled to scan for the account.

          • ec2required — (String)

            The status of Amazon Inspector scanning for Amazon EC2 resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • ecrrequired — (String)

            The status of Amazon Inspector scanning for Amazon ECR resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
          • lambda — (String)

            The status of Amazon Inspector scanning for AWS Lambda function resources.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "SUSPENDING"
            • "SUSPENDED"
        • status — (String)

          The status of Amazon Inspector for the account.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "SUSPENDING"
          • "SUSPENDED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Enables the Amazon Inspector delegated administrator for your Organizations organization.

Service Reference:

Examples:

Calling the enableDelegatedAdminAccount operation

var params = {
  delegatedAdminAccountId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
inspector2.enableDelegatedAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      The idempotency token for the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • delegatedAdminAccountId — (String)

      The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegatedAdminAccountId — (String)

        The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves setting configurations for Inspector scans.

Service Reference:

Examples:

Calling the getConfiguration operation

var params = {
};
inspector2.getConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ecrConfiguration — (map)

        Specifies how the ECR automated re-scan duration is currently configured for your environment.

        • rescanDurationState — (map)

          An object that contains details about the state of the ECR automated re-scan setting.

          • rescanDuration — (String)

            The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.

            Possible values include:
            • "LIFETIME"
            • "DAYS_30"
            • "DAYS_180"
          • status — (String)

            The status of changes to the ECR automated re-scan duration.

            Possible values include:
            • "SUCCESS"
            • "PENDING"
            • "FAILED"
          • updatedAt — (Date)

            A timestamp representing when the last time the ECR scan duration setting was changed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves information about the Amazon Inspector delegated administrator for your organization.

Service Reference:

Examples:

Calling the getDelegatedAdminAccount operation

var params = {
};
inspector2.getDelegatedAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegatedAdmin — (map)

        The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

        • accountId — (String)

          The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

        • relationshipStatus — (String)

          The status of the Amazon Inspector delegated administrator.

          Possible values include:
          • "CREATED"
          • "INVITED"
          • "DISABLED"
          • "ENABLED"
          • "REMOVED"
          • "RESIGNED"
          • "DELETED"
          • "EMAIL_VERIFICATION_IN_PROGRESS"
          • "EMAIL_VERIFICATION_FAILED"
          • "REGION_DISABLED"
          • "ACCOUNT_SUSPENDED"
          • "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the status of a findings report.

Service Reference:

Examples:

Calling the getFindingsReportStatus operation

var params = {
  reportId: 'STRING_VALUE'
};
inspector2.getFindingsReportStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • reportId — (String)

      The ID of the report to retrieve the status of.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • destination — (map)

        The destination of the report.

        • bucketNamerequired — (String)

          The name of the Amazon S3 bucket to export findings to.

        • keyPrefix — (String)

          The prefix of the KMS key used to export findings.

        • kmsKeyArnrequired — (String)

          The ARN of the KMS key used to encrypt data when exporting findings.

      • errorCode — (String)

        The error code of the report.

        Possible values include:
        • "INTERNAL_ERROR"
        • "INVALID_PERMISSIONS"
        • "NO_FINDINGS_FOUND"
        • "BUCKET_NOT_FOUND"
        • "INCOMPATIBLE_BUCKET_REGION"
        • "MALFORMED_KMS_KEY"
      • errorMessage — (String)

        The error message of the report.

      • filterCriteria — (map)

        The filter criteria associated with the report.

        • awsAccountId — (Array<map>)

          Details of the Amazon Web Services account IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • componentId — (Array<map>)

          Details of the component IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • componentType — (Array<map>)

          Details of the component types used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ec2InstanceImageId — (Array<map>)

          Details of the Amazon EC2 instance image IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ec2InstanceSubnetId — (Array<map>)

          Details of the Amazon EC2 instance subnet IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ec2InstanceVpcId — (Array<map>)

          Details of the Amazon EC2 instance VPC IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ecrImageArchitecture — (Array<map>)

          Details of the Amazon ECR image architecture types used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ecrImageHash — (Array<map>)

          Details of the Amazon ECR image hashes used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ecrImagePushedAt — (Array<map>)

          Details on the Amazon ECR image push date and time used to filter findings.

          • endInclusive — (Date)

            A timestamp representing the end of the time period filtered on.

          • startInclusive — (Date)

            A timestamp representing the start of the time period filtered on.

        • ecrImageRegistry — (Array<map>)

          Details on the Amazon ECR registry used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ecrImageRepositoryName — (Array<map>)

          Details on the name of the Amazon ECR repository used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • ecrImageTags — (Array<map>)

          The tags attached to the Amazon ECR container image.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • exploitAvailable — (Array<map>)

          Filters the list of AWS Lambda findings by the availability of exploits.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • findingArn — (Array<map>)

          Details on the finding ARNs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • findingStatus — (Array<map>)

          Details on the finding status types used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • findingType — (Array<map>)

          Details on the finding types used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • firstObservedAt — (Array<map>)

          Details on the date and time a finding was first seen used to filter findings.

          • endInclusive — (Date)

            A timestamp representing the end of the time period filtered on.

          • startInclusive — (Date)

            A timestamp representing the start of the time period filtered on.

        • fixAvailable — (Array<map>)

          Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • inspectorScore — (Array<map>)

          The Amazon Inspector score to filter on.

          • lowerInclusive — (Float)

            The lowest number to be included in the filter.

          • upperInclusive — (Float)

            The highest number to be included in the filter.

        • lambdaFunctionExecutionRoleArn — (Array<map>)

          Filters the list of AWS Lambda functions by execution role.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • lambdaFunctionLastModifiedAt — (Array<map>)

          Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

          • endInclusive — (Date)

            A timestamp representing the end of the time period filtered on.

          • startInclusive — (Date)

            A timestamp representing the start of the time period filtered on.

        • lambdaFunctionLayers — (Array<map>)

          Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • lambdaFunctionName — (Array<map>)

          Filters the list of AWS Lambda functions by the name of the function.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • lambdaFunctionRuntime — (Array<map>)

          Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • lastObservedAt — (Array<map>)

          Details on the date and time a finding was last seen used to filter findings.

          • endInclusive — (Date)

            A timestamp representing the end of the time period filtered on.

          • startInclusive — (Date)

            A timestamp representing the start of the time period filtered on.

        • networkProtocol — (Array<map>)

          Details on the ingress source addresses used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • portRange — (Array<map>)

          Details on the port ranges used to filter findings.

          • beginInclusive — (Integer)

            The port number the port range begins at.

          • endInclusive — (Integer)

            The port number the port range ends at.

        • relatedVulnerabilities — (Array<map>)

          Details on the related vulnerabilities used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • resourceId — (Array<map>)

          Details on the resource IDs used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • resourceTags — (Array<map>)

          Details on the resource tags used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
          • keyrequired — (String)

            The tag key used in the filter.

          • value — (String)

            The tag value used in the filter.

        • resourceType — (Array<map>)

          Details on the resource types used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • severity — (Array<map>)

          Details on the severity used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • title — (Array<map>)

          Details on the finding title used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • updatedAt — (Array<map>)

          Details on the date and time a finding was last updated at used to filter findings.

          • endInclusive — (Date)

            A timestamp representing the end of the time period filtered on.

          • startInclusive — (Date)

            A timestamp representing the start of the time period filtered on.

        • vendorSeverity — (Array<map>)

          Details on the vendor severity used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • vulnerabilityId — (Array<map>)

          Details on the vulnerability ID used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • vulnerabilitySource — (Array<map>)

          Details on the vulnerability type used to filter findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • vulnerablePackages — (Array<map>)

          Details on the vulnerable packages used to filter findings.

          • architecture — (map)

            An object that contains details on the package architecture type to filter on.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • epoch — (map)

            An object that contains details on the package epoch to filter on.

            • lowerInclusive — (Float)

              The lowest number to be included in the filter.

            • upperInclusive — (Float)

              The highest number to be included in the filter.

          • name — (map)

            An object that contains details on the name of the package to filter on.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • release — (map)

            An object that contains details on the package release to filter on.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • sourceLambdaLayerArn — (map)

            An object that describes the details of a string filter.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • sourceLayerHash — (map)

            An object that contains details on the source layer hash to filter on.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • version — (map)

            The package version to filter on.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

      • reportId — (String)

        The ID of the report.

      • status — (String)

        The status of the report.

        Possible values include:
        • "SUCCEEDED"
        • "IN_PROGRESS"
        • "CANCELLED"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets member information for your organization.

Service Reference:

Examples:

Calling the getMember operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
inspector2.getMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      The Amazon Web Services account ID of the member account to retrieve information on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • member — (map)

        Details of the retrieved member account.

        • accountId — (String)

          The Amazon Web Services account ID of the member account.

        • delegatedAdminAccountId — (String)

          The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

        • relationshipStatus — (String)

          The status of the member account.

          Possible values include:
          • "CREATED"
          • "INVITED"
          • "DISABLED"
          • "ENABLED"
          • "REMOVED"
          • "RESIGNED"
          • "DELETED"
          • "EMAIL_VERIFICATION_IN_PROGRESS"
          • "EMAIL_VERIFICATION_FAILED"
          • "REGION_DISABLED"
          • "ACCOUNT_SUSPENDED"
          • "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER"
        • updatedAt — (Date)

          A timestamp showing when the status of this member was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the permissions an account has to configure Amazon Inspector.

Service Reference:

Examples:

Calling the listAccountPermissions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  service: EC2 | ECR | LAMBDA
};
inspector2.listAccountPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    • service — (String)

      The service scan type to check permissions for.

      Possible values include:
      • "EC2"
      • "ECR"
      • "LAMBDA"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

      • permissions — (Array<map>)

        Contains details on the permissions an account has to configure Amazon Inspector.

        • operationrequired — (String)

          The operations that can be performed with the given permissions.

          Possible values include:
          • "ENABLE_SCANNING"
          • "DISABLE_SCANNING"
          • "ENABLE_REPOSITORY"
          • "DISABLE_REPOSITORY"
        • servicerequired — (String)

          The services that the permissions allow an account to perform the given operations for.

          Possible values include:
          • "EC2"
          • "ECR"
          • "LAMBDA"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists coverage details for you environment.

Service Reference:

Examples:

Calling the listCoverage operation

var params = {
  filterCriteria: {
    accountId: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrRepositoryName: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanStatusCode: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanStatusReason: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanType: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
inspector2.listCoverage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterCriteria — (map)

      An object that contains details on the filters to apply to the coverage data for your environment.

      • accountId — (Array<map>)

        An array of Amazon Web Services account IDs to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • ec2InstanceTags — (Array<map>)

        The Amazon EC2 instance tags to filter on.

        • comparisonrequired — (String)

          The operator to compare coverage on.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key associated with the coverage map filter.

        • value — (String)

          The tag value associated with the coverage map filter.

      • ecrImageTags — (Array<map>)

        The Amazon ECR image tags to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • ecrRepositoryName — (Array<map>)

        The Amazon ECR repository name to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionName — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by function names.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionRuntime — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by runtime.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionTags — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by tag.

        • comparisonrequired — (String)

          The operator to compare coverage on.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key associated with the coverage map filter.

        • value — (String)

          The tag value associated with the coverage map filter.

      • resourceId — (Array<map>)

        An array of Amazon Web Services resource IDs to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • resourceType — (Array<map>)

        An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanStatusCode — (Array<map>)

        The scan status code to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanStatusReason — (Array<map>)

        The scan status reason to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanType — (Array<map>)

        An array of Amazon Inspector scan types to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • coveredResources — (Array<map>)

        An object that contains details on the covered resources in your environment.

        • accountIdrequired — (String)

          The Amazon Web Services account ID of the covered resource.

        • resourceIdrequired — (String)

          The ID of the covered resource.

        • resourceMetadata — (map)

          An object that contains details about the metadata.

          • ec2 — (map)

            An object that contains metadata details for an Amazon EC2 instance.

            • amiId — (String)

              The ID of the Amazon Machine Image (AMI) used to launch the instance.

            • platform — (String)

              The platform of the instance.

              Possible values include:
              • "WINDOWS"
              • "LINUX"
              • "UNKNOWN"
            • tags — (map<String>)

              The tags attached to the instance.

          • ecrImage — (map)

            An object that contains details about the container metadata for an Amazon ECR image.

            • tags — (Array<String>)

              Tags associated with the Amazon ECR image metadata.

          • ecrRepository — (map)

            An object that contains details about the repository an Amazon ECR image resides in.

            • name — (String)

              The name of the Amazon ECR repository.

            • scanFrequency — (String)

              The frequency of scans.

              Possible values include:
              • "MANUAL"
              • "SCAN_ON_PUSH"
              • "CONTINUOUS_SCAN"
          • lambdaFunction — (map)

            An object that contains metadata details for an AWS Lambda function.

            • functionName — (String)

              The name of a function.

            • functionTags — (map<String>)

              The resource tags on an AWS Lambda function.

            • layers — (Array<String>)

              The layers for an AWS Lambda function. A Lambda function can have up to five layers.

            • runtime — (String)

              An AWS Lambda function's runtime.

              Possible values include:
              • "NODEJS"
              • "NODEJS_12_X"
              • "NODEJS_14_X"
              • "NODEJS_16_X"
              • "JAVA_8"
              • "JAVA_8_AL2"
              • "JAVA_11"
              • "PYTHON_3_7"
              • "PYTHON_3_8"
              • "PYTHON_3_9"
              • "UNSUPPORTED"
        • resourceTyperequired — (String)

          The type of the covered resource.

          Possible values include:
          • "AWS_EC2_INSTANCE"
          • "AWS_ECR_CONTAINER_IMAGE"
          • "AWS_ECR_REPOSITORY"
          • "AWS_LAMBDA_FUNCTION"
        • scanStatus — (map)

          The status of the scan covering the resource.

          • reasonrequired — (String)

            The reason for the scan.

            Possible values include:
            • "PENDING_INITIAL_SCAN"
            • "ACCESS_DENIED"
            • "INTERNAL_ERROR"
            • "UNMANAGED_EC2_INSTANCE"
            • "UNSUPPORTED_OS"
            • "SCAN_ELIGIBILITY_EXPIRED"
            • "RESOURCE_TERMINATED"
            • "SUCCESSFUL"
            • "NO_RESOURCES_FOUND"
            • "IMAGE_SIZE_EXCEEDED"
            • "SCAN_FREQUENCY_MANUAL"
            • "SCAN_FREQUENCY_SCAN_ON_PUSH"
            • "EC2_INSTANCE_STOPPED"
            • "PENDING_DISABLE"
            • "NO_INVENTORY"
            • "STALE_INVENTORY"
            • "EXCLUDED_BY_TAG"
            • "UNSUPPORTED_RUNTIME"
          • statusCoderequired — (String)

            The status code of the scan.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
        • scanTyperequired — (String)

          The Amazon Inspector scan type covering the resource.

          Possible values include:
          • "NETWORK"
          • "PACKAGE"
      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists Amazon Inspector coverage statistics for your environment.

Service Reference:

Examples:

Calling the listCoverageStatistics operation

var params = {
  filterCriteria: {
    accountId: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrRepositoryName: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanStatusCode: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanStatusReason: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    scanType: [
      {
        comparison: EQUALS | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  groupBy: SCAN_STATUS_CODE | SCAN_STATUS_REASON | ACCOUNT_ID | RESOURCE_TYPE | ECR_REPOSITORY_NAME,
  nextToken: 'STRING_VALUE'
};
inspector2.listCoverageStatistics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterCriteria — (map)

      An object that contains details on the filters to apply to the coverage data for your environment.

      • accountId — (Array<map>)

        An array of Amazon Web Services account IDs to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • ec2InstanceTags — (Array<map>)

        The Amazon EC2 instance tags to filter on.

        • comparisonrequired — (String)

          The operator to compare coverage on.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key associated with the coverage map filter.

        • value — (String)

          The tag value associated with the coverage map filter.

      • ecrImageTags — (Array<map>)

        The Amazon ECR image tags to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • ecrRepositoryName — (Array<map>)

        The Amazon ECR repository name to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionName — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by function names.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionRuntime — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by runtime.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • lambdaFunctionTags — (Array<map>)

        Returns coverage statistics for AWS Lambda functions filtered by tag.

        • comparisonrequired — (String)

          The operator to compare coverage on.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key associated with the coverage map filter.

        • value — (String)

          The tag value associated with the coverage map filter.

      • resourceId — (Array<map>)

        An array of Amazon Web Services resource IDs to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • resourceType — (Array<map>)

        An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanStatusCode — (Array<map>)

        The scan status code to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanStatusReason — (Array<map>)

        The scan status reason to filter on.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

      • scanType — (Array<map>)

        An array of Amazon Inspector scan types to return coverage statistics for.

        • comparisonrequired — (String)

          The operator to compare strings on.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to compare strings on.

    • groupBy — (String)

      The value to group the results by.

      Possible values include:
      • "SCAN_STATUS_CODE"
      • "SCAN_STATUS_REASON"
      • "ACCOUNT_ID"
      • "RESOURCE_TYPE"
      • "ECR_REPOSITORY_NAME"
    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • countsByGroup — (Array<map>)

        An array with the number for each group.

        • count — (Integer)

          The number of resources.

        • groupKey — (String)

          The key associated with this group

          Possible values include:
          • "SCAN_STATUS_CODE"
          • "SCAN_STATUS_REASON"
          • "ACCOUNT_ID"
          • "RESOURCE_TYPE"
          • "ECR_REPOSITORY_NAME"
      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

      • totalCounts — (Integer)

        The total number for all groups.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists information about the Amazon Inspector delegated administrator of your organization.

Service Reference:

Examples:

Calling the listDelegatedAdminAccounts operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
inspector2.listDelegatedAdminAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegatedAdminAccounts — (Array<map>)

        Details of the Amazon Inspector delegated administrator of your organization.

        • accountId — (String)

          The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

        • status — (String)

          The status of the Amazon Inspector delegated administrator.

          Possible values include:
          • "ENABLED"
          • "DISABLE_IN_PROGRESS"
      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the filters associated with your account.

Service Reference:

Examples:

Calling the listFilters operation

var params = {
  action: NONE | SUPPRESS,
  arns: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
inspector2.listFilters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • action — (String)

      The action the filter applies to matched findings.

      Possible values include:
      • "NONE"
      • "SUPPRESS"
    • arns — (Array<String>)

      The Amazon resource number (ARN) of the filter.

    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • filters — (Array<map>)

        Contains details on the filters associated with your account.

        • actionrequired — (String)

          The action that is to be applied to the findings that match the filter.

          Possible values include:
          • "NONE"
          • "SUPPRESS"
        • arnrequired — (String)

          The Amazon Resource Number (ARN) associated with this filter.

        • createdAtrequired — (Date)

          The date and time this filter was created at.

        • criteriarequired — (map)

          Details on the filter criteria associated with this filter.

          • awsAccountId — (Array<map>)

            Details of the Amazon Web Services account IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • componentId — (Array<map>)

            Details of the component IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • componentType — (Array<map>)

            Details of the component types used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ec2InstanceImageId — (Array<map>)

            Details of the Amazon EC2 instance image IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ec2InstanceSubnetId — (Array<map>)

            Details of the Amazon EC2 instance subnet IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ec2InstanceVpcId — (Array<map>)

            Details of the Amazon EC2 instance VPC IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ecrImageArchitecture — (Array<map>)

            Details of the Amazon ECR image architecture types used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ecrImageHash — (Array<map>)

            Details of the Amazon ECR image hashes used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ecrImagePushedAt — (Array<map>)

            Details on the Amazon ECR image push date and time used to filter findings.

            • endInclusive — (Date)

              A timestamp representing the end of the time period filtered on.

            • startInclusive — (Date)

              A timestamp representing the start of the time period filtered on.

          • ecrImageRegistry — (Array<map>)

            Details on the Amazon ECR registry used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ecrImageRepositoryName — (Array<map>)

            Details on the name of the Amazon ECR repository used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • ecrImageTags — (Array<map>)

            The tags attached to the Amazon ECR container image.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • exploitAvailable — (Array<map>)

            Filters the list of AWS Lambda findings by the availability of exploits.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • findingArn — (Array<map>)

            Details on the finding ARNs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • findingStatus — (Array<map>)

            Details on the finding status types used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • findingType — (Array<map>)

            Details on the finding types used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • firstObservedAt — (Array<map>)

            Details on the date and time a finding was first seen used to filter findings.

            • endInclusive — (Date)

              A timestamp representing the end of the time period filtered on.

            • startInclusive — (Date)

              A timestamp representing the start of the time period filtered on.

          • fixAvailable — (Array<map>)

            Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • inspectorScore — (Array<map>)

            The Amazon Inspector score to filter on.

            • lowerInclusive — (Float)

              The lowest number to be included in the filter.

            • upperInclusive — (Float)

              The highest number to be included in the filter.

          • lambdaFunctionExecutionRoleArn — (Array<map>)

            Filters the list of AWS Lambda functions by execution role.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • lambdaFunctionLastModifiedAt — (Array<map>)

            Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

            • endInclusive — (Date)

              A timestamp representing the end of the time period filtered on.

            • startInclusive — (Date)

              A timestamp representing the start of the time period filtered on.

          • lambdaFunctionLayers — (Array<map>)

            Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • lambdaFunctionName — (Array<map>)

            Filters the list of AWS Lambda functions by the name of the function.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • lambdaFunctionRuntime — (Array<map>)

            Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • lastObservedAt — (Array<map>)

            Details on the date and time a finding was last seen used to filter findings.

            • endInclusive — (Date)

              A timestamp representing the end of the time period filtered on.

            • startInclusive — (Date)

              A timestamp representing the start of the time period filtered on.

          • networkProtocol — (Array<map>)

            Details on the ingress source addresses used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • portRange — (Array<map>)

            Details on the port ranges used to filter findings.

            • beginInclusive — (Integer)

              The port number the port range begins at.

            • endInclusive — (Integer)

              The port number the port range ends at.

          • relatedVulnerabilities — (Array<map>)

            Details on the related vulnerabilities used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • resourceId — (Array<map>)

            Details on the resource IDs used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • resourceTags — (Array<map>)

            Details on the resource tags used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
            • keyrequired — (String)

              The tag key used in the filter.

            • value — (String)

              The tag value used in the filter.

          • resourceType — (Array<map>)

            Details on the resource types used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • severity — (Array<map>)

            Details on the severity used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • title — (Array<map>)

            Details on the finding title used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • updatedAt — (Array<map>)

            Details on the date and time a finding was last updated at used to filter findings.

            • endInclusive — (Date)

              A timestamp representing the end of the time period filtered on.

            • startInclusive — (Date)

              A timestamp representing the start of the time period filtered on.

          • vendorSeverity — (Array<map>)

            Details on the vendor severity used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • vulnerabilityId — (Array<map>)

            Details on the vulnerability ID used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • vulnerabilitySource — (Array<map>)

            Details on the vulnerability type used to filter findings.

            • comparisonrequired — (String)

              The operator to use when comparing values in the filter.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
              • "NOT_EQUALS"
            • valuerequired — (String)

              The value to filter on.

          • vulnerablePackages — (Array<map>)

            Details on the vulnerable packages used to filter findings.

            • architecture — (map)

              An object that contains details on the package architecture type to filter on.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

            • epoch — (map)

              An object that contains details on the package epoch to filter on.

              • lowerInclusive — (Float)

                The lowest number to be included in the filter.

              • upperInclusive — (Float)

                The highest number to be included in the filter.

            • name — (map)

              An object that contains details on the name of the package to filter on.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

            • release — (map)

              An object that contains details on the package release to filter on.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

            • sourceLambdaLayerArn — (map)

              An object that describes the details of a string filter.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

            • sourceLayerHash — (map)

              An object that contains details on the source layer hash to filter on.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

            • version — (map)

              The package version to filter on.

              • comparisonrequired — (String)

                The operator to use when comparing values in the filter.

                Possible values include:
                • "EQUALS"
                • "PREFIX"
                • "NOT_EQUALS"
              • valuerequired — (String)

                The value to filter on.

        • description — (String)

          A description of the filter.

        • namerequired — (String)

          The name of the filter.

        • ownerIdrequired — (String)

          The Amazon Web Services account ID of the account that created the filter.

        • reason — (String)

          The reason for the filter.

        • tags — (map<String>)

          The tags attached to the filter.

        • updatedAtrequired — (Date)

          The date and time the filter was last updated at.

      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists aggregated finding data for your environment based on specific criteria.

Service Reference:

Examples:

Calling the listFindingAggregations operation

var params = {
  aggregationType: FINDING_TYPE | PACKAGE | TITLE | REPOSITORY | AMI | AWS_EC2_INSTANCE | AWS_ECR_CONTAINER | IMAGE_LAYER | ACCOUNT | AWS_LAMBDA_FUNCTION | LAMBDA_LAYER, /* required */
  accountIds: [
    {
      comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  aggregationRequest: {
    accountAggregation: {
      findingType: NETWORK_REACHABILITY | PACKAGE_VULNERABILITY,
      resourceType: AWS_EC2_INSTANCE | AWS_ECR_CONTAINER_IMAGE | AWS_LAMBDA_FUNCTION,
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    amiAggregation: {
      amis: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL | AFFECTED_INSTANCES,
      sortOrder: ASC | DESC
    },
    awsEcrContainerAggregation: {
      architectures: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      imageShas: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      imageTags: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      repositories: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      resourceIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    ec2InstanceAggregation: {
      amis: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      instanceIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      instanceTags: [
        {
          comparison: EQUALS, /* required */
          key: 'STRING_VALUE', /* required */
          value: 'STRING_VALUE'
        },
        /* more items */
      ],
      operatingSystems: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: NETWORK_FINDINGS | CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    findingTypeAggregation: {
      findingType: NETWORK_REACHABILITY | PACKAGE_VULNERABILITY,
      resourceType: AWS_EC2_INSTANCE | AWS_ECR_CONTAINER_IMAGE | AWS_LAMBDA_FUNCTION,
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    imageLayerAggregation: {
      layerHashes: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      repositories: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      resourceIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    lambdaFunctionAggregation: {
      functionNames: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      functionTags: [
        {
          comparison: EQUALS, /* required */
          key: 'STRING_VALUE', /* required */
          value: 'STRING_VALUE'
        },
        /* more items */
      ],
      resourceIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      runtimes: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    lambdaLayerAggregation: {
      functionNames: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      layerArns: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      resourceIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    packageAggregation: {
      packageNames: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC
    },
    repositoryAggregation: {
      repositories: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      sortBy: CRITICAL | HIGH | ALL | AFFECTED_IMAGES,
      sortOrder: ASC | DESC
    },
    titleAggregation: {
      resourceType: AWS_EC2_INSTANCE | AWS_ECR_CONTAINER_IMAGE | AWS_LAMBDA_FUNCTION,
      sortBy: CRITICAL | HIGH | ALL,
      sortOrder: ASC | DESC,
      titles: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      vulnerabilityIds: [
        {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
inspector2.listFindingAggregations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<map>)

      The Amazon Web Services account IDs to retrieve finding aggregation data for.

      • comparisonrequired — (String)

        The operator to use when comparing values in the filter.

        Possible values include:
        • "EQUALS"
        • "PREFIX"
        • "NOT_EQUALS"
      • valuerequired — (String)

        The value to filter on.

    • aggregationRequest — (map)

      Details of the aggregation request that is used to filter your aggregation results.

      • accountAggregation — (map)

        An object that contains details about an aggregation request based on Amazon Web Services account IDs.

        • findingType — (String)

          The type of finding.

          Possible values include:
          • "NETWORK_REACHABILITY"
          • "PACKAGE_VULNERABILITY"
        • resourceType — (String)

          The type of resource.

          Possible values include:
          • "AWS_EC2_INSTANCE"
          • "AWS_ECR_CONTAINER_IMAGE"
          • "AWS_LAMBDA_FUNCTION"
        • sortBy — (String)

          The value to sort by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The sort order (ascending or descending).

          Possible values include:
          • "ASC"
          • "DESC"
      • amiAggregation — (map)

        An object that contains details about an aggregation request based on Amazon Machine Images (AMIs).

        • amis — (Array<map>)

          The IDs of AMIs to aggregate findings for.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
          • "AFFECTED_INSTANCES"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • awsEcrContainerAggregation — (map)

        An object that contains details about an aggregation request based on Amazon ECR container images.

        • architectures — (Array<map>)

          The architecture of the containers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • imageShas — (Array<map>)

          The image SHA values.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • imageTags — (Array<map>)

          The image tags.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • repositories — (Array<map>)

          The container repositories.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • resourceIds — (Array<map>)

          The container resource IDs.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The sort order (ascending or descending).

          Possible values include:
          • "ASC"
          • "DESC"
      • ec2InstanceAggregation — (map)

        An object that contains details about an aggregation request based on Amazon EC2 instances.

        • amis — (Array<map>)

          The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • instanceIds — (Array<map>)

          The Amazon EC2 instance IDs to aggregate findings for.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • instanceTags — (Array<map>)

          The Amazon EC2 instance tags to aggregate findings for.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
          • keyrequired — (String)

            The tag key used in the filter.

          • value — (String)

            The tag value used in the filter.

        • operatingSystems — (Array<map>)

          The operating system types to aggregate findings for. Valid values must be uppercase and underscore separated, examples are ORACLE_LINUX_7 and ALPINE_LINUX_3_8.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "NETWORK_FINDINGS"
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • findingTypeAggregation — (map)

        An object that contains details about an aggregation request based on finding types.

        • findingType — (String)

          The finding type to aggregate.

          Possible values include:
          • "NETWORK_REACHABILITY"
          • "PACKAGE_VULNERABILITY"
        • resourceType — (String)

          The resource type to aggregate.

          Possible values include:
          • "AWS_EC2_INSTANCE"
          • "AWS_ECR_CONTAINER_IMAGE"
          • "AWS_LAMBDA_FUNCTION"
        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • imageLayerAggregation — (map)

        An object that contains details about an aggregation request based on container image layers.

        • layerHashes — (Array<map>)

          The hashes associated with the layers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • repositories — (Array<map>)

          The repository associated with the container image hosting the layers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • resourceIds — (Array<map>)

          The ID of the container image layer.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • lambdaFunctionAggregation — (map)

        Returns an object with findings aggregated by AWS Lambda function.

        • functionNames — (Array<map>)

          The AWS Lambda function names to include in the aggregation results.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • functionTags — (Array<map>)

          The tags to include in the aggregation results.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
          • keyrequired — (String)

            The tag key used in the filter.

          • value — (String)

            The tag value used in the filter.

        • resourceIds — (Array<map>)

          The resource IDs to include in the aggregation results.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • runtimes — (Array<map>)

          Returns findings aggregated by AWS Lambda function runtime environments.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The finding severity to use for sorting the results.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to use for sorting the results.

          Possible values include:
          • "ASC"
          • "DESC"
      • lambdaLayerAggregation — (map)

        Returns an object with findings aggregated by AWS Lambda layer.

        • functionNames — (Array<map>)

          The names of the AWS Lambda functions associated with the layers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • layerArns — (Array<map>)

          The Amazon Resource Name (ARN) of the AWS Lambda function layer.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • resourceIds — (Array<map>)

          The resource IDs for the AWS Lambda function layers.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The finding severity to use for sorting the results.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to use for sorting the results.

          Possible values include:
          • "ASC"
          • "DESC"
      • packageAggregation — (map)

        An object that contains details about an aggregation request based on operating system package type.

        • packageNames — (Array<map>)

          The names of packages to aggregate findings on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • repositoryAggregation — (map)

        An object that contains details about an aggregation request based on Amazon ECR repositories.

        • repositories — (Array<map>)

          The names of repositories to aggregate findings on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
          • "AFFECTED_IMAGES"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
      • titleAggregation — (map)

        An object that contains details about an aggregation request based on finding title.

        • resourceType — (String)

          The resource type to aggregate on.

          Possible values include:
          • "AWS_EC2_INSTANCE"
          • "AWS_ECR_CONTAINER_IMAGE"
          • "AWS_LAMBDA_FUNCTION"
        • sortBy — (String)

          The value to sort results by.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "ALL"
        • sortOrder — (String)

          The order to sort results by.

          Possible values include:
          • "ASC"
          • "DESC"
        • titles — (Array<map>)

          The finding titles to aggregate on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • vulnerabilityIds — (Array<map>)

          The vulnerability IDs of the findings.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

    • aggregationType — (String)

      The type of the aggregation request.

      Possible values include:
      • "FINDING_TYPE"
      • "PACKAGE"
      • "TITLE"
      • "REPOSITORY"
      • "AMI"
      • "AWS_EC2_INSTANCE"
      • "AWS_ECR_CONTAINER"
      • "IMAGE_LAYER"
      • "ACCOUNT"
      • "AWS_LAMBDA_FUNCTION"
      • "LAMBDA_LAYER"
    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • aggregationType — (String)

        The type of aggregation to perform.

        Possible values include:
        • "FINDING_TYPE"
        • "PACKAGE"
        • "TITLE"
        • "REPOSITORY"
        • "AMI"
        • "AWS_EC2_INSTANCE"
        • "AWS_ECR_CONTAINER"
        • "IMAGE_LAYER"
        • "ACCOUNT"
        • "AWS_LAMBDA_FUNCTION"
        • "LAMBDA_LAYER"
      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

      • responses — (Array<map>)

        Objects that contain the results of an aggregation operation.

        • accountAggregation — (map)

          An object that contains details about an aggregation response based on Amazon Web Services account IDs.

          • accountId — (String)

            The Amazon Web Services account ID.

          • severityCounts — (map)

            The number of findings by severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • amiAggregation — (map)

          An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).

          • accountId — (String)

            The Amazon Web Services account ID for the AMI.

          • affectedInstances — (Integer)

            The IDs of Amazon EC2 instances using this AMI.

          • amirequired — (String)

            The ID of the AMI that findings were aggregated for.

          • severityCounts — (map)

            An object that contains the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • awsEcrContainerAggregation — (map)

          An object that contains details about an aggregation response based on Amazon ECR container images.

          • accountId — (String)

            The Amazon Web Services account ID of the account that owns the container.

          • architecture — (String)

            The architecture of the container.

          • imageSha — (String)

            The SHA value of the container image.

          • imageTags — (Array<String>)

            The container image stags.

          • repository — (String)

            The container repository.

          • resourceIdrequired — (String)

            The resource ID of the container.

          • severityCounts — (map)

            The number of finding by severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • ec2InstanceAggregation — (map)

          An object that contains details about an aggregation response based on Amazon EC2 instances.

          • accountId — (String)

            The Amazon Web Services account for the Amazon EC2 instance.

          • ami — (String)

            The Amazon Machine Image (AMI) of the Amazon EC2 instance.

          • instanceIdrequired — (String)

            The Amazon EC2 instance ID.

          • instanceTags — (map<String>)

            The tags attached to the instance.

          • networkFindings — (Integer)

            The number of network findings for the Amazon EC2 instance.

          • operatingSystem — (String)

            The operating system of the Amazon EC2 instance.

          • severityCounts — (map)

            An object that contains the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • findingTypeAggregation — (map)

          An object that contains details about an aggregation response based on finding types.

          • accountId — (String)

            The ID of the Amazon Web Services account associated with the findings.

          • severityCounts — (map)

            The value to sort results by.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • imageLayerAggregation — (map)

          An object that contains details about an aggregation response based on container image layers.

          • accountIdrequired — (String)

            The ID of the Amazon Web Services account that owns the container image hosting the layer image.

          • layerHashrequired — (String)

            The layer hash.

          • repositoryrequired — (String)

            The repository the layer resides in.

          • resourceIdrequired — (String)

            The resource ID of the container image layer.

          • severityCounts — (map)

            An object that represents the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • lambdaFunctionAggregation — (map)

          An aggregation of findings by AWS Lambda function.

          • accountId — (String)

            The ID of the AWS account that owns the AWS Lambda function.

          • functionName — (String)

            The AWS Lambda function names included in the aggregation results.

          • lambdaTags — (map<String>)

            The tags included in the aggregation results.

          • lastModifiedAt — (Date)

            The date that the AWS Lambda function included in the aggregation results was last changed.

          • resourceIdrequired — (String)

            The resource IDs included in the aggregation results.

          • runtime — (String)

            The runtimes included in the aggregation results.

          • severityCounts — (map)

            An object that contains the counts of aggregated finding per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • lambdaLayerAggregation — (map)

          An aggregation of findings by AWS Lambda layer.

          • accountIdrequired — (String)

            The account ID of the AWS Lambda function layer.

          • functionNamerequired — (String)

            The names of the AWS Lambda functions associated with the layers.

          • layerArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Lambda function layer.

          • resourceIdrequired — (String)

            The Resource ID of the AWS Lambda function layer.

          • severityCounts — (map)

            An object that contains the counts of aggregated finding per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • packageAggregation — (map)

          An object that contains details about an aggregation response based on operating system package type.

          • accountId — (String)

            The ID of the Amazon Web Services account associated with the findings.

          • packageNamerequired — (String)

            The name of the operating system package.

          • severityCounts — (map)

            An object that contains the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • repositoryAggregation — (map)

          An object that contains details about an aggregation response based on Amazon ECR repositories.

          • accountId — (String)

            The ID of the Amazon Web Services account associated with the findings.

          • affectedImages — (Integer)

            The number of container images impacted by the findings.

          • repositoryrequired — (String)

            The name of the repository associated with the findings.

          • severityCounts — (map)

            An object that represent the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

        • titleAggregation — (map)

          An object that contains details about an aggregation response based on finding title.

          • accountId — (String)

            The ID of the Amazon Web Services account associated with the findings.

          • severityCounts — (map)

            An object that represent the count of matched findings per severity.

            • all — (Integer)

              The total count of findings from all severities.

            • critical — (Integer)

              The total count of critical severity findings.

            • high — (Integer)

              The total count of high severity findings.

            • medium — (Integer)

              The total count of medium severity findings.

          • titlerequired — (String)

            The title that the findings were aggregated on.

          • vulnerabilityId — (String)

            The vulnerability ID of the finding.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists findings for your environment.

Service Reference:

Examples:

Calling the listFindings operation

var params = {
  filterCriteria: {
    awsAccountId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceImageId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceSubnetId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceVpcId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageArchitecture: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageHash: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImagePushedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    ecrImageRegistry: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageRepositoryName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    exploitAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingStatus: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    firstObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    fixAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    inspectorScore: [
      {
        lowerInclusive: 'NUMBER_VALUE',
        upperInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    lambdaFunctionExecutionRoleArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionLastModifiedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    lambdaFunctionLayers: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lastObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    networkProtocol: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    portRange: [
      {
        beginInclusive: 'NUMBER_VALUE',
        endInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    relatedVulnerabilities: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    severity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    title: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    updatedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    vendorSeverity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilityId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilitySource: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerablePackages: [
      {
        architecture: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        epoch: {
          lowerInclusive: 'NUMBER_VALUE',
          upperInclusive: 'NUMBER_VALUE'
        },
        name: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        release: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLambdaLayerArn: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLayerHash: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        version: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortCriteria: {
    field: AWS_ACCOUNT_ID | FINDING_TYPE | SEVERITY | FIRST_OBSERVED_AT | LAST_OBSERVED_AT | FINDING_STATUS | RESOURCE_TYPE | ECR_IMAGE_PUSHED_AT | ECR_IMAGE_REPOSITORY_NAME | ECR_IMAGE_REGISTRY | NETWORK_PROTOCOL | COMPONENT_TYPE | VULNERABILITY_ID | VULNERABILITY_SOURCE | INSPECTOR_SCORE | VENDOR_SEVERITY, /* required */
    sortOrder: ASC | DESC /* required */
  }
};
inspector2.listFindings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterCriteria — (map)

      Details on the filters to apply to your finding results.

      • awsAccountId — (Array<map>)

        Details of the Amazon Web Services account IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentId — (Array<map>)

        Details of the component IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentType — (Array<map>)

        Details of the component types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceImageId — (Array<map>)

        Details of the Amazon EC2 instance image IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceSubnetId — (Array<map>)

        Details of the Amazon EC2 instance subnet IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceVpcId — (Array<map>)

        Details of the Amazon EC2 instance VPC IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageArchitecture — (Array<map>)

        Details of the Amazon ECR image architecture types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageHash — (Array<map>)

        Details of the Amazon ECR image hashes used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImagePushedAt — (Array<map>)

        Details on the Amazon ECR image push date and time used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • ecrImageRegistry — (Array<map>)

        Details on the Amazon ECR registry used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageRepositoryName — (Array<map>)

        Details on the name of the Amazon ECR repository used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageTags — (Array<map>)

        The tags attached to the Amazon ECR container image.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • exploitAvailable — (Array<map>)

        Filters the list of AWS Lambda findings by the availability of exploits.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingArn — (Array<map>)

        Details on the finding ARNs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingStatus — (Array<map>)

        Details on the finding status types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingType — (Array<map>)

        Details on the finding types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • firstObservedAt — (Array<map>)

        Details on the date and time a finding was first seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • fixAvailable — (Array<map>)

        Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • inspectorScore — (Array<map>)

        The Amazon Inspector score to filter on.

        • lowerInclusive — (Float)

          The lowest number to be included in the filter.

        • upperInclusive — (Float)

          The highest number to be included in the filter.

      • lambdaFunctionExecutionRoleArn — (Array<map>)

        Filters the list of AWS Lambda functions by execution role.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionLastModifiedAt — (Array<map>)

        Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • lambdaFunctionLayers — (Array<map>)

        Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionName — (Array<map>)

        Filters the list of AWS Lambda functions by the name of the function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionRuntime — (Array<map>)

        Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lastObservedAt — (Array<map>)

        Details on the date and time a finding was last seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • networkProtocol — (Array<map>)

        Details on the ingress source addresses used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • portRange — (Array<map>)

        Details on the port ranges used to filter findings.

        • beginInclusive — (Integer)

          The port number the port range begins at.

        • endInclusive — (Integer)

          The port number the port range ends at.

      • relatedVulnerabilities — (Array<map>)

        Details on the related vulnerabilities used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceId — (Array<map>)

        Details on the resource IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceTags — (Array<map>)

        Details on the resource tags used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key used in the filter.

        • value — (String)

          The tag value used in the filter.

      • resourceType — (Array<map>)

        Details on the resource types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • severity — (Array<map>)

        Details on the severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • title — (Array<map>)

        Details on the finding title used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • updatedAt — (Array<map>)

        Details on the date and time a finding was last updated at used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • vendorSeverity — (Array<map>)

        Details on the vendor severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilityId — (Array<map>)

        Details on the vulnerability ID used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilitySource — (Array<map>)

        Details on the vulnerability type used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerablePackages — (Array<map>)

        Details on the vulnerable packages used to filter findings.

        • architecture — (map)

          An object that contains details on the package architecture type to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • epoch — (map)

          An object that contains details on the package epoch to filter on.

          • lowerInclusive — (Float)

            The lowest number to be included in the filter.

          • upperInclusive — (Float)

            The highest number to be included in the filter.

        • name — (map)

          An object that contains details on the name of the package to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • release — (map)

          An object that contains details on the package release to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLambdaLayerArn — (map)

          An object that describes the details of a string filter.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLayerHash — (map)

          An object that contains details on the source layer hash to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • version — (map)

          The package version to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    • sortCriteria — (map)

      Details on the sort criteria to apply to your finding results.

      • fieldrequired — (String)

        The finding detail field by which results are sorted.

        Possible values include:
        • "AWS_ACCOUNT_ID"
        • "FINDING_TYPE"
        • "SEVERITY"
        • "FIRST_OBSERVED_AT"
        • "LAST_OBSERVED_AT"
        • "FINDING_STATUS"
        • "RESOURCE_TYPE"
        • "ECR_IMAGE_PUSHED_AT"
        • "ECR_IMAGE_REPOSITORY_NAME"
        • "ECR_IMAGE_REGISTRY"
        • "NETWORK_PROTOCOL"
        • "COMPONENT_TYPE"
        • "VULNERABILITY_ID"
        • "VULNERABILITY_SOURCE"
        • "INSPECTOR_SCORE"
        • "VENDOR_SEVERITY"
      • sortOrderrequired — (String)

        The order by which findings are sorted.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • findings — (Array<map>)

        Contains details on the findings in your environment.

        • awsAccountIdrequired — (String)

          The Amazon Web Services account ID associated with the finding.

        • descriptionrequired — (String)

          The description of the finding.

        • exploitAvailable — (String)

          If a finding discovered in your environment has an exploit available.

          Possible values include:
          • "YES"
          • "NO"
        • exploitabilityDetails — (map)

          The details of an exploit available for a finding discovered in your environment.

          • lastKnownExploitAt — (Date)

            The date and time of the last exploit associated with a finding discovered in your environment.

        • findingArnrequired — (String)

          The Amazon Resource Number (ARN) of the finding.

        • firstObservedAtrequired — (Date)

          The date and time that the finding was first observed.

        • fixAvailable — (String)

          Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

          Possible values include:
          • "YES"
          • "NO"
          • "PARTIAL"
        • inspectorScore — (Float)

          The Amazon Inspector score given to the finding.

        • inspectorScoreDetails — (map)

          An object that contains details of the Amazon Inspector score.

          • adjustedCvss — (map)

            An object that contains details about the CVSS score given to a finding.

            • adjustments — (Array<map>)

              An object that contains details about adjustment Amazon Inspector made to the CVSS score.

              • metricrequired — (String)

                The metric used to adjust the CVSS score.

              • reasonrequired — (String)

                The reason the CVSS score has been adjustment.

            • cvssSource — (String)

              The source of the CVSS data.

            • scorerequired — (Float)

              The CVSS score.

            • scoreSourcerequired — (String)

              The source for the CVSS score.

            • scoringVectorrequired — (String)

              The vector for the CVSS score.

            • versionrequired — (String)

              The CVSS version used in scoring.

        • lastObservedAtrequired — (Date)

          The date and time that the finding was last observed.

        • networkReachabilityDetails — (map)

          An object that contains the details of a network reachability finding.

          • networkPathrequired — (map)

            An object that contains details about a network path associated with a finding.

            • steps — (Array<map>)

              The details on the steps in the network path.

              • componentIdrequired — (String)

                The component ID.

              • componentTyperequired — (String)

                The component type.

          • openPortRangerequired — (map)

            An object that contains details about the open port range associated with a finding.

            • beginrequired — (Integer)

              The beginning port in a port range.

            • endrequired — (Integer)

              The ending port in a port range.

          • protocolrequired — (String)

            The protocol associated with a finding.

            Possible values include:
            • "TCP"
            • "UDP"
        • packageVulnerabilityDetails — (map)

          An object that contains the details of a package vulnerability finding.

          • cvss — (Array<map>)

            An object that contains details about the CVSS score of a finding.

            • baseScorerequired — (Float)

              The base CVSS score used for the finding.

            • scoringVectorrequired — (String)

              The vector string of the CVSS score.

            • sourcerequired — (String)

              The source of the CVSS score.

            • versionrequired — (String)

              The version of CVSS used for the score.

          • referenceUrls — (Array<String>)

            One or more URLs that contain details about this vulnerability type.

          • relatedVulnerabilities — (Array<String>)

            One or more vulnerabilities related to the one identified in this finding.

          • sourcerequired — (String)

            The source of the vulnerability information.

          • sourceUrl — (String)

            A URL to the source of the vulnerability information.

          • vendorCreatedAt — (Date)

            The date and time that this vulnerability was first added to the vendor's database.

          • vendorSeverity — (String)

            The severity the vendor has given to this vulnerability type.

          • vendorUpdatedAt — (Date)

            The date and time the vendor last updated this vulnerability in their database.

          • vulnerabilityIdrequired — (String)

            The ID given to this vulnerability.

          • vulnerablePackages — (Array<map>)

            The packages impacted by this vulnerability.

            • arch — (String)

              The architecture of the vulnerable package.

            • epoch — (Integer)

              The epoch of the vulnerable package.

            • filePath — (String)

              The file path of the vulnerable package.

            • fixedInVersion — (String)

              The version of the package that contains the vulnerability fix.

            • namerequired — (String)

              The name of the vulnerable package.

            • packageManager — (String)

              The package manager of the vulnerable package.

              Possible values include:
              • "BUNDLER"
              • "CARGO"
              • "COMPOSER"
              • "NPM"
              • "NUGET"
              • "PIPENV"
              • "POETRY"
              • "YARN"
              • "GOBINARY"
              • "GOMOD"
              • "JAR"
              • "OS"
              • "PIP"
              • "PYTHONPKG"
              • "NODEPKG"
              • "POM"
            • release — (String)

              The release of the vulnerable package.

            • remediation — (String)

              The code to run in your environment to update packages with a fix available.

            • sourceLambdaLayerArn — (String)

              The Amazon Resource Number (ARN) of the AWS Lambda function affected by a finding.

            • sourceLayerHash — (String)

              The source layer hash of the vulnerable package.

            • versionrequired — (String)

              The version of the vulnerable package.

        • remediationrequired — (map)

          An object that contains the details about how to remediate a finding.

          • recommendation — (map)

            An object that contains information about the recommended course of action to remediate the finding.

            • Url — (String)

              The URL address to the CVE remediation recommendations.

            • text — (String)

              The recommended course of action to remediate the finding.

        • resourcesrequired — (Array<map>)

          Contains information on the resources involved in a finding.

          • details — (map)

            An object that contains details about the resource involved in a finding.

            • awsEc2Instance — (map)

              An object that contains details about the Amazon EC2 instance involved in the finding.

              • iamInstanceProfileArn — (String)

                The IAM instance profile ARN of the Amazon EC2 instance.

              • imageId — (String)

                The image ID of the Amazon EC2 instance.

              • ipV4Addresses — (Array<String>)

                The IPv4 addresses of the Amazon EC2 instance.

              • ipV6Addresses — (Array<String>)

                The IPv6 addresses of the Amazon EC2 instance.

              • keyName — (String)

                The name of the key pair used to launch the Amazon EC2 instance.

              • launchedAt — (Date)

                The date and time the Amazon EC2 instance was launched at.

              • platform — (String)

                The platform of the Amazon EC2 instance.

              • subnetId — (String)

                The subnet ID of the Amazon EC2 instance.

              • type — (String)

                The type of the Amazon EC2 instance.

              • vpcId — (String)

                The VPC ID of the Amazon EC2 instance.

            • awsEcrContainerImage — (map)

              An object that contains details about the Amazon ECR container image involved in the finding.

              • architecture — (String)

                The architecture of the Amazon ECR container image.

              • author — (String)

                The image author of the Amazon ECR container image.

              • imageHashrequired — (String)

                The image hash of the Amazon ECR container image.

              • imageTags — (Array<String>)

                The image tags attached to the Amazon ECR container image.

              • platform — (String)

                The platform of the Amazon ECR container image.

              • pushedAt — (Date)

                The date and time the Amazon ECR container image was pushed.

              • registryrequired — (String)

                The registry for the Amazon ECR container image.

              • repositoryNamerequired — (String)

                The name of the repository the Amazon ECR container image resides in.

            • awsLambdaFunction — (map)

              A summary of the information about an AWS Lambda function affected by a finding.

              • architectures — (Array<String>)

                The instruction set architecture that the AWS Lambda function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

              • codeSha256required — (String)

                The SHA256 hash of the AWS Lambda function's deployment package.

              • executionRoleArnrequired — (String)

                The AWS Lambda function's execution role.

              • functionNamerequired — (String)

                The name of the AWS Lambda function.

              • lastModifiedAt — (Date)

                The date and time that a user last updated the configuration, in ISO 8601 format

              • layers — (Array<String>)

                The AWS Lambda function's layers. A Lambda function can have up to five layers.

              • packageType — (String)

                The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

                Possible values include:
                • "IMAGE"
                • "ZIP"
              • runtimerequired — (String)

                The runtime environment for the AWS Lambda function.

                Possible values include:
                • "NODEJS"
                • "NODEJS_12_X"
                • "NODEJS_14_X"
                • "NODEJS_16_X"
                • "JAVA_8"
                • "JAVA_8_AL2"
                • "JAVA_11"
                • "PYTHON_3_7"
                • "PYTHON_3_8"
                • "PYTHON_3_9"
                • "UNSUPPORTED"
              • versionrequired — (String)

                The version of the AWS Lambda function.

              • vpcConfig — (map)

                The AWS Lambda function's networking configuration.

                • securityGroupIds — (Array<String>)

                  The VPC security groups and subnets that are attached to an AWS Lambda function. For more information, see VPC Settings.

                • subnetIds — (Array<String>)

                  A list of VPC subnet IDs.

                • vpcId — (String)

                  The ID of the VPC.

          • idrequired — (String)

            The ID of the resource.

          • partition — (String)

            The partition of the resource.

          • region — (String)

            The Amazon Web Services Region the impacted resource is located in.

          • tags — (map<String>)

            The tags attached to the resource.

          • typerequired — (String)

            The type of resource.

            Possible values include:
            • "AWS_EC2_INSTANCE"
            • "AWS_ECR_CONTAINER_IMAGE"
            • "AWS_ECR_REPOSITORY"
            • "AWS_LAMBDA_FUNCTION"
        • severityrequired — (String)

          The severity of the finding.

          Possible values include:
          • "INFORMATIONAL"
          • "LOW"
          • "MEDIUM"
          • "HIGH"
          • "CRITICAL"
          • "UNTRIAGED"
        • statusrequired — (String)

          The status of the finding.

          Possible values include:
          • "ACTIVE"
          • "SUPPRESSED"
          • "CLOSED"
        • title — (String)

          The title of the finding.

        • typerequired — (String)

          The type of the finding.

          Possible values include:
          • "NETWORK_REACHABILITY"
          • "PACKAGE_VULNERABILITY"
        • updatedAt — (Date)

          The date and time the finding was last updated at.

      • nextToken — (String)

        A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List members associated with the Amazon Inspector delegated administrator for your organization.

Service Reference:

Examples:

Calling the listMembers operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  onlyAssociated: true || false
};
inspector2.listMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    • onlyAssociated — (Boolean)

      Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • members — (Array<map>)

        An object that contains details for each member account.

        • accountId — (String)

          The Amazon Web Services account ID of the member account.

        • delegatedAdminAccountId — (String)

          The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

        • relationshipStatus — (String)

          The status of the member account.

          Possible values include:
          • "CREATED"
          • "INVITED"
          • "DISABLED"
          • "ENABLED"
          • "REMOVED"
          • "RESIGNED"
          • "DELETED"
          • "EMAIL_VERIFICATION_IN_PROGRESS"
          • "EMAIL_VERIFICATION_FAILED"
          • "REGION_DISABLED"
          • "ACCOUNT_SUSPENDED"
          • "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER"
        • updatedAt — (Date)

          A timestamp showing when the status of this member was last updated.

      • nextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists all tags attached to a given resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
inspector2.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon resource number (ARN) of the resource to list tags of.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags associated with the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the Amazon Inspector usage totals over the last 30 days.

Service Reference:

Examples:

Calling the listUsageTotals operation

var params = {
  accountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
inspector2.listUsageTotals(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountIds — (Array<String>)

      The Amazon Web Services account IDs to retrieve usage totals for.

    • maxResults — (Integer)

      The maximum number of results to return in the response.

    • nextToken — (String)

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

      • totals — (Array<map>)

        An object with details on the total usage for the requested account.

        • accountId — (String)

          The account ID of the account that usage data was retrieved for.

        • usage — (Array<map>)

          An object representing the total usage for an account.

          • currency — (String)

            The currency type used when calculating usage data.

            Possible values include:
            • "USD"
          • estimatedMonthlyCost — (Float)

            The estimated monthly cost of Amazon Inspector.

          • total — (Float)

            The total of usage.

          • type — (String)

            The type scan.

            Possible values include:
            • "EC2_INSTANCE_HOURS"
            • "ECR_INITIAL_SCAN"
            • "ECR_RESCAN"
            • "LAMBDA_FUNCTION_HOURS"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<MapKey>': 'STRING_VALUE',
    /* '<MapKey>': ... */
  }
};
inspector2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to apply a tag to.

    • tags — (map<String>)

      The tags to be added to a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
inspector2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) for the resource to remove tags from.

    • tagKeys — (Array<String>)

      The tag keys to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.

Service Reference:

Examples:

Calling the updateConfiguration operation

var params = {
  ecrConfiguration: { /* required */
    rescanDuration: LIFETIME | DAYS_30 | DAYS_180 /* required */
  }
};
inspector2.updateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ecrConfiguration — (map)

      Specifies how the ECR automated re-scan will be updated for your environment.

      • rescanDurationrequired — (String)

        The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.

        Possible values include:
        • "LIFETIME"
        • "DAYS_30"
        • "DAYS_180"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Specifies the action that is to be applied to the findings that match the filter.

Service Reference:

Examples:

Calling the updateFilter operation

var params = {
  filterArn: 'STRING_VALUE', /* required */
  action: NONE | SUPPRESS,
  description: 'STRING_VALUE',
  filterCriteria: {
    awsAccountId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    componentType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceImageId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceSubnetId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ec2InstanceVpcId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageArchitecture: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageHash: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImagePushedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    ecrImageRegistry: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageRepositoryName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ecrImageTags: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    exploitAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingStatus: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    findingType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    firstObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    fixAvailable: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    inspectorScore: [
      {
        lowerInclusive: 'NUMBER_VALUE',
        upperInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    lambdaFunctionExecutionRoleArn: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionLastModifiedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    lambdaFunctionLayers: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionName: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lambdaFunctionRuntime: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    lastObservedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    networkProtocol: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    portRange: [
      {
        beginInclusive: 'NUMBER_VALUE',
        endInclusive: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    relatedVulnerabilities: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    resourceTags: [
      {
        comparison: EQUALS, /* required */
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceType: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    severity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    title: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    updatedAt: [
      {
        endInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        startInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    vendorSeverity: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilityId: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerabilitySource: [
      {
        comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vulnerablePackages: [
      {
        architecture: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        epoch: {
          lowerInclusive: 'NUMBER_VALUE',
          upperInclusive: 'NUMBER_VALUE'
        },
        name: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        release: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLambdaLayerArn: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        sourceLayerHash: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        },
        version: {
          comparison: EQUALS | PREFIX | NOT_EQUALS, /* required */
          value: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ]
  },
  name: 'STRING_VALUE',
  reason: 'STRING_VALUE'
};
inspector2.updateFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • action — (String)

      Specifies the action that is to be applied to the findings that match the filter.

      Possible values include:
      • "NONE"
      • "SUPPRESS"
    • description — (String)

      A description of the filter.

    • filterArn — (String)

      The Amazon Resource Number (ARN) of the filter to update.

    • filterCriteria — (map)

      Defines the criteria to be update in the filter.

      • awsAccountId — (Array<map>)

        Details of the Amazon Web Services account IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentId — (Array<map>)

        Details of the component IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • componentType — (Array<map>)

        Details of the component types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceImageId — (Array<map>)

        Details of the Amazon EC2 instance image IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceSubnetId — (Array<map>)

        Details of the Amazon EC2 instance subnet IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ec2InstanceVpcId — (Array<map>)

        Details of the Amazon EC2 instance VPC IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageArchitecture — (Array<map>)

        Details of the Amazon ECR image architecture types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageHash — (Array<map>)

        Details of the Amazon ECR image hashes used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImagePushedAt — (Array<map>)

        Details on the Amazon ECR image push date and time used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • ecrImageRegistry — (Array<map>)

        Details on the Amazon ECR registry used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageRepositoryName — (Array<map>)

        Details on the name of the Amazon ECR repository used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • ecrImageTags — (Array<map>)

        The tags attached to the Amazon ECR container image.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • exploitAvailable — (Array<map>)

        Filters the list of AWS Lambda findings by the availability of exploits.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingArn — (Array<map>)

        Details on the finding ARNs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingStatus — (Array<map>)

        Details on the finding status types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • findingType — (Array<map>)

        Details on the finding types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • firstObservedAt — (Array<map>)

        Details on the date and time a finding was first seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • fixAvailable — (Array<map>)

        Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • inspectorScore — (Array<map>)

        The Amazon Inspector score to filter on.

        • lowerInclusive — (Float)

          The lowest number to be included in the filter.

        • upperInclusive — (Float)

          The highest number to be included in the filter.

      • lambdaFunctionExecutionRoleArn — (Array<map>)

        Filters the list of AWS Lambda functions by execution role.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionLastModifiedAt — (Array<map>)

        Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • lambdaFunctionLayers — (Array<map>)

        Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionName — (Array<map>)

        Filters the list of AWS Lambda functions by the name of the function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lambdaFunctionRuntime — (Array<map>)

        Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • lastObservedAt — (Array<map>)

        Details on the date and time a finding was last seen used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • networkProtocol — (Array<map>)

        Details on the ingress source addresses used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • portRange — (Array<map>)

        Details on the port ranges used to filter findings.

        • beginInclusive — (Integer)

          The port number the port range begins at.

        • endInclusive — (Integer)

          The port number the port range ends at.

      • relatedVulnerabilities — (Array<map>)

        Details on the related vulnerabilities used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceId — (Array<map>)

        Details on the resource IDs used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • resourceTags — (Array<map>)

        Details on the resource tags used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
        • keyrequired — (String)

          The tag key used in the filter.

        • value — (String)

          The tag value used in the filter.

      • resourceType — (Array<map>)

        Details on the resource types used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • severity — (Array<map>)

        Details on the severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • title — (Array<map>)

        Details on the finding title used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • updatedAt — (Array<map>)

        Details on the date and time a finding was last updated at used to filter findings.

        • endInclusive — (Date)

          A timestamp representing the end of the time period filtered on.

        • startInclusive — (Date)

          A timestamp representing the start of the time period filtered on.

      • vendorSeverity — (Array<map>)

        Details on the vendor severity used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilityId — (Array<map>)

        Details on the vulnerability ID used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerabilitySource — (Array<map>)

        Details on the vulnerability type used to filter findings.

        • comparisonrequired — (String)

          The operator to use when comparing values in the filter.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
          • "NOT_EQUALS"
        • valuerequired — (String)

          The value to filter on.

      • vulnerablePackages — (Array<map>)

        Details on the vulnerable packages used to filter findings.

        • architecture — (map)

          An object that contains details on the package architecture type to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • epoch — (map)

          An object that contains details on the package epoch to filter on.

          • lowerInclusive — (Float)

            The lowest number to be included in the filter.

          • upperInclusive — (Float)

            The highest number to be included in the filter.

        • name — (map)

          An object that contains details on the name of the package to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • release — (map)

          An object that contains details on the package release to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLambdaLayerArn — (map)

          An object that describes the details of a string filter.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • sourceLayerHash — (map)

          An object that contains details on the source layer hash to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

        • version — (map)

          The package version to filter on.

          • comparisonrequired — (String)

            The operator to use when comparing values in the filter.

            Possible values include:
            • "EQUALS"
            • "PREFIX"
            • "NOT_EQUALS"
          • valuerequired — (String)

            The value to filter on.

    • name — (String)

      The name of the filter.

    • reason — (String)

      The reason the filter was updated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Amazon Resource Number (ARN) of the successfully updated filter.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the configurations for your Amazon Inspector organization.

Service Reference:

Examples:

Calling the updateOrganizationConfiguration operation

var params = {
  autoEnable: { /* required */
    ec2: true || false, /* required */
    ecr: true || false, /* required */
    lambda: true || false
  }
};
inspector2.updateOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • autoEnable — (map)

      Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

      • ec2required — (Boolean)

        Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.

      • ecrrequired — (Boolean)

        Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.

      • lambda — (Boolean)

        Represents whether AWS Lambda scans are automatically enabled for new members of your Amazon Inspector organization.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • autoEnable — (map)

        The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.

        • ec2required — (Boolean)

          Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.

        • ecrrequired — (Boolean)

          Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.

        • lambda — (Boolean)

          Represents whether AWS Lambda scans are automatically enabled for new members of your Amazon Inspector organization.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.