Class: AWS.SecurityHub

Inherits:
AWS.Service show all
Identifier:
securityhub
API Version:
2018-10-26
Defined in:
(unknown)

Overview

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

Service Description

Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on CIS AWS Foundations compliance checks. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide .

When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to. For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invite was sent from.

Sending a Request Using SecurityHub

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

var securityhub = new AWS.SecurityHub({apiVersion: '2018-10-26'});

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

AWS.config.apiVersions = {
  securityhub: '2018-10-26',
  // other service API versions
};

var securityhub = new AWS.SecurityHub();

Version:

  • 2018-10-26

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.SecurityHub(options = {}) ⇒ Object

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

Examples:

Constructing a SecurityHub object

var securityhub = new AWS.SecurityHub({apiVersion: '2018-10-26'});

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)

    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'.

  • 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.SecurityHub.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SecurityHub.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.

  • 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.
  • 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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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'.

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

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

Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

Service Reference:

Examples:

Calling the acceptInvitation operation

var params = {
  InvitationId: 'STRING_VALUE', /* required */
  MasterId: 'STRING_VALUE' /* required */
};
securityhub.acceptInvitation(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: {})
    • MasterId — (String)

      The account ID of the Security Hub master account that sent the invitation.

    • InvitationId — (String)

      The ID of the invitation sent from the Security Hub master account.

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.

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

Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Standards Supported in AWS Security Hub.

Service Reference:

Examples:

Calling the batchDisableStandards operation

