Class: AWS.GuardDuty

Inherits:
AWS.Service show all
Identifier:
guardduty
API Version:
2017-11-28
Defined in:
(unknown)

Overview

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

Service Description

Assess, monitor, manage, and remediate security issues across your AWS infrastructure, applications, and data.

Sending a Request Using GuardDuty

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

var guardduty = new AWS.GuardDuty({apiVersion: '2017-11-28'});

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

AWS.config.apiVersions = {
  guardduty: '2017-11-28',
  // other service API versions
};

var guardduty = new AWS.GuardDuty();

Version:

  • 2017-11-28

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

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

Examples:

Constructing a GuardDuty object

var guardduty = new AWS.GuardDuty({apiVersion: '2017-11-28'});

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.GuardDuty.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 returns the amount of time to delay in milliseconds. 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.

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 monitored by a master GuardDuty account.

Service Reference:

Examples:

Calling the acceptInvitation operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  InvitationId: 'STRING_VALUE', /* required */
  MasterId: 'STRING_VALUE' /* required */
};
guardduty.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: {})
    • DetectorId — (String) The unique ID of the detector of the GuardDuty member account.
    • InvitationId — (String) This value is used to validate the master account to the member account.
    • MasterId — (String) The account ID of the master GuardDuty account whose invitation you're accepting.

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.

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

Archives Amazon GuardDuty findings specified by the list of finding IDs.

Service Reference:

Examples:

Calling the archiveFindings operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
guardduty.archiveFindings(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: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings you want to archive.
    • FindingIds — (Array<String>) IDs of the findings that you want to archive.

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.

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

Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational.

Service Reference:

Examples:

Calling the createDetector operation

var params = {
  Enable: true || false, /* required */
  ClientToken: 'STRING_VALUE',
  FindingPublishingFrequency: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS
};
guardduty.createDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientToken — (String) The idempotency token for the create request. If a token is not provided, the SDK will use a version 4 UUID.
    • Enable — (Boolean) A boolean value that specifies whether the detector is to be enabled.
    • FindingPublishingFrequency — (String) A enum value that specifies how frequently customer got Finding updates published. Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"

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:

      • DetectorId — (String) The unique ID of the created detector.

Returns:

  • (AWS.Request)

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

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

Creates a filter using the specified finding criteria.

Service Reference:

Examples:

Calling the createFilter operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingCriteria: { /* required */
    Criterion: {
      '<__string>': {
        Eq: [
          'STRING_VALUE',
          /* more items */
        ],
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  Name: 'STRING_VALUE', /* required */
  Action: NOOP | ARCHIVE,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Rank: 'NUMBER_VALUE'
};
guardduty.createFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Action — (String) Specifies the action that is to be applied to the findings that match the filter. Possible values include:
      • "NOOP"
      • "ARCHIVE"
    • ClientToken — (String) The idempotency token for the create request. If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String) The description of the filter.
    • DetectorId — (String) The unique ID of the detector that you want to update.
    • FindingCriteria — (map) Represents the criteria to be used in the filter for querying findings.
      • Criterion — (map<map>) Represents a map of finding properties that match specified conditions and values when querying findings.
        • Eq — (Array<String>) Represents the equal condition to be applied to a single field when querying for findings.
        • Gt — (Integer) Represents the greater than condition to be applied to a single field when querying for findings.
        • Gte — (Integer) Represents the greater than equal condition to be applied to a single field when querying for findings.
        • Lt — (Integer) Represents the less than condition to be applied to a single field when querying for findings.
        • Lte — (Integer) Represents the less than equal condition to be applied to a single field when querying for findings.
        • Neq — (Array<String>) Represents the not equal condition to be applied to a single field when querying for findings.
    • Name — (String) The name of the filter.
    • Rank — (Integer) Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Name — (String) The name of the successfully created filter.

Returns:

  • (AWS.Request)

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

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

Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications.

Service Reference:

Examples:

Calling the createIPSet operation

var params = {
  Activate: true || false, /* required */
  DetectorId: 'STRING_VALUE', /* required */
  Format: TXT | STIX | OTX_CSV | ALIEN_VAULT | PROOF_POINT | FIRE_EYE, /* required */
  Location: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
guardduty.createIPSet(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: {})
    • Activate — (Boolean) A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
    • ClientToken — (String) The idempotency token for the create request. If a token is not provided, the SDK will use a version 4 UUID.
    • DetectorId — (String) The unique ID of the detector that you want to update.
    • Format — (String) The format of the file that contains the IPSet. Possible values include:
      • "TXT"
      • "STIX"
      • "OTX_CSV"
      • "ALIEN_VAULT"
      • "PROOF_POINT"
      • "FIRE_EYE"
    • Location — (String) The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
    • Name — (String) The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

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:

      • IpSetId — (String) The unique identifier for an IP Set

Returns:

  • (AWS.Request)

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

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

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.

Service Reference:

Examples:

Calling the createMembers operation

var params = {
  AccountDetails: [ /* required */
    {
      AccountId: 'STRING_VALUE', /* required */
      Email: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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 that you want to associate with the master GuardDuty account.
      • AccountIdrequired — (String) Member account ID.
      • Emailrequired — (String) Member account's email address.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.

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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.

Service Reference:

Examples:

Calling the createSampleFindings operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
guardduty.createSampleFindings(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: {})
    • DetectorId — (String) The ID of the detector to create sample findings for.
    • FindingTypes — (Array<String>) Types of sample findings that you want to generate.

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.

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

Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets.

Service Reference:

Examples:

Calling the createThreatIntelSet operation

var params = {
  Activate: true || false, /* required */
  DetectorId: 'STRING_VALUE', /* required */
  Format: TXT | STIX | OTX_CSV | ALIEN_VAULT | PROOF_POINT | FIRE_EYE, /* required */
  Location: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
guardduty.createThreatIntelSet(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: {})
    • Activate — (Boolean) A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
    • ClientToken — (String) The idempotency token for the create request. If a token is not provided, the SDK will use a version 4 UUID.
    • DetectorId — (String) The unique ID of the detector that you want to update.
    • Format — (String) The format of the file that contains the ThreatIntelSet. Possible values include:
      • "TXT"
      • "STIX"
      • "OTX_CSV"
      • "ALIEN_VAULT"
      • "PROOF_POINT"
      • "FIRE_EYE"
    • Location — (String) The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
    • Name — (String) A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.

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:

      • ThreatIntelSetId — (String) The unique identifier for an threat intel set

Returns:

  • (AWS.Request)

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

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

Declines invitations sent to the current member account by AWS account specified by their account IDs.

Service Reference:

Examples:

Calling the declineInvitations operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
guardduty.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 of the AWS accounts that sent invitations to the current member account that you want to decline invitations 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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Deletes a Amazon GuardDuty detector specified by the detector ID.

Service Reference:

Examples:

Calling the deleteDetector operation

var params = {
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.deleteDetector(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: {})
    • DetectorId — (String) The unique ID that specifies the detector that you want 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.

Returns:

  • (AWS.Request)

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

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

Deletes the filter specified by the filter name.

Service Reference:

Examples:

Calling the deleteFilter operation

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

Parameters:

  • params (Object) (defaults to: {})
    • DetectorId — (String) The unique ID that specifies the detector where you want to delete a filter.
    • FilterName — (String) The name of the filter.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

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

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

Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.

Service Reference:

Examples:

Calling the deleteInvitations operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
guardduty.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 account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations 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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Deletes the IPSet specified by the IPSet ID.

Service Reference:

Examples:

Calling the deleteIPSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  IpSetId: 'STRING_VALUE' /* required */
};
guardduty.deleteIPSet(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: {})
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose IPSet you want to delete.
    • IpSetId — (String) The unique ID that specifies the IPSet that you want 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.

Returns:

  • (AWS.Request)

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

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

Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

Service Reference:

Examples:

Calling the deleteMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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 GuardDuty member accounts that you want to delete.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account whose members you want 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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Deletes ThreatIntelSet specified by the ThreatIntelSet ID.

Service Reference:

Examples:

Calling the deleteThreatIntelSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  ThreatIntelSetId: 'STRING_VALUE' /* required */
};
guardduty.deleteThreatIntelSet(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: {})
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to delete.
    • ThreatIntelSetId — (String) The unique ID that specifies the ThreatIntelSet that you want 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.

Returns:

  • (AWS.Request)

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

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

Disassociates the current GuardDuty member account from its master account.

Service Reference:

Examples:

Calling the disassociateFromMasterAccount operation

var params = {
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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: {})
    • DetectorId — (String) The unique ID of the detector of the GuardDuty member 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.

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

Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

Service Reference:

Examples:

Calling the disassociateMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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>) A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.

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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Retrieves an Amazon GuardDuty detector specified by the detectorId.

Service Reference:

Examples:

Calling the getDetector operation

var params = {
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.getDetector(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: {})
    • DetectorId — (String) The unique ID of the detector that you want 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:

      • CreatedAt — (String) The first time a resource was created. The format will be ISO-8601.
      • FindingPublishingFrequency — (String) A enum value that specifies how frequently customer got Finding updates published. Possible values include:
        • "FIFTEEN_MINUTES"
        • "ONE_HOUR"
        • "SIX_HOURS"
      • ServiceRole — (String) Customer serviceRole name or ARN for accessing customer resources
      • Status — (String) The status of detector. Possible values include:
        • "ENABLED"
        • "DISABLED"
      • UpdatedAt — (String) The first time a resource was created. The format will be ISO-8601.

Returns:

  • (AWS.Request)

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

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

Returns the details of the filter specified by the filter name.

Service Reference:

Examples:

Calling the getFilter operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FilterName: 'STRING_VALUE' /* required */
};
guardduty.getFilter(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: {})
    • DetectorId — (String) The detector ID that specifies the GuardDuty service where you want to list the details of the specified filter.
    • FilterName — (String) The name of the filter whose details you want to get.

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:

      • Action — (String) Specifies the action that is to be applied to the findings that match the filter. Possible values include:
        • "NOOP"
        • "ARCHIVE"
      • Description — (String) The description of the filter.
      • FindingCriteria — (map) Represents the criteria to be used in the filter for querying findings.
        • Criterion — (map<map>) Represents a map of finding properties that match specified conditions and values when querying findings.
          • Eq — (Array<String>) Represents the equal condition to be applied to a single field when querying for findings.
          • Gt — (Integer) Represents the greater than condition to be applied to a single field when querying for findings.
          • Gte — (Integer) Represents the greater than equal condition to be applied to a single field when querying for findings.
          • Lt — (Integer) Represents the less than condition to be applied to a single field when querying for findings.
          • Lte — (Integer) Represents the less than equal condition to be applied to a single field when querying for findings.
          • Neq — (Array<String>) Represents the not equal condition to be applied to a single field when querying for findings.
      • Name — (String) The name of the filter.
      • Rank — (Integer) Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Returns:

  • (AWS.Request)

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

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

Describes Amazon GuardDuty findings specified by finding IDs.

Service Reference:

Examples:

Calling the getFindings operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SortCriteria: {
    AttributeName: 'STRING_VALUE',
    OrderBy: ASC | DESC
  }
};
guardduty.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: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.
    • FindingIds — (Array<String>) IDs of the findings that you want to retrieve.
    • SortCriteria — (map) Represents the criteria used for sorting findings.
      • AttributeName — (String) Represents the finding attribute (for example, accountId) by which to sort findings.
      • OrderBy — (String) Order by which the sorted findings are to be displayed. Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Findings — (Array<map>) A list of findings.
        • AccountIdrequired — (String) AWS account ID where the activity occurred that prompted GuardDuty to generate a finding.
        • Arnrequired — (String) The ARN of a finding described by the action.
        • Confidence — (Float) The confidence level of a finding.
        • CreatedAtrequired — (String) The time stamp at which a finding was generated.
        • Description — (String) The description of a finding.
        • Idrequired — (String) The identifier that corresponds to a finding described by the action.
        • Partition — (String) The AWS resource partition.
        • Regionrequired — (String) The AWS region where the activity occurred that prompted GuardDuty to generate a finding.
        • Resourcerequired — (map) The AWS resource associated with the activity that prompted GuardDuty to generate a finding.
          • AccessKeyDetails — (map) The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.
            • AccessKeyId — (String) Access key ID of the user.
            • PrincipalId — (String) The principal ID of the user.
            • UserName — (String) The name of the user.
            • UserType — (String) The type of the user.
          • InstanceDetails — (map) The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.
            • AvailabilityZone — (String) The availability zone of the EC2 instance.
            • IamInstanceProfile — (map) The profile information of the EC2 instance.
              • Arn — (String) AWS EC2 instance profile ARN.
              • Id — (String) AWS EC2 instance profile ID.
            • ImageDescription — (String) The image description of the EC2 instance.
            • ImageId — (String) The image ID of the EC2 instance.
            • InstanceId — (String) The ID of the EC2 instance.
            • InstanceState — (String) The state of the EC2 instance.
            • InstanceType — (String) The type of the EC2 instance.
            • LaunchTime — (String) The launch time of the EC2 instance.
            • NetworkInterfaces — (Array<map>) The network interface information of the EC2 instance.
              • Ipv6Addresses — (Array<String>) A list of EC2 instance IPv6 address information.
              • NetworkInterfaceId — (String) The ID of the network interface
              • PrivateDnsName — (String) Private DNS name of the EC2 instance.
              • PrivateIpAddress — (String) Private IP address of the EC2 instance.
              • PrivateIpAddresses — (Array<map>) Other private IP address information of the EC2 instance.
                • PrivateDnsName — (String) Private DNS name of the EC2 instance.
                • PrivateIpAddress — (String) Private IP address of the EC2 instance.
              • PublicDnsName — (String) Public DNS name of the EC2 instance.
              • PublicIp — (String) Public IP address of the EC2 instance.
              • SecurityGroups — (Array<map>) Security groups associated with the EC2 instance.
                • GroupId — (String) EC2 instance's security group ID.
                • GroupName — (String) EC2 instance's security group name.
              • SubnetId — (String) The subnet ID of the EC2 instance.
              • VpcId — (String) The VPC ID of the EC2 instance.
            • Platform — (String) The platform of the EC2 instance.
            • ProductCodes — (Array<map>) The product code of the EC2 instance.
              • Code — (String) Product code information.
              • ProductType — (String) Product code type.
            • Tags — (Array<map>) The tags of the EC2 instance.
              • Key — (String) EC2 instance tag key.
              • Value — (String) EC2 instance tag value.
          • ResourceType — (String) The type of the AWS resource.
        • SchemaVersionrequired — (String) Findings' schema version.
        • Service — (map) Additional information assigned to the generated finding by GuardDuty.
          • Action — (map) Information about the activity described in a finding.
            • ActionType — (String) GuardDuty Finding activity type.
            • AwsApiCallAction — (map) Information about the AWS_API_CALL action described in this finding.
              • Api — (String) AWS API name.
              • CallerType — (String) AWS API caller type.
              • DomainDetails — (map) Domain information for the AWS API call.
              • RemoteIpDetails — (map) Remote IP information of the connection.
                • City — (map) City information of the remote IP address.
                  • CityName — (String) City name of the remote IP address.
                • Country — (map) Country code of the remote IP address.
                  • CountryCode — (String) Country code of the remote IP address.
                  • CountryName — (String) Country name of the remote IP address.
                • GeoLocation — (map) Location information of the remote IP address.
                  • Lat — (Float) Latitude information of remote IP address.
                  • Lon — (Float) Longitude information of remote IP address.
                • IpAddressV4 — (String) IPV4 remote address of the connection.
                • Organization — (map) ISP Organization information of the remote IP address.
                  • Asn — (String) Autonomous system number of the internet provider of the remote IP address.
                  • AsnOrg — (String) Organization that registered this ASN.
                  • Isp — (String) ISP information for the internet provider.
                  • Org — (String) Name of the internet provider.
              • ServiceName — (String) AWS service name whose API was invoked.
            • DnsRequestAction — (map) Information about the DNS_REQUEST action described in this finding.
              • Domain — (String) Domain information for the DNS request.
            • NetworkConnectionAction — (map) Information about the NETWORK_CONNECTION action described in this finding.
              • Blocked — (Boolean) Network connection blocked information.
              • ConnectionDirection — (String) Network connection direction.
              • LocalPortDetails — (map) Local port information of the connection.
                • Port — (Integer) Port number of the local connection.
                • PortName — (String) Port name of the local connection.
              • Protocol — (String) Network connection protocol.
              • RemoteIpDetails — (map) Remote IP information of the connection.
                • City — (map) City information of the remote IP address.
                  • CityName — (String) City name of the remote IP address.
                • Country — (map) Country code of the remote IP address.
                  • CountryCode — (String) Country code of the remote IP address.
                  • CountryName — (String) Country name of the remote IP address.
                • GeoLocation — (map) Location information of the remote IP address.
                  • Lat — (Float) Latitude information of remote IP address.
                  • Lon — (Float) Longitude information of remote IP address.
                • IpAddressV4 — (String) IPV4 remote address of the connection.
                • Organization — (map) ISP Organization information of the remote IP address.
                  • Asn — (String) Autonomous system number of the internet provider of the remote IP address.
                  • AsnOrg — (String) Organization that registered this ASN.
                  • Isp — (String) ISP information for the internet provider.
                  • Org — (String) Name of the internet provider.
              • RemotePortDetails — (map) Remote port information of the connection.
                • Port — (Integer) Port number of the remote connection.
                • PortName — (String) Port name of the remote connection.
            • PortProbeAction — (map) Information about the PORT_PROBE action described in this finding.
              • Blocked — (Boolean) Port probe blocked information.
              • PortProbeDetails — (Array<map>) A list of port probe details objects.
                • LocalPortDetails — (map) Local port information of the connection.
                  • Port — (Integer) Port number of the local connection.
                  • PortName — (String) Port name of the local connection.
                • RemoteIpDetails — (map) Remote IP information of the connection.
                  • City — (map) City information of the remote IP address.
                    • CityName — (String) City name of the remote IP address.
                  • Country — (map) Country code of the remote IP address.
                    • CountryCode — (String) Country code of the remote IP address.
                    • CountryName — (String) Country name of the remote IP address.
                  • GeoLocation — (map) Location information of the remote IP address.
                    • Lat — (Float) Latitude information of remote IP address.
                    • Lon — (Float) Longitude information of remote IP address.
                  • IpAddressV4 — (String) IPV4 remote address of the connection.
                  • Organization — (map) ISP Organization information of the remote IP address.
                    • Asn — (String) Autonomous system number of the internet provider of the remote IP address.
                    • AsnOrg — (String) Organization that registered this ASN.
                    • Isp — (String) ISP information for the internet provider.
                    • Org — (String) Name of the internet provider.
          • Archived — (Boolean) Indicates whether this finding is archived.
          • Count — (Integer) Total count of the occurrences of this finding type.
          • DetectorId — (String) Detector ID for the GuardDuty service.
          • EventFirstSeen — (String) First seen timestamp of the activity that prompted GuardDuty to generate this finding.
          • EventLastSeen — (String) Last seen timestamp of the activity that prompted GuardDuty to generate this finding.
          • ResourceRole — (String) Resource role information for this finding.
          • ServiceName — (String) The name of the AWS service (GuardDuty) that generated a finding.
          • UserFeedback — (String) Feedback left about the finding.
        • Severityrequired — (Float) The severity of a finding.
        • Title — (String) The title of a finding.
        • Typerequired — (String) The type of a finding described by the action.
        • UpdatedAtrequired — (String) The time stamp at which a finding was last updated.

Returns:

  • (AWS.Request)

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

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

Lists Amazon GuardDuty findings' statistics for the specified detector ID.

Service Reference:

Examples:

Calling the getFindingsStatistics operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingStatisticTypes: [ /* required */
    COUNT_BY_SEVERITY,
    /* more items */
  ],
  FindingCriteria: {
    Criterion: {
      '<__string>': {
        Eq: [
          'STRING_VALUE',
          /* more items */
        ],
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  }
};
guardduty.getFindingsStatistics(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: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
    • FindingCriteria — (map) Represents the criteria used for querying findings.
      • Criterion — (map<map>) Represents a map of finding properties that match specified conditions and values when querying findings.
        • Eq — (Array<String>) Represents the equal condition to be applied to a single field when querying for findings.
        • Gt — (Integer) Represents the greater than condition to be applied to a single field when querying for findings.
        • Gte — (Integer) Represents the greater than equal condition to be applied to a single field when querying for findings.
        • Lt — (Integer) Represents the less than condition to be applied to a single field when querying for findings.
        • Lte — (Integer) Represents the less than equal condition to be applied to a single field when querying for findings.
        • Neq — (Array<String>) Represents the not equal condition to be applied to a single field when querying for findings.
    • FindingStatisticTypes — (Array<String>) Types of finding statistics 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:

      • FindingStatistics — (map) Finding statistics object.
        • CountBySeverity — (map<Integer>) Represents a map of severity to count statistic for a set of findings

Returns:

  • (AWS.Request)

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

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

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

Service Reference:

Examples:

Calling the getInvitationsCount operation

var params = {
};
guardduty.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 received invitations.

Returns:

  • (AWS.Request)

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

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

Retrieves the IPSet specified by the IPSet ID.

Service Reference:

Examples:

Calling the getIPSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  IpSetId: 'STRING_VALUE' /* required */
};
guardduty.getIPSet(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: {})
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose IPSet you want to retrieve.
    • IpSetId — (String) The unique ID that specifies the IPSet that you want to describe.

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:

      • Format — (String) The format of the file that contains the IPSet. Possible values include:
        • "TXT"
        • "STIX"
        • "OTX_CSV"
        • "ALIEN_VAULT"
        • "PROOF_POINT"
        • "FIRE_EYE"
      • Location — (String) The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
      • Name — (String) The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.
      • Status — (String) The status of ipSet file uploaded. Possible values include:
        • "INACTIVE"
        • "ACTIVATING"
        • "ACTIVE"
        • "DEACTIVATING"
        • "ERROR"
        • "DELETE_PENDING"
        • "DELETED"

Returns:

  • (AWS.Request)

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

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

Provides the details for the GuardDuty master account to the current GuardDuty member account.

Service Reference:

Examples:

Calling the getMasterAccount operation

var params = {
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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: {})
    • DetectorId — (String) The unique ID of the detector of the GuardDuty member 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:

      • Master — (map) Contains details about the master account.
        • AccountId — (String) Master account ID
        • InvitationId — (String) This value is used to validate the master account to the member account.
        • InvitedAt — (String) Timestamp at which the invitation was sent
        • RelationshipStatus — (String) The status of the relationship between the master and member accounts.

Returns:

  • (AWS.Request)

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

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

Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

Service Reference:

Examples:

Calling the getMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.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 of the GuardDuty member accounts that you want to describe.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account whose members you want 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:

      • Members — (Array<map>) A list of member descriptions.
        • AccountIdrequired — (String) AWS account ID.
        • DetectorId — (String) The unique identifier for a detector.
        • Emailrequired — (String) Member account's email address.
        • InvitedAt — (String) Timestamp at which the invitation was sent
        • MasterIdrequired — (String) The master account ID.
        • RelationshipStatusrequired — (String) The status of the relationship between the member and the master.
        • UpdatedAtrequired — (String) The first time a resource was created. The format will be ISO-8601.
      • UnprocessedAccounts — (Array<map>) A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

Service Reference:

Examples:

Calling the getThreatIntelSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  ThreatIntelSetId: 'STRING_VALUE' /* required */
};
guardduty.getThreatIntelSet(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: {})
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to describe.
    • ThreatIntelSetId — (String) The unique ID that specifies the ThreatIntelSet that you want to describe.

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:

      • Format — (String) The format of the threatIntelSet. Possible values include:
        • "TXT"
        • "STIX"
        • "OTX_CSV"
        • "ALIEN_VAULT"
        • "PROOF_POINT"
        • "FIRE_EYE"
      • Location — (String) The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
      • Name — (String) A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.
      • Status — (String) The status of threatIntelSet file uploaded. Possible values include:
        • "INACTIVE"
        • "ACTIVATING"
        • "ACTIVE"
        • "DEACTIVATING"
        • "ERROR"
        • "DELETE_PENDING"
        • "DELETED"

Returns:

  • (AWS.Request)

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

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

Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.

Service Reference:

Examples:

Calling the inviteMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE', /* required */
  DisableEmailNotification: true || false,
  Message: 'STRING_VALUE'
};
guardduty.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 account IDs of the accounts that you want to invite to GuardDuty as members.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account with which you want to invite members.
    • DisableEmailNotification — (Boolean) A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.
    • Message — (String) The invitation message that you want to send to the accounts that you’re inviting to GuardDuty 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 objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Service Reference:

Examples:

Calling the listDetectors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
guardduty.listDetectors(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) You can use this parameter to indicate the maximum number of detectors that you want in the response.
    • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListDetectors action. For subsequent calls to the action 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:

      • DetectorIds — (Array<String>) A list of detector Ids.
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (AWS.Request)

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

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

Returns a paginated list of the current filters.

Service Reference:

Examples:

Calling the listFilters operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
guardduty.listFilters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service where you want to list filters.
    • MaxResults — (Integer) Indicates the maximum number of items that you want in the response. The maximum value is 50.
    • NextToken — (String) Paginates results. Set the value of this parameter to NULL on your first call to the ListFilters 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:

      • FilterNames — (Array<String>) A list of filter names
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (AWS.Request)

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

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

Lists Amazon GuardDuty findings for the specified detector ID.

Service Reference:

Examples:

Calling the listFindings operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingCriteria: {
    Criterion: {
      '<__string>': {
        Eq: [
          'STRING_VALUE',
          /* more items */
        ],
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: {
    AttributeName: 'STRING_VALUE',
    OrderBy: ASC | DESC
  }
};
guardduty.listFindings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings you want to list.
    • FindingCriteria — (map) Represents the criteria used for querying findings.
      • Criterion — (map<map>) Represents a map of finding properties that match specified conditions and values when querying findings.
        • Eq — (Array<String>) Represents the equal condition to be applied to a single field when querying for findings.
        • Gt — (Integer) Represents the greater than condition to be applied to a single field when querying for findings.
        • Gte — (Integer) Represents the greater than equal condition to be applied to a single field when querying for findings.
        • Lt — (Integer) Represents the less than condition to be applied to a single field when querying for findings.
        • Lte — (Integer) Represents the less than equal condition to be applied to a single field when querying for findings.
        • Neq — (Array<String>) Represents the not equal condition to be applied to a single field when querying for findings.
    • MaxResults — (Integer) You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
    • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. For subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
    • SortCriteria — (map) Represents the criteria used for sorting findings.
      • AttributeName — (String) Represents the finding attribute (for example, accountId) by which to sort findings.
      • OrderBy — (String) Order by which the sorted findings are to be displayed. Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • FindingIds — (Array<String>) The list of the Findings.
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (AWS.Request)

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

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

Lists all GuardDuty 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'
};
guardduty.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) You can use this parameter to indicate the maximum number of invitations you want in the response. The default value is 50. The maximum value is 50.
    • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListInvitations action. Subsequent calls to the action 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>) A list of invitation descriptions.
        • AccountId — (String) Inviter account ID
        • InvitationId — (String) This value is used to validate the inviter account to the member account.
        • InvitedAt — (String) Timestamp at which the invitation was sent
        • RelationshipStatus — (String) The status of the relationship between the inviter and invitee accounts.
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (AWS.Request)

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

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

Lists the IPSets of the GuardDuty service specified by the detector ID.

Service Reference:

Examples:

Calling the listIPSets operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
guardduty.listIPSets(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: {})
    • DetectorId — (String) The unique ID of the detector that you want to retrieve.
    • MaxResults — (Integer) You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 7. The maximum value is 7.
    • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListIPSet action. For subsequent calls to the action 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:

      • IpSetIds — (Array<String>) A list of the IP set IDs
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

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 GuardDuty master account.

Service Reference:

Examples:

Calling the listMembers operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OnlyAssociated: 'STRING_VALUE'
};
guardduty.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: {})
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account whose members you want to list.
    • MaxResults — (Integer) You can use this parameter to indicate the maximum number of items you want in the response. The default value is 1. The maximum value is 50.
    • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
    • OnlyAssociated — (String) Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts.

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 member descriptions.
        • AccountIdrequired — (String) AWS account ID.
        • DetectorId — (String) The unique identifier for a detector.
        • Emailrequired — (String) Member account's email address.
        • InvitedAt — (String) Timestamp at which the invitation was sent
        • MasterIdrequired — (String) The master account ID.
        • RelationshipStatusrequired — (String) The status of the relationship between the member and the master.
        • UpdatedAtrequired — (String) The first time a resource was created. The format will be ISO-8601.
      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (AWS.Request)

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

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

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.