var params = {
  StandardsSubscriptionArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.batchDisableStandards(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: {})
    • StandardsSubscriptionArns — (Array<String>)

      The ARNs of the standards subscriptions 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:

      • StandardsSubscriptions — (Array<map>)

        The details of the standards subscriptions that were disabled.

        • StandardsSubscriptionArnrequired — (String)

          The ARN of a resource that represents your subscription to a supported standard.

        • StandardsArnrequired — (String)

          The ARN of a standard.

          In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

        • StandardsInputrequired — (map<String>)

          A key-value pair of input for the standard.

        • StandardsStatusrequired — (String)

          The status of the standards subscription.

          Possible values include:
          • "PENDING"
          • "READY"
          • "FAILED"
          • "DELETING"
          • "INCOMPLETE"

Returns:

  • (AWS.Request)

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

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

Enables the standards specified by the provided standardsArn. In this release, only CIS AWS Foundations standards are supported. For more information, see Standards Supported in AWS Security Hub.

Service Reference:

Examples:

Calling the batchEnableStandards operation

var params = {
  StandardsSubscriptionRequests: [ /* required */
    {
      StandardsArn: 'STRING_VALUE', /* required */
      StandardsInput: {
        '<NonEmptyString>': 'STRING_VALUE',
        /* '<NonEmptyString>': ... */
      }
    },
    /* more items */
  ]
};
securityhub.batchEnableStandards(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: {})
    • StandardsSubscriptionRequests — (Array<map>)

      The list of standards compliance checks to enable.

      In this release, Security Hub supports only the CIS AWS Foundations standard.

      The ARN for the standard is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

      • StandardsArnrequired — (String)

        The ARN of the standard that you want to enable.

        In this release, Security Hub only supports the CIS AWS Foundations standard.

        Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

      • StandardsInput — (map<String>)

        A key-value pair of input for the standard.

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:

      • StandardsSubscriptions — (Array<map>)

        The details of the standards subscriptions that were enabled.

        • StandardsSubscriptionArnrequired — (String)

          The ARN of a resource that represents your subscription to a supported standard.

        • StandardsArnrequired — (String)

          The ARN of a standard.

          In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

        • StandardsInputrequired — (map<String>)

          A key-value pair of input for the standard.

        • StandardsStatusrequired — (String)

          The status of the standards subscription.

          Possible values include:
          • "PENDING"
          • "READY"
          • "FAILED"
          • "DELETING"
          • "INCOMPLETE"

Returns:

  • (AWS.Request)

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

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

Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

Service Reference:

Examples:

Calling the batchImportFindings operation

var params = {
  Findings: [ /* required */
    {
      AwsAccountId: 'STRING_VALUE', /* required */
      CreatedAt: 'STRING_VALUE', /* required */
      Description: 'STRING_VALUE', /* required */
      GeneratorId: 'STRING_VALUE', /* required */
      Id: 'STRING_VALUE', /* required */
      ProductArn: 'STRING_VALUE', /* required */
      Resources: [ /* required */
        {
          Id: 'STRING_VALUE', /* required */
          Type: 'STRING_VALUE', /* required */
          Details: {
            AwsEc2Instance: {
              IamInstanceProfileArn: 'STRING_VALUE',
              ImageId: 'STRING_VALUE',
              IpV4Addresses: [
                'STRING_VALUE',
                /* more items */
              ],
              IpV6Addresses: [
                'STRING_VALUE',
                /* more items */
              ],
              KeyName: 'STRING_VALUE',
              LaunchedAt: 'STRING_VALUE',
              SubnetId: 'STRING_VALUE',
              Type: 'STRING_VALUE',
              VpcId: 'STRING_VALUE'
            },
            AwsIamAccessKey: {
              CreatedAt: 'STRING_VALUE',
              Status: Active | Inactive,
              UserName: 'STRING_VALUE'
            },
            AwsS3Bucket: {
              OwnerId: 'STRING_VALUE',
              OwnerName: 'STRING_VALUE'
            },
            Container: {
              ImageId: 'STRING_VALUE',
              ImageName: 'STRING_VALUE',
              LaunchedAt: 'STRING_VALUE',
              Name: 'STRING_VALUE'
            },
            Other: {
              '<NonEmptyString>': 'STRING_VALUE',
              /* '<NonEmptyString>': ... */
            }
          },
          Partition: aws | aws-cn | aws-us-gov,
          Region: 'STRING_VALUE',
          Tags: {
            '<NonEmptyString>': 'STRING_VALUE',
            /* '<NonEmptyString>': ... */
          }
        },
        /* more items */
      ],
      SchemaVersion: 'STRING_VALUE', /* required */
      Severity: { /* required */
        Normalized: 'NUMBER_VALUE', /* required */
        Product: 'NUMBER_VALUE'
      },
      Title: 'STRING_VALUE', /* required */
      Types: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      UpdatedAt: 'STRING_VALUE', /* required */
      Compliance: {
        Status: PASSED | WARNING | FAILED | NOT_AVAILABLE
      },
      Confidence: 'NUMBER_VALUE',
      Criticality: 'NUMBER_VALUE',
      FirstObservedAt: 'STRING_VALUE',
      LastObservedAt: 'STRING_VALUE',
      Malware: [
        {
          Name: 'STRING_VALUE', /* required */
          Path: 'STRING_VALUE',
          State: OBSERVED | REMOVAL_FAILED | REMOVED,
          Type: ADWARE | BLENDED_THREAT | BOTNET_AGENT | COIN_MINER | EXPLOIT_KIT | KEYLOGGER | MACRO | POTENTIALLY_UNWANTED | SPYWARE | RANSOMWARE | REMOTE_ACCESS | ROOTKIT | TROJAN | VIRUS | WORM
        },
        /* more items */
      ],
      Network: {
        DestinationDomain: 'STRING_VALUE',
        DestinationIpV4: 'STRING_VALUE',
        DestinationIpV6: 'STRING_VALUE',
        DestinationPort: 'NUMBER_VALUE',
        Direction: IN | OUT,
        Protocol: 'STRING_VALUE',
        SourceDomain: 'STRING_VALUE',
        SourceIpV4: 'STRING_VALUE',
        SourceIpV6: 'STRING_VALUE',
        SourceMac: 'STRING_VALUE',
        SourcePort: 'NUMBER_VALUE'
      },
      Note: {
        Text: 'STRING_VALUE', /* required */
        UpdatedAt: 'STRING_VALUE', /* required */
        UpdatedBy: 'STRING_VALUE' /* required */
      },
      Process: {
        LaunchedAt: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        ParentPid: 'NUMBER_VALUE',
        Path: 'STRING_VALUE',
        Pid: 'NUMBER_VALUE',
        TerminatedAt: 'STRING_VALUE'
      },
      ProductFields: {
        '<NonEmptyString>': 'STRING_VALUE',
        /* '<NonEmptyString>': ... */
      },
      RecordState: ACTIVE | ARCHIVED,
      RelatedFindings: [
        {
          Id: 'STRING_VALUE', /* required */
          ProductArn: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      Remediation: {
        Recommendation: {
          Text: 'STRING_VALUE',
          Url: 'STRING_VALUE'
        }
      },
      SourceUrl: 'STRING_VALUE',
      ThreatIntelIndicators: [
        {
          Category: BACKDOOR | CARD_STEALER | COMMAND_AND_CONTROL | DROP_SITE | EXPLOIT_SITE | KEYLOGGER,
          LastObservedAt: 'STRING_VALUE',
          Source: 'STRING_VALUE',
          SourceUrl: 'STRING_VALUE',
          Type: DOMAIN | EMAIL_ADDRESS | HASH_MD5 | HASH_SHA1 | HASH_SHA256 | HASH_SHA512 | IPV4_ADDRESS | IPV6_ADDRESS | MUTEX | PROCESS | URL,
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      UserDefinedFields: {
        '<NonEmptyString>': 'STRING_VALUE',
        /* '<NonEmptyString>': ... */
      },
      VerificationState: UNKNOWN | TRUE_POSITIVE | FALSE_POSITIVE | BENIGN_POSITIVE,
      WorkflowState: NEW | ASSIGNED | IN_PROGRESS | DEFERRED | RESOLVED
    },
    /* more items */
  ]
};
securityhub.batchImportFindings(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: {})
    • Findings — (Array<map>)

      A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format.

      • SchemaVersionrequired — (String)

        The schema version that a finding is formatted for.

      • Idrequired — (String)

        The security findings provider-specific identifier for a finding.

      • ProductArnrequired — (String)

        The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

      • GeneratorIdrequired — (String)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

      • AwsAccountIdrequired — (String)

        The AWS account ID that a finding is generated in.

      • Typesrequired — (Array<String>)

        One or more finding types in the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

      • FirstObservedAt — (String)

        An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

      • LastObservedAt — (String)

        An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

      • CreatedAtrequired — (String)

        An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.

      • UpdatedAtrequired — (String)

        An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

      • Severityrequired — (map)

        A finding's severity.

        • Product — (Float)

          The native severity as defined by the AWS service or integrated partner product that generated the finding.

        • Normalizedrequired — (Integer)

          The normalized severity of a finding.

      • Confidence — (Integer)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

      • Criticality — (Integer)

        The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

      • Titlerequired — (String)

        A finding's title.

        Note: In this release, Title is a required property.
      • Descriptionrequired — (String)

        A finding's description.

        Note: In this release, Description is a required property.
      • Remediation — (map)

        A data type that describes the remediation options for a finding.

        • Recommendation — (map)

          A recommendation on the steps to take to remediate the issue identified by a finding.

          • Text — (String)

            Describes the recommended steps to take to remediate an issue identified in a finding.

          • Url — (String)

            A URL to a page or site that contains information about how to remediate a finding.

      • SourceUrl — (String)

        A URL that links to a page about the current finding in the security-findings provider's solution.

      • ProductFields — (map<String>)

        A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

      • UserDefinedFields — (map<String>)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

      • Malware — (Array<map>)

        A list of malware related to a finding.

        • Namerequired — (String)

          The name of the malware that was observed.

        • Type — (String)

          The type of the malware that was observed.

          Possible values include:
          • "ADWARE"
          • "BLENDED_THREAT"
          • "BOTNET_AGENT"
          • "COIN_MINER"
          • "EXPLOIT_KIT"
          • "KEYLOGGER"
          • "MACRO"
          • "POTENTIALLY_UNWANTED"
          • "SPYWARE"
          • "RANSOMWARE"
          • "REMOTE_ACCESS"
          • "ROOTKIT"
          • "TROJAN"
          • "VIRUS"
          • "WORM"
        • Path — (String)

          The file system path of the malware that was observed.

        • State — (String)

          The state of the malware that was observed.

          Possible values include:
          • "OBSERVED"
          • "REMOVAL_FAILED"
          • "REMOVED"
      • Network — (map)

        The details of network-related information about a finding.

        • Direction — (String)

          The direction of network traffic associated with a finding.

          Possible values include:
          • "IN"
          • "OUT"
        • Protocol — (String)

          The protocol of network-related information about a finding.

        • SourceIpV4 — (String)

          The source IPv4 address of network-related information about a finding.

        • SourceIpV6 — (String)

          The source IPv6 address of network-related information about a finding.

        • SourcePort — (Integer)

          The source port of network-related information about a finding.

        • SourceDomain — (String)

          The source domain of network-related information about a finding.

        • SourceMac — (String)

          The source media access control (MAC) address of network-related information about a finding.

        • DestinationIpV4 — (String)

          The destination IPv4 address of network-related information about a finding.

        • DestinationIpV6 — (String)

          The destination IPv6 address of network-related information about a finding.

        • DestinationPort — (Integer)

          The destination port of network-related information about a finding.

        • DestinationDomain — (String)

          The destination domain of network-related information about a finding.

      • Process — (map)

        The details of process-related information about a finding.

        • Name — (String)

          The name of the process.

        • Path — (String)

          The path to the process executable.

        • Pid — (Integer)

          The process ID.

        • ParentPid — (Integer)

          The parent process ID.

        • LaunchedAt — (String)

          The date/time that the process was launched.

        • TerminatedAt — (String)

          The date and time when the process was terminated.

      • ThreatIntelIndicators — (Array<map>)

        Threat intel details related to a finding.

        • Type — (String)

          The type of a threat intel indicator.

          Possible values include:
          • "DOMAIN"
          • "EMAIL_ADDRESS"
          • "HASH_MD5"
          • "HASH_SHA1"
          • "HASH_SHA256"
          • "HASH_SHA512"
          • "IPV4_ADDRESS"
          • "IPV6_ADDRESS"
          • "MUTEX"
          • "PROCESS"
          • "URL"
        • Value — (String)

          The value of a threat intel indicator.

        • Category — (String)

          The category of a threat intel indicator.

          Possible values include:
          • "BACKDOOR"
          • "CARD_STEALER"
          • "COMMAND_AND_CONTROL"
          • "DROP_SITE"
          • "EXPLOIT_SITE"
          • "KEYLOGGER"
        • LastObservedAt — (String)

          The date and time when the most recent instance of a threat intel indicator was observed.

        • Source — (String)

          The source of the threat intel indicator.

        • SourceUrl — (String)

          The URL to the page or site where you can get more information about the threat intel indicator.

      • Resourcesrequired — (Array<map>)

        A set of resource data types that describe the resources that the finding refers to.

        • Typerequired — (String)

          The type of the resource that details are provided for.

        • Idrequired — (String)

          The canonical identifier for the given resource type.

        • Partition — (String)

          The canonical AWS partition name that the Region is assigned to.

          Possible values include:
          • "aws"
          • "aws-cn"
          • "aws-us-gov"
        • Region — (String)

          The canonical AWS external Region name where this resource is located.

        • Tags — (map<String>)

          A list of AWS tags associated with a resource at the time the finding was processed.

        • Details — (map)

          Additional details about the resource related to a finding.

          • AwsEc2Instance — (map)

            Details about an Amazon EC2 instance related to a finding.

            • Type — (String)

              The instance type of the instance.

            • ImageId — (String)

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

            • IpV4Addresses — (Array<String>)

              The IPv4 addresses associated with the instance.

            • IpV6Addresses — (Array<String>)

              The IPv6 addresses associated with the instance.

            • KeyName — (String)

              The key name associated with the instance.

            • IamInstanceProfileArn — (String)

              The IAM profile ARN of the instance.

            • VpcId — (String)

              The identifier of the VPC that the instance was launched in.

            • SubnetId — (String)

              The identifier of the subnet that the instance was launched in.

            • LaunchedAt — (String)

              The date/time the instance was launched.

          • AwsS3Bucket — (map)

            Details about an Amazon S3 Bucket related to a finding.

            • OwnerId — (String)

              The canonical user ID of the owner of the S3 bucket.

            • OwnerName — (String)

              The display name of the owner of the S3 bucket.

          • AwsIamAccessKey — (map)

            Details about an IAM access key related to a finding.

            • UserName — (String)

              The user associated with the IAM access key related to a finding.

            • Status — (String)

              The status of the IAM access key related to a finding.

              Possible values include:
              • "Active"
              • "Inactive"
            • CreatedAt — (String)

              The creation date/time of the IAM access key related to a finding.

          • Container — (map)

            Details about a container resource related to a finding.

            • Name — (String)

              The name of the container related to a finding.

            • ImageId — (String)

              The identifier of the image related to a finding.

            • ImageName — (String)

              The name of the image related to a finding.

            • LaunchedAt — (String)

              The date and time when the container started.

          • Other — (map<String>)

            Details about a resource that doesn't have a specific type defined.

      • Compliance — (map)

        This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

        • Status — (String)

          The result of a compliance check.

          Possible values include:
          • "PASSED"
          • "WARNING"
          • "FAILED"
          • "NOT_AVAILABLE"
      • VerificationState — (String)

        Indicates the veracity of a finding.

        Possible values include:
        • "UNKNOWN"
        • "TRUE_POSITIVE"
        • "FALSE_POSITIVE"
        • "BENIGN_POSITIVE"
      • WorkflowState — (String)

        The workflow state of a finding.

        Possible values include:
        • "NEW"
        • "ASSIGNED"
        • "IN_PROGRESS"
        • "DEFERRED"
        • "RESOLVED"
      • RecordState — (String)

        The record state of a finding.

        Possible values include:
        • "ACTIVE"
        • "ARCHIVED"
      • RelatedFindings — (Array<map>)

        A list of related findings.

        • ProductArnrequired — (String)

          The ARN of the product that generated a related finding.

        • Idrequired — (String)

          The product-generated identifier for a related finding.

      • Note — (map)

        A user-defined note added to a finding.

        • Textrequired — (String)

          The text of a note.

        • UpdatedByrequired — (String)

          The principal that created a note.

        • UpdatedAtrequired — (String)

          The timestamp of when the note 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:

      • FailedCount — (Integer)

        The number of findings that failed to import.

      • SuccessCount — (Integer)

        The number of findings that were successfully imported.

      • FailedFindings — (Array<map>)

        The list of the findings that failed to import.

        • Idrequired — (String)

          The ID of the error made during the BatchImportFindings operation.

        • ErrorCoderequired — (String)

          The code of the error made during the BatchImportFindings operation.

        • ErrorMessagerequired — (String)

          The message of the error made during the BatchImportFindings operation.

Returns:

  • (AWS.Request)

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

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

Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

Service Reference:

Examples:

Calling the createActionTarget operation

var params = {
  Description: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
securityhub.createActionTarget(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: {})
    • Name — (String)

      The name of the custom action target.

    • Description — (String)

      The description for the custom action target.

    • Id — (String)

      The ID for the custom action target.

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:

      • ActionTargetArn — (String)

        The ARN for the custom action target.

Returns:

  • (AWS.Request)

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

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

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the GroupByAttribute to group the related findings in the insight.

Service Reference:

Examples:

Calling the createInsight operation

var params = {
  Filters: { /* required */
    AwsAccountId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    CompanyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ComplianceStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Confidence: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    CreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    Criticality: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Description: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    FirstObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    GeneratorId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Id: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Keyword: [
      {
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    LastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwarePath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationPort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NetworkDirection: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkProtocol: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceMac: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourcePort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NoteText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedBy: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessParentPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessPath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessTerminatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecommendationText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecordState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIamInstanceProfileArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV4Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV6Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceKeyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceSubnetId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceVpcId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyCreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyUserName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceDetailsOther: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourcePartition: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceRegion: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceTags: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityLabel: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityNormalized: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SeverityProduct: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorCategory: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorLastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSource: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorValue: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Title: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Type: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    UpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    UserDefinedFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    VerificationState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    WorkflowState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  GroupByAttribute: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
securityhub.createInsight(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: {})
    • Name — (String)

      The name of the custom insight to create.

    • Filters — (map)

      One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.

      • ProductArn — (Array<map>)

        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • AwsAccountId — (Array<map>)

        The AWS account ID that a finding is generated in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Id — (Array<map>)

        The security findings provider-specific identifier for a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • GeneratorId — (Array<map>)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Type — (Array<map>)

        A finding type in the format of namespace/category/classifier that classifies a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • FirstObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • LastObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • CreatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • UpdatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • SeverityProduct — (Array<map>)

        The native severity as defined by the security-findings provider's solution that generated the finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityNormalized — (Array<map>)

        The normalized severity of a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityLabel — (Array<map>)

        The label of a finding's severity.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Confidence — (Array<map>)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Criticality — (Array<map>)

        The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Title — (Array<map>)

        A finding's title.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Description — (Array<map>)

        A finding's description.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecommendationText — (Array<map>)

        The recommendation of what to do about the issue described in a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • SourceUrl — (Array<map>)

        A URL that links to a page about the current finding in the security-findings provider's solution.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProductFields — (Array<map>)

        A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ProductName — (Array<map>)

        The name of the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • CompanyName — (Array<map>)

        The name of the findings provider (company) that owns the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • UserDefinedFields — (Array<map>)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • MalwareName — (Array<map>)

        The name of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareType — (Array<map>)

        The type of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwarePath — (Array<map>)

        The filesystem path of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareState — (Array<map>)

        The state of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDirection — (Array<map>)

        Indicates the direction of network traffic associated with a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkProtocol — (Array<map>)

        The protocol of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceIpV4 — (Array<map>)

        The source IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourceIpV6 — (Array<map>)

        The source IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourcePort — (Array<map>)

        The source port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkSourceDomain — (Array<map>)

        The source domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceMac — (Array<map>)

        The source media access control (MAC) address of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDestinationIpV4 — (Array<map>)

        The destination IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationIpV6 — (Array<map>)

        The destination IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationPort — (Array<map>)

        The destination port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkDestinationDomain — (Array<map>)

        The destination domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessName — (Array<map>)

        The name of the process.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPath — (Array<map>)

        The path to the process executable.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPid — (Array<map>)

        The process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessParentPid — (Array<map>)

        The parent process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessLaunchedAt — (Array<map>)

        The date/time that the process was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ProcessTerminatedAt — (Array<map>)

        The date/time that the process was terminated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorType — (Array<map>)

        The type of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorValue — (Array<map>)

        The value of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorCategory — (Array<map>)

        The category of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorLastObservedAt — (Array<map>)

        The date/time of the last observation of a threat intel indicator.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorSource — (Array<map>)

        The source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorSourceUrl — (Array<map>)

        The URL for more details from the source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceType — (Array<map>)

        Specifies the type of the resource that details are provided for.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceId — (Array<map>)

        The canonical identifier for the given resource type.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourcePartition — (Array<map>)

        The canonical AWS partition name that the Region is assigned to.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceRegion — (Array<map>)

        The canonical AWS external Region name where this resource is located.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceTags — (Array<map>)

        A list of AWS tags associated with a resource at the time the finding was processed.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ResourceAwsEc2InstanceType — (Array<map>)

        The instance type of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceImageId — (Array<map>)

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

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIpV4Addresses — (Array<map>)

        The IPv4 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceIpV6Addresses — (Array<map>)

        The IPv6 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceKeyName — (Array<map>)

        The key name associated with the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIamInstanceProfileArn — (Array<map>)

        The IAM profile ARN of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceVpcId — (Array<map>)

        The identifier of the VPC that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceSubnetId — (Array<map>)

        The identifier of the subnet that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceLaunchedAt — (Array<map>)

        The date/time the instance was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceAwsS3BucketOwnerId — (Array<map>)

        The canonical user ID of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsS3BucketOwnerName — (Array<map>)

        The display name of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyUserName — (Array<map>)

        The user associated with the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyStatus — (Array<map>)

        The status of the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyCreatedAt — (Array<map>)

        The creation date/time of the IAM access key related to a finding.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceContainerName — (Array<map>)

        The name of the container related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageId — (Array<map>)

        The identifier of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageName — (Array<map>)

        The name of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerLaunchedAt — (Array<map>)

        The date/time that the container was started.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceDetailsOther — (Array<map>)

        The details of a resource that doesn't have a specific subfield for the resource type defined.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ComplianceStatus — (Array<map>)

        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • VerificationState — (Array<map>)

        The veracity of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • WorkflowState — (Array<map>)

        The workflow state of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecordState — (Array<map>)

        The updated record state for the finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsProductArn — (Array<map>)

        The ARN of the solution that generated a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsId — (Array<map>)

        The solution-generated identifier for a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteText — (Array<map>)

        The text of a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteUpdatedAt — (Array<map>)

        The timestamp of when the note was updated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • NoteUpdatedBy — (Array<map>)

        The principal that created a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Keyword — (Array<map>)

        A keyword for a finding.

        • Value — (String)

          A value for the keyword.

    • GroupByAttribute — (String)

      The attribute used as the aggregator to group related findings for the insight.

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:

      • InsightArn — (String)

        The ARN of the insight created.

Returns:

  • (AWS.Request)

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

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

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. You can use the EnableSecurityHub to enable Security Hub.

After you use CreateMembers to create member account associations in Security Hub, you need to use the InviteMembers action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start being sent to both the member and master accounts.

You can remove the association between the master and member accounts by using the DisassociateFromMasterAccount or DisassociateMembers operation.

Service Reference:

Examples:

Calling the createMembers operation

var params = {
  AccountDetails: [
    {
      AccountId: 'STRING_VALUE',
      Email: 'STRING_VALUE'
    },
    /* more items */
  ]
};
securityhub.createMembers(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: {})
    • AccountDetails — (Array<map>)

      A list of account ID and email address pairs of the accounts to associate with the Security Hub master account.

      • AccountId — (String)

        The ID of an AWS account.

      • Email — (String)

        The email of an AWS account.

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:

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that weren't processed.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Declines invitations to become a member account.

Service Reference:

Examples:

Calling the declineInvitations operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.declineInvitations(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 that specify the accounts that invitations to Security Hub are declined from.

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:

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that weren't processed.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

Service Reference:

Examples:

Calling the deleteActionTarget operation

var params = {
  ActionTargetArn: 'STRING_VALUE' /* required */
};
securityhub.deleteActionTarget(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: {})
    • ActionTargetArn — (String)

      The ARN of the custom action target to delete.

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:

      • ActionTargetArn — (String)

        The ARN of the custom action target that was deleted.

Returns:

  • (AWS.Request)

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

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

Deletes the insight specified by the InsightArn.

Service Reference:

Examples:

Calling the deleteInsight operation

var params = {
  InsightArn: 'STRING_VALUE' /* required */
};
securityhub.deleteInsight(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: {})
    • InsightArn — (String)

      The ARN of the insight to delete.

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:

      • InsightArn — (String)

        The ARN of the insight that was deleted.

Returns:

  • (AWS.Request)

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

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

Deletes invitations received by the AWS account to become a member account.

Service Reference:

Examples:

Calling the deleteInvitations operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.deleteInvitations(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 the account IDs that sent the invitations to delete.

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:

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that invitations weren't deleted for.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Deletes the specified member accounts from Security Hub.

Service Reference:

Examples:

Calling the deleteMembers operation

var params = {
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.deleteMembers(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 of the member accounts to delete.

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:

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that weren't deleted.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Returns a list of the custom action targets in Security Hub in your account.

Service Reference:

Examples:

Calling the describeActionTargets operation

var params = {
  ActionTargetArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
securityhub.describeActionTargets(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: {})
    • ActionTargetArns — (Array<String>)

      A list of custom action target ARNs for the custom action targets to retrieve.

    • NextToken — (String)

      The token that is required for pagination.

    • MaxResults — (Integer)

      The maximum number of results to return.

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:

      • ActionTargets — (Array<map>)

        A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.

        • ActionTargetArnrequired — (String)

          The ARN for the target action.

        • Namerequired — (String)

          The name of the action target.

        • Descriptionrequired — (String)

          The description of the target action.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Service Reference:

Examples:

Calling the describeHub operation

var params = {
  HubArn: 'STRING_VALUE'
};
securityhub.describeHub(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: {})
    • HubArn — (String)

      The ARN of the Hub resource to retrieve.

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:

      • HubArn — (String)

        The ARN of the Hub resource retrieved.

      • SubscribedAt — (String)

        The date and time when Security Hub was enabled in the account.

Returns:

  • (AWS.Request)

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

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

Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.

Service Reference:

Examples:

Calling the describeProducts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
securityhub.describeProducts(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: {})
    • NextToken — (String)

      The token that is required for pagination.

    • MaxResults — (Integer)

      The maximum number of results to return.

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:

      • Products — (Array<map>)

        A list of products, including details for each product.

        • ProductArnrequired — (String)

          The ARN assigned to the product.

        • ProductName — (String)

          The name of the product.

        • CompanyName — (String)

          The name of the company that provides the product.

        • Description — (String)

          A description of the product.

        • Categories — (Array<String>)

          The categories assigned to the product.

        • MarketplaceUrl — (String)

          The URL for the page that contains more information about the product.

        • ActivationUrl — (String)

          The URL used to activate the product.

        • ProductSubscriptionResourcePolicy — (String)

          The resource policy associated with the product.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.

Service Reference:

Examples:

Calling the disableImportFindingsForProduct operation

var params = {
  ProductSubscriptionArn: 'STRING_VALUE' /* required */
};
securityhub.disableImportFindingsForProduct(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: {})
    • ProductSubscriptionArn — (String)

      The ARN of the integrated product to disable the integration 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.

Returns:

  • (AWS.Request)

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

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

Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.

When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.

Service Reference:

Examples:

Calling the disableSecurityHub operation

var params = {
};
securityhub.disableSecurityHub(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.

Returns:

  • (AWS.Request)

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

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

Disassociates the current Security Hub member account from the associated master account.

Service Reference:

Examples:

Calling the disassociateFromMasterAccount operation

var params = {
};
securityhub.disassociateFromMasterAccount(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.

Returns:

  • (AWS.Request)

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

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

Disassociates the specified member accounts from the associated master account.

Service Reference:

Examples:

Calling the disassociateMembers operation

var params = {
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.disassociateMembers(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 of the member accounts to disassociate from the master account.

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.

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

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.

Service Reference:

Examples:

Calling the enableImportFindingsForProduct operation

var params = {
  ProductArn: 'STRING_VALUE' /* required */
};
securityhub.enableImportFindingsForProduct(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: {})
    • ProductArn — (String)

      The ARN of the product to enable the integration 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:

      • ProductSubscriptionArn — (String)

        The ARN of your subscription to the product to enable integrations for.

Returns:

  • (AWS.Request)

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

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

Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie. To learn more, see Setting Up AWS Security Hub.

Service Reference:

Examples:

Calling the enableSecurityHub operation

var params = {
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
securityhub.enableSecurityHub(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: {})
    • Tags — (map<String>)

      The tags to add to the Hub resource when you enable Security Hub.

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.

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

Returns a list of the standards that are currently enabled.

Service Reference:

Examples:

Calling the getEnabledStandards operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StandardsSubscriptionArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.getEnabledStandards(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: {})
    • StandardsSubscriptionArns — (Array<String>)

      A list of the standards subscription ARNs for the standards to retrieve.

    • NextToken — (String)

      Paginates results. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

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:

      • StandardsSubscriptions — (Array<map>)

        A list of StandardsSubscriptions objects that include information about the enabled standards.

        • StandardsSubscriptionArnrequired — (String)

          The ARN of a resource that represents your subscription to a supported standard.

        • StandardsArnrequired — (String)

          The ARN of a standard.

          In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

        • StandardsInputrequired — (map<String>)

          A key-value pair of input for the standard.

        • StandardsStatusrequired — (String)

          The status of the standards subscription.

          Possible values include:
          • "PENDING"
          • "READY"
          • "FAILED"
          • "DELETING"
          • "INCOMPLETE"
      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Returns a list of findings that match the specified criteria.

Service Reference:

Examples:

Calling the getFindings operation

var params = {
  Filters: {
    AwsAccountId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    CompanyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ComplianceStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Confidence: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    CreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    Criticality: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Description: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    FirstObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    GeneratorId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Id: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Keyword: [
      {
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    LastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwarePath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationPort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NetworkDirection: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkProtocol: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceMac: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourcePort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NoteText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedBy: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessParentPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessPath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessTerminatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecommendationText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecordState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIamInstanceProfileArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV4Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV6Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceKeyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceSubnetId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceVpcId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyCreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyUserName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceDetailsOther: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourcePartition: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceRegion: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceTags: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityLabel: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityNormalized: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SeverityProduct: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorCategory: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorLastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSource: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorValue: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Title: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Type: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    UpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    UserDefinedFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    VerificationState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    WorkflowState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Field: 'STRING_VALUE',
      SortOrder: asc | desc
    },
    /* more items */
  ]
};
securityhub.getFindings(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: {})
    • Filters — (map)

      The findings attributes used to define a condition to filter the findings returned.

      • ProductArn — (Array<map>)

        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • AwsAccountId — (Array<map>)

        The AWS account ID that a finding is generated in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Id — (Array<map>)

        The security findings provider-specific identifier for a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • GeneratorId — (Array<map>)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Type — (Array<map>)

        A finding type in the format of namespace/category/classifier that classifies a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • FirstObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • LastObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • CreatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • UpdatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • SeverityProduct — (Array<map>)

        The native severity as defined by the security-findings provider's solution that generated the finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityNormalized — (Array<map>)

        The normalized severity of a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityLabel — (Array<map>)

        The label of a finding's severity.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Confidence — (Array<map>)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Criticality — (Array<map>)

        The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Title — (Array<map>)

        A finding's title.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Description — (Array<map>)

        A finding's description.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecommendationText — (Array<map>)

        The recommendation of what to do about the issue described in a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • SourceUrl — (Array<map>)

        A URL that links to a page about the current finding in the security-findings provider's solution.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProductFields — (Array<map>)

        A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ProductName — (Array<map>)

        The name of the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • CompanyName — (Array<map>)

        The name of the findings provider (company) that owns the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • UserDefinedFields — (Array<map>)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • MalwareName — (Array<map>)

        The name of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareType — (Array<map>)

        The type of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwarePath — (Array<map>)

        The filesystem path of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareState — (Array<map>)

        The state of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDirection — (Array<map>)

        Indicates the direction of network traffic associated with a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkProtocol — (Array<map>)

        The protocol of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceIpV4 — (Array<map>)

        The source IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourceIpV6 — (Array<map>)

        The source IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourcePort — (Array<map>)

        The source port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkSourceDomain — (Array<map>)

        The source domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceMac — (Array<map>)

        The source media access control (MAC) address of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDestinationIpV4 — (Array<map>)

        The destination IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationIpV6 — (Array<map>)

        The destination IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationPort — (Array<map>)

        The destination port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkDestinationDomain — (Array<map>)

        The destination domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessName — (Array<map>)

        The name of the process.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPath — (Array<map>)

        The path to the process executable.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPid — (Array<map>)

        The process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessParentPid — (Array<map>)

        The parent process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessLaunchedAt — (Array<map>)

        The date/time that the process was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ProcessTerminatedAt — (Array<map>)

        The date/time that the process was terminated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorType — (Array<map>)

        The type of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorValue — (Array<map>)

        The value of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorCategory — (Array<map>)

        The category of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorLastObservedAt — (Array<map>)

        The date/time of the last observation of a threat intel indicator.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorSource — (Array<map>)

        The source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorSourceUrl — (Array<map>)

        The URL for more details from the source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceType — (Array<map>)

        Specifies the type of the resource that details are provided for.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceId — (Array<map>)

        The canonical identifier for the given resource type.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourcePartition — (Array<map>)

        The canonical AWS partition name that the Region is assigned to.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceRegion — (Array<map>)

        The canonical AWS external Region name where this resource is located.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceTags — (Array<map>)

        A list of AWS tags associated with a resource at the time the finding was processed.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ResourceAwsEc2InstanceType — (Array<map>)

        The instance type of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceImageId — (Array<map>)

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

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIpV4Addresses — (Array<map>)

        The IPv4 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceIpV6Addresses — (Array<map>)

        The IPv6 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceKeyName — (Array<map>)

        The key name associated with the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIamInstanceProfileArn — (Array<map>)

        The IAM profile ARN of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceVpcId — (Array<map>)

        The identifier of the VPC that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceSubnetId — (Array<map>)

        The identifier of the subnet that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceLaunchedAt — (Array<map>)

        The date/time the instance was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceAwsS3BucketOwnerId — (Array<map>)

        The canonical user ID of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsS3BucketOwnerName — (Array<map>)

        The display name of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyUserName — (Array<map>)

        The user associated with the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyStatus — (Array<map>)

        The status of the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyCreatedAt — (Array<map>)

        The creation date/time of the IAM access key related to a finding.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceContainerName — (Array<map>)

        The name of the container related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageId — (Array<map>)

        The identifier of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageName — (Array<map>)

        The name of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerLaunchedAt — (Array<map>)

        The date/time that the container was started.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceDetailsOther — (Array<map>)

        The details of a resource that doesn't have a specific subfield for the resource type defined.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ComplianceStatus — (Array<map>)

        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • VerificationState — (Array<map>)

        The veracity of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • WorkflowState — (Array<map>)

        The workflow state of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecordState — (Array<map>)

        The updated record state for the finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsProductArn — (Array<map>)

        The ARN of the solution that generated a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsId — (Array<map>)

        The solution-generated identifier for a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteText — (Array<map>)

        The text of a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteUpdatedAt — (Array<map>)

        The timestamp of when the note was updated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • NoteUpdatedBy — (Array<map>)

        The principal that created a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Keyword — (Array<map>)

        A keyword for a finding.

        • Value — (String)

          A value for the keyword.

    • SortCriteria — (Array<map>)

      Findings attributes used to sort the list of findings returned.

      • Field — (String)

        The finding attribute used to sort findings.

      • SortOrder — (String)

        The order used to sort findings.

        Possible values include:
        • "asc"
        • "desc"
    • NextToken — (String)

      Paginates results. On your first call to the GetFindings operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    • MaxResults — (Integer)

      The maximum number of findings to return.

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>)

        The findings that matched the filters specified in the request.

        • SchemaVersionrequired — (String)

          The schema version that a finding is formatted for.

        • Idrequired — (String)

          The security findings provider-specific identifier for a finding.

        • ProductArnrequired — (String)

          The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        • GeneratorIdrequired — (String)

          The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

        • AwsAccountIdrequired — (String)

          The AWS account ID that a finding is generated in.

        • Typesrequired — (Array<String>)

          One or more finding types in the format of namespace/category/classifier that classify a finding.

          Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        • FirstObservedAt — (String)

          An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

        • LastObservedAt — (String)

          An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

        • CreatedAtrequired — (String)

          An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.

        • UpdatedAtrequired — (String)

          An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

        • Severityrequired — (map)

          A finding's severity.

          • Product — (Float)

            The native severity as defined by the AWS service or integrated partner product that generated the finding.

          • Normalizedrequired — (Integer)

            The normalized severity of a finding.

        • Confidence — (Integer)

          A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        • Criticality — (Integer)

          The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        • Titlerequired — (String)

          A finding's title.

          Note: In this release, Title is a required property.
        • Descriptionrequired — (String)

          A finding's description.

          Note: In this release, Description is a required property.
        • Remediation — (map)

          A data type that describes the remediation options for a finding.

          • Recommendation — (map)

            A recommendation on the steps to take to remediate the issue identified by a finding.

            • Text — (String)

              Describes the recommended steps to take to remediate an issue identified in a finding.

            • Url — (String)

              A URL to a page or site that contains information about how to remediate a finding.

        • SourceUrl — (String)

          A URL that links to a page about the current finding in the security-findings provider's solution.

        • ProductFields — (map<String>)

          A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        • UserDefinedFields — (map<String>)

          A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        • Malware — (Array<map>)

          A list of malware related to a finding.

          • Namerequired — (String)

            The name of the malware that was observed.

          • Type — (String)

            The type of the malware that was observed.

            Possible values include:
            • "ADWARE"
            • "BLENDED_THREAT"
            • "BOTNET_AGENT"
            • "COIN_MINER"
            • "EXPLOIT_KIT"
            • "KEYLOGGER"
            • "MACRO"
            • "POTENTIALLY_UNWANTED"
            • "SPYWARE"
            • "RANSOMWARE"
            • "REMOTE_ACCESS"
            • "ROOTKIT"
            • "TROJAN"
            • "VIRUS"
            • "WORM"
          • Path — (String)

            The file system path of the malware that was observed.

          • State — (String)

            The state of the malware that was observed.

            Possible values include:
            • "OBSERVED"
            • "REMOVAL_FAILED"
            • "REMOVED"
        • Network — (map)

          The details of network-related information about a finding.

          • Direction — (String)

            The direction of network traffic associated with a finding.

            Possible values include:
            • "IN"
            • "OUT"
          • Protocol — (String)

            The protocol of network-related information about a finding.

          • SourceIpV4 — (String)

            The source IPv4 address of network-related information about a finding.

          • SourceIpV6 — (String)

            The source IPv6 address of network-related information about a finding.

          • SourcePort — (Integer)

            The source port of network-related information about a finding.

          • SourceDomain — (String)

            The source domain of network-related information about a finding.

          • SourceMac — (String)

            The source media access control (MAC) address of network-related information about a finding.

          • DestinationIpV4 — (String)

            The destination IPv4 address of network-related information about a finding.

          • DestinationIpV6 — (String)

            The destination IPv6 address of network-related information about a finding.

          • DestinationPort — (Integer)

            The destination port of network-related information about a finding.

          • DestinationDomain — (String)

            The destination domain of network-related information about a finding.

        • Process — (map)

          The details of process-related information about a finding.

          • Name — (String)

            The name of the process.

          • Path — (String)

            The path to the process executable.

          • Pid — (Integer)

            The process ID.

          • ParentPid — (Integer)

            The parent process ID.

          • LaunchedAt — (String)

            The date/time that the process was launched.

          • TerminatedAt — (String)

            The date and time when the process was terminated.

        • ThreatIntelIndicators — (Array<map>)

          Threat intel details related to a finding.

          • Type — (String)

            The type of a threat intel indicator.

            Possible values include:
            • "DOMAIN"
            • "EMAIL_ADDRESS"
            • "HASH_MD5"
            • "HASH_SHA1"
            • "HASH_SHA256"
            • "HASH_SHA512"
            • "IPV4_ADDRESS"
            • "IPV6_ADDRESS"
            • "MUTEX"
            • "PROCESS"
            • "URL"
          • Value — (String)

            The value of a threat intel indicator.

          • Category — (String)

            The category of a threat intel indicator.

            Possible values include:
            • "BACKDOOR"
            • "CARD_STEALER"
            • "COMMAND_AND_CONTROL"
            • "DROP_SITE"
            • "EXPLOIT_SITE"
            • "KEYLOGGER"
          • LastObservedAt — (String)

            The date and time when the most recent instance of a threat intel indicator was observed.

          • Source — (String)

            The source of the threat intel indicator.

          • SourceUrl — (String)

            The URL to the page or site where you can get more information about the threat intel indicator.

        • Resourcesrequired — (Array<map>)

          A set of resource data types that describe the resources that the finding refers to.

          • Typerequired — (String)

            The type of the resource that details are provided for.

          • Idrequired — (String)

            The canonical identifier for the given resource type.

          • Partition — (String)

            The canonical AWS partition name that the Region is assigned to.

            Possible values include:
            • "aws"
            • "aws-cn"
            • "aws-us-gov"
          • Region — (String)

            The canonical AWS external Region name where this resource is located.

          • Tags — (map<String>)

            A list of AWS tags associated with a resource at the time the finding was processed.

          • Details — (map)

            Additional details about the resource related to a finding.

            • AwsEc2Instance — (map)

              Details about an Amazon EC2 instance related to a finding.

              • Type — (String)

                The instance type of the instance.

              • ImageId — (String)

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

              • IpV4Addresses — (Array<String>)

                The IPv4 addresses associated with the instance.

              • IpV6Addresses — (Array<String>)

                The IPv6 addresses associated with the instance.

              • KeyName — (String)

                The key name associated with the instance.

              • IamInstanceProfileArn — (String)

                The IAM profile ARN of the instance.

              • VpcId — (String)

                The identifier of the VPC that the instance was launched in.

              • SubnetId — (String)

                The identifier of the subnet that the instance was launched in.

              • LaunchedAt — (String)

                The date/time the instance was launched.

            • AwsS3Bucket — (map)

              Details about an Amazon S3 Bucket related to a finding.

              • OwnerId — (String)

                The canonical user ID of the owner of the S3 bucket.

              • OwnerName — (String)

                The display name of the owner of the S3 bucket.

            • AwsIamAccessKey — (map)

              Details about an IAM access key related to a finding.

              • UserName — (String)

                The user associated with the IAM access key related to a finding.

              • Status — (String)

                The status of the IAM access key related to a finding.

                Possible values include:
                • "Active"
                • "Inactive"
              • CreatedAt — (String)

                The creation date/time of the IAM access key related to a finding.

            • Container — (map)

              Details about a container resource related to a finding.

              • Name — (String)

                The name of the container related to a finding.

              • ImageId — (String)

                The identifier of the image related to a finding.

              • ImageName — (String)

                The name of the image related to a finding.

              • LaunchedAt — (String)

                The date and time when the container started.

            • Other — (map<String>)

              Details about a resource that doesn't have a specific type defined.

        • Compliance — (map)

          This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

          • Status — (String)

            The result of a compliance check.

            Possible values include:
            • "PASSED"
            • "WARNING"
            • "FAILED"
            • "NOT_AVAILABLE"
        • VerificationState — (String)

          Indicates the veracity of a finding.

          Possible values include:
          • "UNKNOWN"
          • "TRUE_POSITIVE"
          • "FALSE_POSITIVE"
          • "BENIGN_POSITIVE"
        • WorkflowState — (String)

          The workflow state of a finding.

          Possible values include:
          • "NEW"
          • "ASSIGNED"
          • "IN_PROGRESS"
          • "DEFERRED"
          • "RESOLVED"
        • RecordState — (String)

          The record state of a finding.

          Possible values include:
          • "ACTIVE"
          • "ARCHIVED"
        • RelatedFindings — (Array<map>)

          A list of related findings.

          • ProductArnrequired — (String)

            The ARN of the product that generated a related finding.

          • Idrequired — (String)

            The product-generated identifier for a related finding.

        • Note — (map)

          A user-defined note added to a finding.

          • Textrequired — (String)

            The text of a note.

          • UpdatedByrequired — (String)

            The principal that created a note.

          • UpdatedAtrequired — (String)

            The timestamp of when the note was updated.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Lists the results of the Security Hub insight that the insight ARN specifies.

Service Reference:

Examples:

Calling the getInsightResults operation

var params = {
  InsightArn: 'STRING_VALUE' /* required */
};
securityhub.getInsightResults(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: {})
    • InsightArn — (String)

      The ARN of the insight whose results you want to see.

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:

      • InsightResults — (map)

        The insight results returned by the operation.

        • InsightArnrequired — (String)

          The ARN of the insight whose results are returned by the GetInsightResults operation.

        • GroupByAttributerequired — (String)

          The attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

        • ResultValuesrequired — (Array<map>)

          The list of insight result values returned by the GetInsightResults operation.

          • GroupByAttributeValuerequired — (String)

            The value of the attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

          • Countrequired — (Integer)

            The number of findings returned for each GroupByAttributeValue.

Returns:

  • (AWS.Request)

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

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

Lists and describes insights that insight ARNs specify.

Service Reference:

Examples:

Calling the getInsights operation

var params = {
  InsightArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
securityhub.getInsights(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: {})
    • InsightArns — (Array<String>)

      The ARNs of the insights that you want to describe.

    • NextToken — (String)

      Paginates results. On your first call to the GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    • MaxResults — (Integer)

      The maximum number of items that you want in the response.

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:

      • Insights — (Array<map>)

        The insights returned by the operation.

        • InsightArnrequired — (String)

          The ARN of a Security Hub insight.

        • Namerequired — (String)

          The name of a Security Hub insight.

        • Filtersrequired — (map)

          One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.

          • ProductArn — (Array<map>)

            The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • AwsAccountId — (Array<map>)

            The AWS account ID that a finding is generated in.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • Id — (Array<map>)

            The security findings provider-specific identifier for a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • GeneratorId — (Array<map>)

            The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • Type — (Array<map>)

            A finding type in the format of namespace/category/classifier that classifies a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • FirstObservedAt — (Array<map>)

            An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • LastObservedAt — (Array<map>)

            An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • CreatedAt — (Array<map>)

            An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • UpdatedAt — (Array<map>)

            An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • SeverityProduct — (Array<map>)

            The native severity as defined by the security-findings provider's solution that generated the finding.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • SeverityNormalized — (Array<map>)

            The normalized severity of a finding.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • SeverityLabel — (Array<map>)

            The label of a finding's severity.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • Confidence — (Array<map>)

            A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • Criticality — (Array<map>)

            The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • Title — (Array<map>)

            A finding's title.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • Description — (Array<map>)

            A finding's description.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • RecommendationText — (Array<map>)

            The recommendation of what to do about the issue described in a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • SourceUrl — (Array<map>)

            A URL that links to a page about the current finding in the security-findings provider's solution.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ProductFields — (Array<map>)

            A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

            • Key — (String)

              The key of the map filter.

            • Value — (String)

              The value for the key in the map filter.

            • Comparison — (String)

              The condition to apply to a key value when querying for findings with a map filter.

              Possible values include:
              • "EQUALS"
          • ProductName — (Array<map>)

            The name of the solution (product) that generates findings.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • CompanyName — (Array<map>)

            The name of the findings provider (company) that owns the solution (product) that generates findings.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • UserDefinedFields — (Array<map>)

            A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

            • Key — (String)

              The key of the map filter.

            • Value — (String)

              The value for the key in the map filter.

            • Comparison — (String)

              The condition to apply to a key value when querying for findings with a map filter.

              Possible values include:
              • "EQUALS"
          • MalwareName — (Array<map>)

            The name of the malware that was observed.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • MalwareType — (Array<map>)

            The type of the malware that was observed.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • MalwarePath — (Array<map>)

            The filesystem path of the malware that was observed.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • MalwareState — (Array<map>)

            The state of the malware that was observed.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NetworkDirection — (Array<map>)

            Indicates the direction of network traffic associated with a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NetworkProtocol — (Array<map>)

            The protocol of network-related information about a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NetworkSourceIpV4 — (Array<map>)

            The source IPv4 address of network-related information about a finding.

            • Cidr — (String)

              A finding's CIDR value.

          • NetworkSourceIpV6 — (Array<map>)

            The source IPv6 address of network-related information about a finding.

            • Cidr — (String)

              A finding's CIDR value.

          • NetworkSourcePort — (Array<map>)

            The source port of network-related information about a finding.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • NetworkSourceDomain — (Array<map>)

            The source domain of network-related information about a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NetworkSourceMac — (Array<map>)

            The source media access control (MAC) address of network-related information about a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NetworkDestinationIpV4 — (Array<map>)

            The destination IPv4 address of network-related information about a finding.

            • Cidr — (String)

              A finding's CIDR value.

          • NetworkDestinationIpV6 — (Array<map>)

            The destination IPv6 address of network-related information about a finding.

            • Cidr — (String)

              A finding's CIDR value.

          • NetworkDestinationPort — (Array<map>)

            The destination port of network-related information about a finding.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • NetworkDestinationDomain — (Array<map>)

            The destination domain of network-related information about a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ProcessName — (Array<map>)

            The name of the process.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ProcessPath — (Array<map>)

            The path to the process executable.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ProcessPid — (Array<map>)

            The process ID.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • ProcessParentPid — (Array<map>)

            The parent process ID.

            • Gte — (Float)

              The greater-than-equal condition to be applied to a single field when querying for findings.

            • Lte — (Float)

              The less-than-equal condition to be applied to a single field when querying for findings.

            • Eq — (Float)

              The equal-to condition to be applied to a single field when querying for findings.

          • ProcessLaunchedAt — (Array<map>)

            The date/time that the process was launched.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ProcessTerminatedAt — (Array<map>)

            The date/time that the process was terminated.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ThreatIntelIndicatorType — (Array<map>)

            The type of a threat intel indicator.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ThreatIntelIndicatorValue — (Array<map>)

            The value of a threat intel indicator.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ThreatIntelIndicatorCategory — (Array<map>)

            The category of a threat intel indicator.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ThreatIntelIndicatorLastObservedAt — (Array<map>)

            The date/time of the last observation of a threat intel indicator.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ThreatIntelIndicatorSource — (Array<map>)

            The source of the threat intel.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ThreatIntelIndicatorSourceUrl — (Array<map>)

            The URL for more details from the source of the threat intel.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceType — (Array<map>)

            Specifies the type of the resource that details are provided for.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceId — (Array<map>)

            The canonical identifier for the given resource type.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourcePartition — (Array<map>)

            The canonical AWS partition name that the Region is assigned to.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceRegion — (Array<map>)

            The canonical AWS external Region name where this resource is located.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceTags — (Array<map>)

            A list of AWS tags associated with a resource at the time the finding was processed.

            • Key — (String)

              The key of the map filter.

            • Value — (String)

              The value for the key in the map filter.

            • Comparison — (String)

              The condition to apply to a key value when querying for findings with a map filter.

              Possible values include:
              • "EQUALS"
          • ResourceAwsEc2InstanceType — (Array<map>)

            The instance type of the instance.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceImageId — (Array<map>)

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

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceIpV4Addresses — (Array<map>)

            The IPv4 addresses associated with the instance.

            • Cidr — (String)

              A finding's CIDR value.

          • ResourceAwsEc2InstanceIpV6Addresses — (Array<map>)

            The IPv6 addresses associated with the instance.

            • Cidr — (String)

              A finding's CIDR value.

          • ResourceAwsEc2InstanceKeyName — (Array<map>)

            The key name associated with the instance.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceIamInstanceProfileArn — (Array<map>)

            The IAM profile ARN of the instance.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceVpcId — (Array<map>)

            The identifier of the VPC that the instance was launched in.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceSubnetId — (Array<map>)

            The identifier of the subnet that the instance was launched in.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsEc2InstanceLaunchedAt — (Array<map>)

            The date/time the instance was launched.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ResourceAwsS3BucketOwnerId — (Array<map>)

            The canonical user ID of the owner of the S3 bucket.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsS3BucketOwnerName — (Array<map>)

            The display name of the owner of the S3 bucket.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsIamAccessKeyUserName — (Array<map>)

            The user associated with the IAM access key related to a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsIamAccessKeyStatus — (Array<map>)

            The status of the IAM access key related to a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceAwsIamAccessKeyCreatedAt — (Array<map>)

            The creation date/time of the IAM access key related to a finding.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ResourceContainerName — (Array<map>)

            The name of the container related to a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceContainerImageId — (Array<map>)

            The identifier of the image related to a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceContainerImageName — (Array<map>)

            The name of the image related to a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • ResourceContainerLaunchedAt — (Array<map>)

            The date/time that the container was started.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • ResourceDetailsOther — (Array<map>)

            The details of a resource that doesn't have a specific subfield for the resource type defined.

            • Key — (String)

              The key of the map filter.

            • Value — (String)

              The value for the key in the map filter.

            • Comparison — (String)

              The condition to apply to a key value when querying for findings with a map filter.

              Possible values include:
              • "EQUALS"
          • ComplianceStatus — (Array<map>)

            Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • VerificationState — (Array<map>)

            The veracity of a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • WorkflowState — (Array<map>)

            The workflow state of a finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • RecordState — (Array<map>)

            The updated record state for the finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • RelatedFindingsProductArn — (Array<map>)

            The ARN of the solution that generated a related finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • RelatedFindingsId — (Array<map>)

            The solution-generated identifier for a related finding.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NoteText — (Array<map>)

            The text of a note.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • NoteUpdatedAt — (Array<map>)

            The timestamp of when the note was updated.

            • Start — (String)

              A start date for the date filter.

            • End — (String)

              An end date for the date filter.

            • DateRange — (map)

              A date range for the date filter.

              • Value — (Integer)

                A date range value for the date filter.

              • Unit — (String)

                A date range unit for the date filter.

                Possible values include:
                • "DAYS"
          • NoteUpdatedBy — (Array<map>)

            The principal that created a note.

            • Value — (String)

              The string filter value.

            • Comparison — (String)

              The condition to be applied to a string value when querying for findings.

              Possible values include:
              • "EQUALS"
              • "PREFIX"
          • Keyword — (Array<map>)

            A keyword for a finding.

            • Value — (String)

              A value for the keyword.

        • GroupByAttributerequired — (String)

          The attribute that the insight's findings are grouped by. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

Service Reference:

Examples:

Calling the getInvitationsCount operation

var params = {
};
securityhub.getInvitationsCount(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:

      • InvitationsCount — (Integer)

        The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.

Returns:

  • (AWS.Request)

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

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

Provides the details for the Security Hub master account to the current member account.

Service Reference:

Examples:

Calling the getMasterAccount operation

var params = {
};
securityhub.getMasterAccount(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:

      • Master — (map)

        A list of details about the Security Hub master account for the current member account.

        • AccountId — (String)

          The account ID of the Security Hub master account that the invitation was sent from.

        • InvitationId — (String)

          The ID of the invitation sent to the member account.

        • InvitedAt — (Date)

          The timestamp of when the invitation was sent.

        • MemberStatus — (String)

          The current status of the association between member and master accounts.

Returns:

  • (AWS.Request)

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

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

Returns the details on the Security Hub member accounts that the account IDs specify.

Service Reference:

Examples:

Calling the getMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.getMembers(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 for the Security Hub member accounts that you want to return the details 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:

      • Members — (Array<map>)

        A list of details about the Security Hub member accounts.

        • AccountId — (String)

          The AWS account ID of the member account.

        • Email — (String)

          The email address of the member account.

        • MasterId — (String)

          The AWS account ID of the Security Hub master account associated with this member account.

        • MemberStatus — (String)

          The status of the relationship between the member account and its master account.

        • InvitedAt — (Date)

          A timestamp for the date and time when the invitation was sent to the member account.

        • UpdatedAt — (Date)

          The timestamp for the date and time when the member account was updated.

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that couldn't be processed.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the CreateMembers action. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from member account.

Service Reference:

Examples:

Calling the inviteMembers operation

var params = {
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.inviteMembers(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 IDs of the AWS accounts that you want to invite to Security Hub as members.

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:

      • UnprocessedAccounts — (Array<map>)

        A list of account ID and email address pairs of the AWS accounts that couldn't be processed.

        • AccountId — (String)

          An AWS account ID of the account that wasn't be processed.

        • ProcessingResult — (String)

          The reason that the account wasn't be processed.

Returns:

  • (AWS.Request)

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

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

Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.

Service Reference:

Examples:

Calling the listEnabledProductsForImport operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
securityhub.listEnabledProductsForImport(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: {})
    • NextToken — (String)

      Paginates results. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

    • MaxResults — (Integer)

      The maximum number of items that you want in the response.

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:

      • ProductSubscriptions — (Array<String>)

        A list of ARNs for the resources that represent your subscriptions to products.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Lists all Security Hub membership invitations that were sent to the current AWS account.

Service Reference:

Examples:

Calling the listInvitations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
securityhub.listInvitations(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 items that you want in the response.

    • NextToken — (String)

      Paginates results. On your first call to the ListInvitations operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

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:

      • Invitations — (Array<map>)

        The details of the invitations returned by the operation.

        • AccountId — (String)

          The account ID of the Security Hub master account that the invitation was sent from.

        • InvitationId — (String)

          The ID of the invitation sent to the member account.

        • InvitedAt — (Date)

          The timestamp of when the invitation was sent.

        • MemberStatus — (String)

          The current status of the association between member and master accounts.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Lists details about all member accounts for the current Security Hub master account.

Service Reference:

Examples:

Calling the listMembers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OnlyAssociated: true || false
};
securityhub.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: {})
    • OnlyAssociated — (Boolean)

      Specifies which member accounts the response includes based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED. If onlyAssociated is set to FALSE, the response includes all existing member accounts.

    • MaxResults — (Integer)

      The maximum number of items that you want in the response.

    • NextToken — (String)

      Paginates results. Set the value of this parameter to NULL on your first call to the ListMembers operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

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>)

        Member details returned by the operation.

        • AccountId — (String)

          The AWS account ID of the member account.

        • Email — (String)

          The email address of the member account.

        • MasterId — (String)

          The AWS account ID of the Security Hub master account associated with this member account.

        • MemberStatus — (String)

          The status of the relationship between the member account and its master account.

        • InvitedAt — (Date)

          A timestamp for the date and time when the invitation was sent to the member account.

        • UpdatedAt — (Date)

          The timestamp for the date and time when the member account was updated.

      • NextToken — (String)

        The token that is required for pagination.

Returns:

  • (AWS.Request)

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

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

Returns a list of tags associated with a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
securityhub.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 ARN of the resource to retrieve tags 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:

      • Tags — (map<String>)

        The tags associated with a resource.

Returns:

  • (AWS.Request)

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

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

Adds one or more tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
securityhub.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 ARN of the resource to apply the tags to.

    • Tags — (map<String>)

      The tags to add to 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.

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

Removes one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securityhub.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 ARN of the resource to remove the tags from.

    • TagKeys — (Array<String>)

      The tag keys associated with the tags 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.

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

Updates the name and description of a custom action target in Security Hub.

Service Reference:

Examples:

Calling the updateActionTarget operation

var params = {
  ActionTargetArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
securityhub.updateActionTarget(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: {})
    • ActionTargetArn — (String)

      The ARN of the custom action target to update.

    • Name — (String)

      The updated name of the custom action target.

    • Description — (String)

      The updated description for the custom action target.

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.

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

Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

Service Reference:

Examples:

Calling the updateFindings operation

var params = {
  Filters: { /* required */
    AwsAccountId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    CompanyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ComplianceStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Confidence: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    CreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    Criticality: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Description: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    FirstObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    GeneratorId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Id: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Keyword: [
      {
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    LastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwarePath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationPort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NetworkDirection: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkProtocol: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceMac: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourcePort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NoteText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedBy: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessParentPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessPath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessTerminatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecommendationText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecordState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIamInstanceProfileArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV4Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV6Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceKeyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceSubnetId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceVpcId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyCreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyUserName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceDetailsOther: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourcePartition: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceRegion: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceTags: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityLabel: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityNormalized: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SeverityProduct: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorCategory: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorLastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSource: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorValue: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Title: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Type: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    UpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    UserDefinedFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    VerificationState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    WorkflowState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Note: {
    Text: 'STRING_VALUE', /* required */
    UpdatedBy: 'STRING_VALUE' /* required */
  },
  RecordState: ACTIVE | ARCHIVED
};
securityhub.updateFindings(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: {})
    • Filters — (map)

      A collection of attributes that specify which findings you want to update.

      • ProductArn — (Array<map>)

        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • AwsAccountId — (Array<map>)

        The AWS account ID that a finding is generated in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Id — (Array<map>)

        The security findings provider-specific identifier for a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • GeneratorId — (Array<map>)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Type — (Array<map>)

        A finding type in the format of namespace/category/classifier that classifies a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • FirstObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • LastObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • CreatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • UpdatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • SeverityProduct — (Array<map>)

        The native severity as defined by the security-findings provider's solution that generated the finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityNormalized — (Array<map>)

        The normalized severity of a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityLabel — (Array<map>)

        The label of a finding's severity.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Confidence — (Array<map>)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Criticality — (Array<map>)

        The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Title — (Array<map>)

        A finding's title.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Description — (Array<map>)

        A finding's description.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecommendationText — (Array<map>)

        The recommendation of what to do about the issue described in a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • SourceUrl — (Array<map>)

        A URL that links to a page about the current finding in the security-findings provider's solution.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProductFields — (Array<map>)

        A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ProductName — (Array<map>)

        The name of the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • CompanyName — (Array<map>)

        The name of the findings provider (company) that owns the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • UserDefinedFields — (Array<map>)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • MalwareName — (Array<map>)

        The name of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareType — (Array<map>)

        The type of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwarePath — (Array<map>)

        The filesystem path of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareState — (Array<map>)

        The state of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDirection — (Array<map>)

        Indicates the direction of network traffic associated with a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkProtocol — (Array<map>)

        The protocol of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceIpV4 — (Array<map>)

        The source IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourceIpV6 — (Array<map>)

        The source IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourcePort — (Array<map>)

        The source port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkSourceDomain — (Array<map>)

        The source domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceMac — (Array<map>)

        The source media access control (MAC) address of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDestinationIpV4 — (Array<map>)

        The destination IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationIpV6 — (Array<map>)

        The destination IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationPort — (Array<map>)

        The destination port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkDestinationDomain — (Array<map>)

        The destination domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessName — (Array<map>)

        The name of the process.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPath — (Array<map>)

        The path to the process executable.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPid — (Array<map>)

        The process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessParentPid — (Array<map>)

        The parent process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessLaunchedAt — (Array<map>)

        The date/time that the process was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ProcessTerminatedAt — (Array<map>)

        The date/time that the process was terminated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorType — (Array<map>)

        The type of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorValue — (Array<map>)

        The value of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorCategory — (Array<map>)

        The category of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorLastObservedAt — (Array<map>)

        The date/time of the last observation of a threat intel indicator.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorSource — (Array<map>)

        The source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorSourceUrl — (Array<map>)

        The URL for more details from the source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceType — (Array<map>)

        Specifies the type of the resource that details are provided for.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceId — (Array<map>)

        The canonical identifier for the given resource type.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourcePartition — (Array<map>)

        The canonical AWS partition name that the Region is assigned to.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceRegion — (Array<map>)

        The canonical AWS external Region name where this resource is located.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceTags — (Array<map>)

        A list of AWS tags associated with a resource at the time the finding was processed.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ResourceAwsEc2InstanceType — (Array<map>)

        The instance type of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceImageId — (Array<map>)

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

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIpV4Addresses — (Array<map>)

        The IPv4 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceIpV6Addresses — (Array<map>)

        The IPv6 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceKeyName — (Array<map>)

        The key name associated with the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIamInstanceProfileArn — (Array<map>)

        The IAM profile ARN of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceVpcId — (Array<map>)

        The identifier of the VPC that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceSubnetId — (Array<map>)

        The identifier of the subnet that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceLaunchedAt — (Array<map>)

        The date/time the instance was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceAwsS3BucketOwnerId — (Array<map>)

        The canonical user ID of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsS3BucketOwnerName — (Array<map>)

        The display name of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyUserName — (Array<map>)

        The user associated with the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyStatus — (Array<map>)

        The status of the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyCreatedAt — (Array<map>)

        The creation date/time of the IAM access key related to a finding.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceContainerName — (Array<map>)

        The name of the container related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageId — (Array<map>)

        The identifier of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageName — (Array<map>)

        The name of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerLaunchedAt — (Array<map>)

        The date/time that the container was started.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceDetailsOther — (Array<map>)

        The details of a resource that doesn't have a specific subfield for the resource type defined.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ComplianceStatus — (Array<map>)

        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • VerificationState — (Array<map>)

        The veracity of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • WorkflowState — (Array<map>)

        The workflow state of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecordState — (Array<map>)

        The updated record state for the finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsProductArn — (Array<map>)

        The ARN of the solution that generated a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsId — (Array<map>)

        The solution-generated identifier for a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteText — (Array<map>)

        The text of a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteUpdatedAt — (Array<map>)

        The timestamp of when the note was updated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • NoteUpdatedBy — (Array<map>)

        The principal that created a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Keyword — (Array<map>)

        A keyword for a finding.

        • Value — (String)

          A value for the keyword.

    • Note — (map)

      The updated note for the finding.

      • Textrequired — (String)

        The updated note text.

      • UpdatedByrequired — (String)

        The principal that updated the note.

    • RecordState — (String)

      The updated record state for the finding.

      Possible values include:
      • "ACTIVE"
      • "ARCHIVED"

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.

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

Updates the Security Hub insight that the insight ARN specifies.

Service Reference:

Examples:

Calling the updateInsight operation

var params = {
  InsightArn: 'STRING_VALUE', /* required */
  Filters: {
    AwsAccountId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    CompanyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ComplianceStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Confidence: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    CreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    Criticality: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Description: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    FirstObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    GeneratorId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Id: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Keyword: [
      {
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    LastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwarePath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    MalwareType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkDestinationPort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NetworkDirection: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkProtocol: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceDomain: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV4: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceIpV6: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourceMac: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NetworkSourcePort: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    NoteText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    NoteUpdatedBy: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessParentPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessPath: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProcessPid: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    ProcessTerminatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ProductName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecommendationText: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RecordState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    RelatedFindingsProductArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIamInstanceProfileArn: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV4Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceIpV6Addresses: [
      {
        Cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceKeyName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceSubnetId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsEc2InstanceVpcId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyCreatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyStatus: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsIamAccessKeyUserName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceAwsS3BucketOwnerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerImageName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerLaunchedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceContainerName: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceDetailsOther: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceId: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourcePartition: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceRegion: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceTags: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityLabel: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SeverityNormalized: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SeverityProduct: [
      {
        Eq: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorCategory: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorLastObservedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSource: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorSourceUrl: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorType: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ThreatIntelIndicatorValue: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Title: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    Type: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    UpdatedAt: [
      {
        DateRange: {
          Unit: DAYS,
          Value: 'NUMBER_VALUE'
        },
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      /* more items */
    ],
    UserDefinedFields: [
      {
        Comparison: EQUALS,
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    VerificationState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    WorkflowState: [
      {
        Comparison: EQUALS | PREFIX,
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  GroupByAttribute: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
securityhub.updateInsight(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: {})
    • InsightArn — (String)

      The ARN of the insight that you want to update.

    • Name — (String)

      The updated name for the insight.

    • Filters — (map)

      The updated filters that define this insight.

      • ProductArn — (Array<map>)

        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • AwsAccountId — (Array<map>)

        The AWS account ID that a finding is generated in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Id — (Array<map>)

        The security findings provider-specific identifier for a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • GeneratorId — (Array<map>)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Type — (Array<map>)

        A finding type in the format of namespace/category/classifier that classifies a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • FirstObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • LastObservedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • CreatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • UpdatedAt — (Array<map>)

        An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • SeverityProduct — (Array<map>)

        The native severity as defined by the security-findings provider's solution that generated the finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityNormalized — (Array<map>)

        The normalized severity of a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • SeverityLabel — (Array<map>)

        The label of a finding's severity.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Confidence — (Array<map>)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Criticality — (Array<map>)

        The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • Title — (Array<map>)

        A finding's title.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Description — (Array<map>)

        A finding's description.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecommendationText — (Array<map>)

        The recommendation of what to do about the issue described in a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • SourceUrl — (Array<map>)

        A URL that links to a page about the current finding in the security-findings provider's solution.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProductFields — (Array<map>)

        A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ProductName — (Array<map>)

        The name of the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • CompanyName — (Array<map>)

        The name of the findings provider (company) that owns the solution (product) that generates findings.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • UserDefinedFields — (Array<map>)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • MalwareName — (Array<map>)

        The name of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareType — (Array<map>)

        The type of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwarePath — (Array<map>)

        The filesystem path of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • MalwareState — (Array<map>)

        The state of the malware that was observed.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDirection — (Array<map>)

        Indicates the direction of network traffic associated with a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkProtocol — (Array<map>)

        The protocol of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceIpV4 — (Array<map>)

        The source IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourceIpV6 — (Array<map>)

        The source IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkSourcePort — (Array<map>)

        The source port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkSourceDomain — (Array<map>)

        The source domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkSourceMac — (Array<map>)

        The source media access control (MAC) address of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NetworkDestinationIpV4 — (Array<map>)

        The destination IPv4 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationIpV6 — (Array<map>)

        The destination IPv6 address of network-related information about a finding.

        • Cidr — (String)

          A finding's CIDR value.

      • NetworkDestinationPort — (Array<map>)

        The destination port of network-related information about a finding.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • NetworkDestinationDomain — (Array<map>)

        The destination domain of network-related information about a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessName — (Array<map>)

        The name of the process.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPath — (Array<map>)

        The path to the process executable.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ProcessPid — (Array<map>)

        The process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessParentPid — (Array<map>)

        The parent process ID.

        • Gte — (Float)

          The greater-than-equal condition to be applied to a single field when querying for findings.

        • Lte — (Float)

          The less-than-equal condition to be applied to a single field when querying for findings.

        • Eq — (Float)

          The equal-to condition to be applied to a single field when querying for findings.

      • ProcessLaunchedAt — (Array<map>)

        The date/time that the process was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ProcessTerminatedAt — (Array<map>)

        The date/time that the process was terminated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorType — (Array<map>)

        The type of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorValue — (Array<map>)

        The value of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorCategory — (Array<map>)

        The category of a threat intel indicator.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorLastObservedAt — (Array<map>)

        The date/time of the last observation of a threat intel indicator.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ThreatIntelIndicatorSource — (Array<map>)

        The source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ThreatIntelIndicatorSourceUrl — (Array<map>)

        The URL for more details from the source of the threat intel.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceType — (Array<map>)

        Specifies the type of the resource that details are provided for.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceId — (Array<map>)

        The canonical identifier for the given resource type.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourcePartition — (Array<map>)

        The canonical AWS partition name that the Region is assigned to.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceRegion — (Array<map>)

        The canonical AWS external Region name where this resource is located.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceTags — (Array<map>)

        A list of AWS tags associated with a resource at the time the finding was processed.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ResourceAwsEc2InstanceType — (Array<map>)

        The instance type of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceImageId — (Array<map>)

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

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIpV4Addresses — (Array<map>)

        The IPv4 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceIpV6Addresses — (Array<map>)

        The IPv6 addresses associated with the instance.

        • Cidr — (String)

          A finding's CIDR value.

      • ResourceAwsEc2InstanceKeyName — (Array<map>)

        The key name associated with the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceIamInstanceProfileArn — (Array<map>)

        The IAM profile ARN of the instance.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceVpcId — (Array<map>)

        The identifier of the VPC that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceSubnetId — (Array<map>)

        The identifier of the subnet that the instance was launched in.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsEc2InstanceLaunchedAt — (Array<map>)

        The date/time the instance was launched.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceAwsS3BucketOwnerId — (Array<map>)

        The canonical user ID of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsS3BucketOwnerName — (Array<map>)

        The display name of the owner of the S3 bucket.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyUserName — (Array<map>)

        The user associated with the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyStatus — (Array<map>)

        The status of the IAM access key related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceAwsIamAccessKeyCreatedAt — (Array<map>)

        The creation date/time of the IAM access key related to a finding.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceContainerName — (Array<map>)

        The name of the container related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageId — (Array<map>)

        The identifier of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerImageName — (Array<map>)

        The name of the image related to a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • ResourceContainerLaunchedAt — (Array<map>)

        The date/time that the container was started.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • ResourceDetailsOther — (Array<map>)

        The details of a resource that doesn't have a specific subfield for the resource type defined.

        • Key — (String)

          The key of the map filter.

        • Value — (String)

          The value for the key in the map filter.

        • Comparison — (String)

          The condition to apply to a key value when querying for findings with a map filter.

          Possible values include:
          • "EQUALS"
      • ComplianceStatus — (Array<map>)

        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • VerificationState — (Array<map>)

        The veracity of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • WorkflowState — (Array<map>)

        The workflow state of a finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RecordState — (Array<map>)

        The updated record state for the finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsProductArn — (Array<map>)

        The ARN of the solution that generated a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • RelatedFindingsId — (Array<map>)

        The solution-generated identifier for a related finding.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteText — (Array<map>)

        The text of a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • NoteUpdatedAt — (Array<map>)

        The timestamp of when the note was updated.

        • Start — (String)

          A start date for the date filter.

        • End — (String)

          An end date for the date filter.

        • DateRange — (map)

          A date range for the date filter.

          • Value — (Integer)

            A date range value for the date filter.

          • Unit — (String)

            A date range unit for the date filter.

            Possible values include:
            • "DAYS"
      • NoteUpdatedBy — (Array<map>)

        The principal that created a note.

        • Value — (String)

          The string filter value.

        • Comparison — (String)

          The condition to be applied to a string value when querying for findings.

          Possible values include:
          • "EQUALS"
          • "PREFIX"
      • Keyword — (Array<map>)

        A keyword for a finding.

        • Value — (String)

          A value for the keyword.

    • GroupByAttribute — (String)

      The updated GroupBy attribute that defines this insight.

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.