Service Reference:

Examples:

Calling the listThreatIntelSets operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
guardduty.listThreatIntelSets(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: {})
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose ThreatIntelSets you want to list.
    • MaxResults — (Integer) You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 7. The maximum value is 7.
    • NextToken — (String) Pagination token to start retrieving threat intel sets 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:

      • NextToken — (String) You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
      • ThreatIntelSetIds — (Array<String>) The list of the threat intel set IDs

Returns:

  • (AWS.Request)

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

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

Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers.

Service Reference:

Examples:

Calling the startMonitoringMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.startMonitoringMembers(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 GuardDuty member accounts whose findings you want the master account to monitor.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account whom you want to re-enable to monitor members' findings.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • UnprocessedAccounts — (Array<map>) A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members’ findings.

Service Reference:

Examples:

Calling the stopMonitoringMembers operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.stopMonitoringMembers(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 GuardDuty member accounts whose findings you want the master account to stop monitoring.
    • DetectorId — (String) The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • UnprocessedAccounts — (Array<map>) A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
        • AccountIdrequired — (String) AWS Account ID.
        • Resultrequired — (String) A reason why the account hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Unarchives Amazon GuardDuty findings specified by the list of finding IDs.

Service Reference:

Examples:

Calling the unarchiveFindings operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FindingIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
guardduty.unarchiveFindings(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: {})
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings you want to unarchive.
    • FindingIds — (Array<String>) IDs of the findings that you want to unarchive.

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.

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

Updates an Amazon GuardDuty detector specified by the detectorId.

Service Reference:

Examples:

Calling the updateDetector operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  Enable: true || false,
  FindingPublishingFrequency: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS
};
guardduty.updateDetector(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: {})
    • DetectorId — (String) The unique ID of the detector that you want to update.
    • Enable — (Boolean) Updated boolean value for the detector that specifies whether the detector is enabled.
    • FindingPublishingFrequency — (String) A enum value that specifies how frequently customer got Finding updates published. Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

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

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

Updates the filter specified by the filter name.

Service Reference:

Examples:

Calling the updateFilter operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  FilterName: 'STRING_VALUE', /* required */
  Action: NOOP | ARCHIVE,
  Description: 'STRING_VALUE',
  FindingCriteria: {
    Criterion: {
      '<__string>': {
        Eq: [
          'STRING_VALUE',
          /* more items */
        ],
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  Rank: 'NUMBER_VALUE'
};
guardduty.updateFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Action — (String) Specifies the action that is to be applied to the findings that match the filter. Possible values include:
      • "NOOP"
      • "ARCHIVE"
    • Description — (String) The description of the filter.
    • DetectorId — (String) The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
    • FilterName — (String) The name of the filter.
    • FindingCriteria — (map) Represents the criteria to be used in the filter for querying findings.
      • Criterion — (map<map>) Represents a map of finding properties that match specified conditions and values when querying findings.
        • Eq — (Array<String>) Represents the equal condition to be applied to a single field when querying for findings.
        • Gt — (Integer) Represents the greater than condition to be applied to a single field when querying for findings.
        • Gte — (Integer) Represents the greater than equal condition to be applied to a single field when querying for findings.
        • Lt — (Integer) Represents the less than condition to be applied to a single field when querying for findings.
        • Lte — (Integer) Represents the less than equal condition to be applied to a single field when querying for findings.
        • Neq — (Array<String>) Represents the not equal condition to be applied to a single field when querying for findings.
    • Rank — (Integer) Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Name — (String) The name of the filter.

Returns:

  • (AWS.Request)

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

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

Marks specified Amazon GuardDuty findings as useful or not useful.

Service Reference:

Examples:

Calling the updateFindingsFeedback operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  Feedback: USEFUL | NOT_USEFUL, /* required */
  FindingIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Comments: 'STRING_VALUE'
};
guardduty.updateFindingsFeedback(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: {})
    • Comments — (String) Additional feedback about the GuardDuty findings.
    • DetectorId — (String) The ID of the detector that specifies the GuardDuty service whose findings you want to mark as useful or not useful.
    • Feedback — (String) Valid values: USEFUL | NOT_USEFUL Possible values include:
      • "USEFUL"
      • "NOT_USEFUL"
    • FindingIds — (Array<String>) IDs of the findings that you want to mark as useful or not useful.

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.

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

Updates the IPSet specified by the IPSet ID.

Service Reference:

Examples:

Calling the updateIPSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  IpSetId: 'STRING_VALUE', /* required */
  Activate: true || false,
  Location: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
guardduty.updateIPSet(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: {})
    • Activate — (Boolean) The updated boolean value that specifies whether the IPSet is active or not.
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose IPSet you want to update.
    • IpSetId — (String) The unique ID that specifies the IPSet that you want to update.
    • Location — (String) The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
    • Name — (String) The unique ID that specifies the IPSet that you want to update.

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.

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

Updates the ThreatIntelSet specified by ThreatIntelSet ID.

Service Reference:

Examples:

Calling the updateThreatIntelSet operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  ThreatIntelSetId: 'STRING_VALUE', /* required */
  Activate: true || false,
  Location: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
guardduty.updateThreatIntelSet(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: {})
    • Activate — (Boolean) The updated boolean value that specifies whether the ThreateIntelSet is active or not.
    • DetectorId — (String) The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.
    • Location — (String) The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
    • Name — (String) The unique ID that specifies the ThreatIntelSet that you want to update.
    • ThreatIntelSetId — (String) The unique ID that specifies the ThreatIntelSet that you want to update.

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.