AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin.

GuardDuty also monitors AWS account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.

GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see the Amazon GuardDuty User Guide .

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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

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.

    • MasterId — (String)

      The account ID of the master GuardDuty account whose invitation you're accepting.

    • InvitationId — (String)

      The value that is used to validate the master account to the 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.

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

Archives GuardDuty findings that are specified by the list of finding IDs.

Note: Only the master account can archive findings. Member accounts don't have permission to archive findings from their accounts.

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

      The 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 a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.

Service Reference:

Examples:

Calling the createDetector operation

var params = {
  Enable: true || false, /* required */
  ClientToken: 'STRING_VALUE',
  DataSources: {
    S3Logs: {
      Enable: true || false /* required */
    }
  },
  FindingPublishingFrequency: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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: {})
    • Enable — (Boolean)

      A Boolean value that specifies whether the detector is to be enabled.

    • ClientToken — (String)

      The idempotency token for the create request.

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

      An enum value that specifies how frequently updated findings are exported.

      Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • DataSources — (map)

      An object that describes which data sources will be enabled for the detector.

      • S3Logs — (map)

        Describes whether S3 data event logs are enabled as a data source.

        • Enablerequired — (Boolean)

          The status of S3 data event logs as a data source.

    • Tags — (map<String>)

      The tags to be added to a new detector resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. 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 */
        ],
        Equals: [
          'STRING_VALUE',
          /* more items */
        ],
        GreaterThan: 'NUMBER_VALUE',
        GreaterThanOrEqual: 'NUMBER_VALUE',
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        LessThan: 'NUMBER_VALUE',
        LessThanOrEqual: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ],
        NotEquals: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<String>': ... */
    }
  },
  Name: 'STRING_VALUE', /* required */
  Action: NOOP | ARCHIVE,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Rank: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account that you want to create a filter for.

    • Name — (String)

      The name of the filter.

    • Description — (String)

      The description of the filter.

    • Action — (String)

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

      Possible values include:
      • "NOOP"
      • "ARCHIVE"
    • 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.

    • FindingCriteria — (map)

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

      You can only use the following attributes to query findings:

      • accountId

      • region

      • confidence

      • id

      • resource.accessKeyDetails.accessKeyId

      • resource.accessKeyDetails.principalId

      • resource.accessKeyDetails.userName

      • resource.accessKeyDetails.userType

      • resource.instanceDetails.iamInstanceProfile.id

      • resource.instanceDetails.imageId

      • resource.instanceDetails.instanceId

      • resource.instanceDetails.outpostArn

      • resource.instanceDetails.networkInterfaces.ipv6Addresses

      • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

      • resource.instanceDetails.networkInterfaces.publicDnsName

      • resource.instanceDetails.networkInterfaces.publicIp

      • resource.instanceDetails.networkInterfaces.securityGroups.groupId

      • resource.instanceDetails.networkInterfaces.securityGroups.groupName

      • resource.instanceDetails.networkInterfaces.subnetId

      • resource.instanceDetails.networkInterfaces.vpcId

      • resource.instanceDetails.tags.key

      • resource.instanceDetails.tags.value

      • resource.resourceType

      • service.action.actionType

      • service.action.awsApiCallAction.api

      • service.action.awsApiCallAction.callerType

      • service.action.awsApiCallAction.remoteIpDetails.city.cityName

      • service.action.awsApiCallAction.remoteIpDetails.country.countryName

      • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

      • service.action.awsApiCallAction.remoteIpDetails.organization.asn

      • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

      • service.action.awsApiCallAction.serviceName

      • service.action.dnsRequestAction.domain

      • service.action.networkConnectionAction.blocked

      • service.action.networkConnectionAction.connectionDirection

      • service.action.networkConnectionAction.localPortDetails.port

      • service.action.networkConnectionAction.protocol

      • service.action.networkConnectionAction.localIpDetails.ipAddressV4

      • service.action.networkConnectionAction.remoteIpDetails.city.cityName

      • service.action.networkConnectionAction.remoteIpDetails.country.countryName

      • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

      • service.action.networkConnectionAction.remoteIpDetails.organization.asn

      • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

      • service.action.networkConnectionAction.remotePortDetails.port

      • service.additionalInfo.threatListName

      • service.archived

        When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.

      • service.resourceRole

      • severity

      • type

      • updatedAt

        Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.

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

        • Neq — (Array<String>)

          Represents the not equal condition to be applied to a single field when querying for findings.

        • Gt — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • Gte — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • Lt — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • Lte — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

        • Equals — (Array<String>)

          Represents an equal condition to be applied to a single field when querying for findings.

        • NotEquals — (Array<String>)

          Represents a not equal condition to be applied to a single field when querying for findings.

        • GreaterThan — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • GreaterThanOrEqual — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • LessThan — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • LessThanOrEqual — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

    • ClientToken — (String)

      The idempotency token for the create request.

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

      The tags to be added to a new filter resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. 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, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the master account can use this operation.

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',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

    • Name — (String)

      The user-friendly name to identify the IPSet.

      Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

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

    • 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.
    • Tags — (map<String>)

      The tags to be added to a new IP set resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • IpSetId — (String)

        The ID of the IPSet resource.

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. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.

When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization master account, which must enable GuardDuty prior to being added as a member.

If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using Invite Members .

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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

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

        The member account ID.

      • Emailrequired — (String)

        The email address of the 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:

      • UnprocessedAccounts — (Array<map>)

        A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

        • AccountIdrequired — (String)

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

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

Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.

Service Reference:

Examples:

Calling the createPublishingDestination operation

var params = {
  DestinationProperties: { /* required */
    DestinationArn: 'STRING_VALUE',
    KmsKeyArn: 'STRING_VALUE'
  },
  DestinationType: S3, /* required */
  DetectorId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
guardduty.createPublishingDestination(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 GuardDuty detector associated with the publishing destination.

    • DestinationType — (String)

      The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

      Possible values include:
      • "S3"
    • DestinationProperties — (map)

      The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

      • DestinationArn — (String)

        The ARN of the resource to publish to.

      • KmsKeyArn — (String)

        The ARN of the KMS key to use for encryption.

    • ClientToken — (String)

      The idempotency token for the request.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • DestinationId — (String)

        The ID of the publishing destination that is created.

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

      The types of sample findings 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

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.

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',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.

    • Name — (String)

      A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

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

    • 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.
    • Tags — (map<String>)

      The tags to be added to a new threat list resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ThreatIntelSetId — (String)

        The ID of the ThreatIntelSet resource.

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 accounts 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 that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

          The 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 an Amazon GuardDuty detector that is 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 of 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 of the detector that the filter is associated with.

    • FilterName — (String)

      The name of the filter 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.

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 that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

          The 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 ipSetId. IPSets are called trusted IP lists in the console user interface.

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 unique ID of the detector associated with the IPSet.

    • IpSetId — (String)

      The unique ID of the IPSet 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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account whose members you want to delete.

    • AccountIds — (Array<String>)

      A list of account IDs of the GuardDuty member accounts 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. The data object has the following properties:

      • UnprocessedAccounts — (Array<map>)

        The accounts that could not be processed.

        • AccountIdrequired — (String)

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

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

Deletes the publishing definition with the specified destinationId.

Service Reference:

Examples:

Calling the deletePublishingDestination operation

var params = {
  DestinationId: 'STRING_VALUE', /* required */
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.deletePublishingDestination(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 associated with the publishing destination to delete.

    • DestinationId — (String)

      The ID of the publishing destination 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.

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

Deletes the 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 unique ID of the detector that the threatIntelSet is associated with.

    • ThreatIntelSetId — (String)

      The unique ID of 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.

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

Returns information about the account selected as the delegated administrator for GuardDuty.

Examples:

Calling the describeOrganizationConfiguration operation

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

Parameters:

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

      The ID of the detector to retrieve information about the delegated administrator 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:

      • AutoEnable — (Boolean)

        Indicates whether GuardDuty is automatically enabled for accounts added to the organization.

      • MemberAccountLimitReached — (Boolean)

        Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator master account.

      • DataSources — (map)

        An object that describes which data sources are enabled automatically for member accounts.

        • S3Logsrequired — (map)

          Describes whether S3 data event logs are enabled as a data source.

          • AutoEnablerequired — (Boolean)

            A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

Returns:

  • (AWS.Request)

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

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

Returns information about the publishing destination specified by the provided destinationId.

Service Reference:

Examples:

Calling the describePublishingDestination operation

var params = {
  DestinationId: 'STRING_VALUE', /* required */
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.describePublishingDestination(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 associated with the publishing destination to retrieve.

    • DestinationId — (String)

      The ID of the publishing destination 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:

      • DestinationId — (String)

        The ID of the publishing destination.

      • DestinationType — (String)

        The type of publishing destination. Currently, only Amazon S3 buckets are supported.

        Possible values include:
        • "S3"
      • Status — (String)

        The status of the publishing destination.

        Possible values include:
        • "PENDING_VERIFICATION"
        • "PUBLISHING"
        • "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY"
        • "STOPPED"
      • PublishingFailureStartTimestamp — (Integer)

        The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.

      • DestinationProperties — (map)

        A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

        • DestinationArn — (String)

          The ARN of the resource to publish to.

        • KmsKeyArn — (String)

          The ARN of the KMS key to use for encryption.

Returns:

  • (AWS.Request)

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

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

Disables an AWS account within the Organization as the GuardDuty delegated administrator.

Service Reference:

Examples:

Calling the disableOrganizationAdminAccount operation

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

      The AWS Account ID for the organizations account to be disabled as a GuardDuty delegated administrator.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the master account.

    • AccountIds — (Array<String>)

      A list of account IDs of the GuardDuty member accounts that you want to disassociate from the master account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • UnprocessedAccounts — (Array<map>)

        A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

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

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

Enables an AWS account within the organization as the GuardDuty delegated administrator.

Service Reference:

Examples:

Calling the enableOrganizationAdminAccount operation

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

      The AWS Account ID for the organization account to be enabled as a GuardDuty delegated administrator.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

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

      • CreatedAt — (String)

        The timestamp of when the detector was created.

      • FindingPublishingFrequency — (String)

        The publishing frequency of the finding.

        Possible values include:
        • "FIFTEEN_MINUTES"
        • "ONE_HOUR"
        • "SIX_HOURS"
      • ServiceRole — (String)

        The GuardDuty service role.

      • Status — (String)

        The detector status.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • UpdatedAt — (String)

        The last-updated timestamp for the detector.

      • DataSources — (map)

        An object that describes which data sources are enabled for the detector.

        • CloudTrailrequired — (map)

          An object that contains information on the status of CloudTrail as a data source.

          • Statusrequired — (String)

            Describes whether CloudTrail is enabled as a data source for the detector.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • DNSLogsrequired — (map)

          An object that contains information on the status of DNS logs as a data source.

          • Statusrequired — (String)

            Denotes whether DNS logs is enabled as a data source.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • FlowLogsrequired — (map)

          An object that contains information on the status of VPC flow logs as a data source.

          • Statusrequired — (String)

            Denotes whether VPC flow logs is enabled as a data source.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • S3Logsrequired — (map)

          An object that contains information on the status of S3 Data event logs as a data source.

          • Statusrequired — (String)

            A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
      • Tags — (map<String>)

        The tags of the detector resource.

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 unique ID of the detector that the filter is associated with.

    • FilterName — (String)

      The name of the filter 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:

      • Name — (String)

        The name of the filter.

      • Description — (String)

        The description of the filter.

      • Action — (String)

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

        Possible values include:
        • "NOOP"
        • "ARCHIVE"
      • 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.

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

          • Neq — (Array<String>)

            Represents the not equal condition to be applied to a single field when querying for findings.

          • Gt — (Integer)

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte — (Integer)

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt — (Integer)

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte — (Integer)

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals — (Array<String>)

            Represents an equal condition to be applied to a single field when querying for findings.

          • NotEquals — (Array<String>)

            Represents a not equal condition to be applied to a single field when querying for findings.

          • GreaterThan — (Integer)

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual — (Integer)

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan — (Integer)

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual — (Integer)

            Represents a less than or equal condition to be applied to a single field when querying for findings.

      • Tags — (map<String>)

        The tags of the filter resource.

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

      The 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) to sort findings by.

      • OrderBy — (String)

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

          The ID of the account in which the finding was generated.

        • Arnrequired — (String)

          The ARN of the finding.

        • Confidence — (Float)

          The confidence score for the finding.

        • CreatedAtrequired — (String)

          The time and date when the finding was created.

        • Description — (String)

          The description of the finding.

        • Idrequired — (String)

          The ID of the finding.

        • Partition — (String)

          The partition associated with the finding.

        • Regionrequired — (String)

          The Region where the finding was generated.

        • Resourcerequired — (map)

          Contains information about 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)

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

          • S3BucketDetails — (Array<map>)

            Contains information on the S3 bucket.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the S3 bucket.

            • Name — (String)

              The name of the S3 bucket.

            • Type — (String)

              Describes whether the bucket is a source or destination bucket.

            • CreatedAt — (Date)

              The date and time the bucket was created at.

            • Owner — (map)

              The owner of the S3 bucket.

            • Tags — (Array<map>)

              All tags attached to the S3 bucket

              • Key — (String)

                The EC2 instance tag key.

              • Value — (String)

                The EC2 instance tag value.

            • DefaultServerSideEncryption — (map)

              Describes the server side encryption method used in the S3 bucket.

              • EncryptionType — (String)

                The type of encryption used for objects within the S3 bucket.

              • KmsMasterKeyArn — (String)

                The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket EncryptionType is aws:kms.

            • PublicAccess — (map)

              Describes the public access policies that apply to the S3 bucket.

              • PermissionConfiguration — (map)

                Contains information about how permissions are configured for the S3 bucket.

                • BucketLevelPermissions — (map)

                  Contains information about the bucket level permissions for the S3 bucket.

                  • AccessControlList — (map)

                    Contains information on how Access Control Policies are applied to the bucket.

                    • AllowsPublicReadAccess — (Boolean)

                      A value that indicates whether public read access for the bucket is enabled through an Access Control List (ACL).

                    • AllowsPublicWriteAccess — (Boolean)

                      A value that indicates whether public write access for the bucket is enabled through an Access Control List (ACL).

                  • BucketPolicy — (map)

                    Contains information on the bucket policies for the S3 bucket.

                    • AllowsPublicReadAccess — (Boolean)

                      A value that indicates whether public read access for the bucket is enabled through a bucket policy.

                    • AllowsPublicWriteAccess — (Boolean)

                      A value that indicates whether public write access for the bucket is enabled through a bucket policy.

                  • BlockPublicAccess — (map)

                    Contains information on which account level S3 Block Public Access settings are applied to the S3 bucket.

                    • IgnorePublicAcls — (Boolean)

                      Indicates if S3 Block Public Access is set to IgnorePublicAcls.

                    • RestrictPublicBuckets — (Boolean)

                      Indicates if S3 Block Public Access is set to RestrictPublicBuckets.

                    • BlockPublicAcls — (Boolean)

                      Indicates if S3 Block Public Access is set to BlockPublicAcls.

                    • BlockPublicPolicy — (Boolean)

                      Indicates if S3 Block Public Access is set to BlockPublicPolicy.

                • AccountLevelPermissions — (map)

                  Contains information about the account level permissions on the S3 bucket.

                  • BlockPublicAccess — (map)

                    Describes the S3 Block Public Access settings of the bucket's parent account.

                    • IgnorePublicAcls — (Boolean)

                      Indicates if S3 Block Public Access is set to IgnorePublicAcls.

                    • RestrictPublicBuckets — (Boolean)

                      Indicates if S3 Block Public Access is set to RestrictPublicBuckets.

                    • BlockPublicAcls — (Boolean)

                      Indicates if S3 Block Public Access is set to BlockPublicAcls.

                    • BlockPublicPolicy — (Boolean)

                      Indicates if S3 Block Public Access is set to BlockPublicPolicy.

              • EffectivePermission — (String)

                Describes the effective permission on this bucket after factoring all attached policies.

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

                The profile ARN of the EC2 instance.

              • Id — (String)

                The profile ID of the EC2 instance.

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

            • OutpostArn — (String)

              The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts instances.

            • LaunchTime — (String)

              The launch time of the EC2 instance.

            • NetworkInterfaces — (Array<map>)

              The elastic network interface information of the EC2 instance.

              • Ipv6Addresses — (Array<String>)

                A list of IPv6 addresses for the EC2 instance.

              • NetworkInterfaceId — (String)

                The ID of the network interface.

              • PrivateDnsName — (String)

                The private DNS name of the EC2 instance.

              • PrivateIpAddress — (String)

                The private IP address of the EC2 instance.

              • PrivateIpAddresses — (Array<map>)

                Other private IP address information of the EC2 instance.

                • PrivateDnsName — (String)

                  The private DNS name of the EC2 instance.

                • PrivateIpAddress — (String)

                  The private IP address of the EC2 instance.

              • PublicDnsName — (String)

                The public DNS name of the EC2 instance.

              • PublicIp — (String)

                The public IP address of the EC2 instance.

              • SecurityGroups — (Array<map>)

                The security groups associated with the EC2 instance.

                • GroupId — (String)

                  The security group ID of the EC2 instance.

                • GroupName — (String)

                  The security group name of the EC2 instance.

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

                The product code information.

              • ProductType — (String)

                The product code type.

            • Tags — (Array<map>)

              The tags of the EC2 instance.

              • Key — (String)

                The EC2 instance tag key.

              • Value — (String)

                The EC2 instance tag value.

          • ResourceType — (String)

            The type of AWS resource.

        • SchemaVersionrequired — (String)

          The version of the schema used for the finding.

        • Service — (map)

          Contains additional information about the generated finding.

          • Action — (map)

            Information about the activity that is described in a finding.

            • ActionType — (String)

              The GuardDuty finding activity type.

            • AwsApiCallAction — (map)

              Information about the AWS_API_CALL action described in this finding.

              • Api — (String)

                The AWS API name.

              • CallerType — (String)

                The AWS API caller type.

              • DomainDetails — (map)

                The domain information for the AWS API call.

                • Domain — (String)

                  The domain information for the AWS API call.

              • ErrorCode — (String)

                The error code of the failed AWS API action.

              • RemoteIpDetails — (map)

                The remote IP information of the connection that initiated the AWS API call.

                • City — (map)

                  The city information of the remote IP address.

                  • CityName — (String)

                    The city name of the remote IP address.

                • Country — (map)

                  The country code of the remote IP address.

                  • CountryCode — (String)

                    The country code of the remote IP address.

                  • CountryName — (String)

                    The country name of the remote IP address.

                • GeoLocation — (map)

                  The location information of the remote IP address.

                  • Lat — (Float)

                    The latitude information of the remote IP address.

                  • Lon — (Float)

                    The longitude information of the remote IP address.

                • IpAddressV4 — (String)

                  The IPv4 remote address of the connection.

                • Organization — (map)

                  The ISP organization information of the remote IP address.

                  • Asn — (String)

                    The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                  • AsnOrg — (String)

                    The organization that registered this ASN.

                  • Isp — (String)

                    The ISP information for the internet provider.

                  • Org — (String)

                    The name of the internet provider.

              • ServiceName — (String)

                The AWS service name whose API was invoked.

            • DnsRequestAction — (map)

              Information about the DNS_REQUEST action described in this finding.

              • Domain — (String)

                The domain information for the API request.

            • NetworkConnectionAction — (map)

              Information about the NETWORK_CONNECTION action described in this finding.

              • Blocked — (Boolean)

                Indicates whether EC2 blocked the network connection to your instance.

              • ConnectionDirection — (String)

                The network connection direction.

              • LocalPortDetails — (map)

                The local port information of the connection.

                • Port — (Integer)

                  The port number of the local connection.

                • PortName — (String)

                  The port name of the local connection.

              • Protocol — (String)

                The network connection protocol.

              • LocalIpDetails — (map)

                The local IP information of the connection.

                • IpAddressV4 — (String)

                  The IPv4 local address of the connection.

              • RemoteIpDetails — (map)

                The remote IP information of the connection.

                • City — (map)

                  The city information of the remote IP address.

                  • CityName — (String)

                    The city name of the remote IP address.

                • Country — (map)

                  The country code of the remote IP address.

                  • CountryCode — (String)

                    The country code of the remote IP address.

                  • CountryName — (String)

                    The country name of the remote IP address.

                • GeoLocation — (map)

                  The location information of the remote IP address.

                  • Lat — (Float)

                    The latitude information of the remote IP address.

                  • Lon — (Float)

                    The longitude information of the remote IP address.

                • IpAddressV4 — (String)

                  The IPv4 remote address of the connection.

                • Organization — (map)

                  The ISP organization information of the remote IP address.

                  • Asn — (String)

                    The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                  • AsnOrg — (String)

                    The organization that registered this ASN.

                  • Isp — (String)

                    The ISP information for the internet provider.

                  • Org — (String)

                    The name of the internet provider.

              • RemotePortDetails — (map)

                The remote port information of the connection.

                • Port — (Integer)

                  The port number of the remote connection.

                • PortName — (String)

                  The port name of the remote connection.

            • PortProbeAction — (map)

              Information about the PORT_PROBE action described in this finding.

              • Blocked — (Boolean)

                Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.

              • PortProbeDetails — (Array<map>)

                A list of objects related to port probe details.

                • LocalPortDetails — (map)

                  The local port information of the connection.

                  • Port — (Integer)

                    The port number of the local connection.

                  • PortName — (String)

                    The port name of the local connection.

                • LocalIpDetails — (map)

                  The local IP information of the connection.

                  • IpAddressV4 — (String)

                    The IPv4 local address of the connection.

                • RemoteIpDetails — (map)

                  The remote IP information of the connection.

                  • City — (map)

                    The city information of the remote IP address.

                    • CityName — (String)

                      The city name of the remote IP address.

                  • Country — (map)

                    The country code of the remote IP address.

                    • CountryCode — (String)

                      The country code of the remote IP address.

                    • CountryName — (String)

                      The country name of the remote IP address.

                  • GeoLocation — (map)

                    The location information of the remote IP address.

                    • Lat — (Float)

                      The latitude information of the remote IP address.

                    • Lon — (Float)

                      The longitude information of the remote IP address.

                  • IpAddressV4 — (String)

                    The IPv4 remote address of the connection.

                  • Organization — (map)

                    The ISP organization information of the remote IP address.

                    • Asn — (String)

                      The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                    • AsnOrg — (String)

                      The organization that registered this ASN.

                    • Isp — (String)

                      The ISP information for the internet provider.

                    • Org — (String)

                      The name of the internet provider.

          • Evidence — (map)

            An evidence object associated with the service.

            • ThreatIntelligenceDetails — (Array<map>)

              A list of threat intelligence details related to the evidence.

              • ThreatListName — (String)

                The name of the threat intelligence list that triggered the finding.

              • ThreatNames — (Array<String>)

                A list of names of the threats in the threat intelligence list that triggered the finding.

          • Archived — (Boolean)

            Indicates whether this finding is archived.

          • Count — (Integer)

            The total count of the occurrences of this finding type.

          • DetectorId — (String)

            The detector ID for the GuardDuty service.

          • EventFirstSeen — (String)

            The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.

          • EventLastSeen — (String)

            The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.

          • ResourceRole — (String)

            The resource role information for this finding.

          • ServiceName — (String)

            The name of the AWS service (GuardDuty) that generated a finding.

          • UserFeedback — (String)

            Feedback that was submitted about the finding.

        • Severityrequired — (Float)

          The severity of the finding.

        • Title — (String)

          The title of the finding.

        • Typerequired — (String)

          The type of finding.

        • UpdatedAtrequired — (String)

          The time and date when the 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 */
        ],
        Equals: [
          'STRING_VALUE',
          /* more items */
        ],
        GreaterThan: 'NUMBER_VALUE',
        GreaterThanOrEqual: 'NUMBER_VALUE',
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        LessThan: 'NUMBER_VALUE',
        LessThanOrEqual: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ],
        NotEquals: [
          '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.

    • FindingStatisticTypes — (Array<String>)

      The types of finding statistics to retrieve.

    • FindingCriteria — (map)

      Represents the criteria that is 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.

        • Neq — (Array<String>)

          Represents the not equal condition to be applied to a single field when querying for findings.

        • Gt — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • Gte — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • Lt — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • Lte — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

        • Equals — (Array<String>)

          Represents an equal condition to be applied to a single field when querying for findings.

        • NotEquals — (Array<String>)

          Represents a not equal condition to be applied to a single field when querying for findings.

        • GreaterThan — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • GreaterThanOrEqual — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • LessThan — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • LessThanOrEqual — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for 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:

      • FindingStatistics — (map)

        The finding statistics object.

        • CountBySeverity — (map<Integer>)

          Represents a map of severity to count statistics 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 ipSetId.

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 unique ID of the detector that the IPSet is associated with.

    • IpSetId — (String)

      The unique ID of the IPSet 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:

      • Name — (String)

        The user-friendly name for the IPSet.

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

      • Status — (String)

        The status of IPSet file that was uploaded.

        Possible values include:
        • "INACTIVE"
        • "ACTIVATING"
        • "ACTIVE"
        • "DEACTIVATING"
        • "ERROR"
        • "DELETE_PENDING"
        • "DELETED"
      • Tags — (map<String>)

        The tags of the IPSet resource.

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

        The master account details.

        • AccountId — (String)

          The ID of the account used as the master account.

        • InvitationId — (String)

          The value used to validate the master account to the member account.

        • RelationshipStatus — (String)

          The status of the relationship between the master and member accounts.

        • InvitedAt — (String)

          The timestamp when the invitation was sent.

Returns:

  • (AWS.Request)

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

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

Describes which data sources are enabled for the member account's detector.

Service Reference:

Examples:

Calling the getMemberDetectors operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE' /* required */
};
guardduty.getMemberDetectors(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 for the master account.

    • AccountIds — (Array<String>)

      The account ID of the 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:

      • MemberDataSourceConfigurations — (Array<map>)

        An object that describes which data sources are enabled for a member account.

        • AccountIdrequired — (String)

          The account ID for the member account.

        • DataSourcesrequired — (map)

          Contains information on the status of data sources for the account.

          • CloudTrailrequired — (map)

            An object that contains information on the status of CloudTrail as a data source.

            • Statusrequired — (String)

              Describes whether CloudTrail is enabled as a data source for the detector.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • DNSLogsrequired — (map)

            An object that contains information on the status of DNS logs as a data source.

            • Statusrequired — (String)

              Denotes whether DNS logs is enabled as a data source.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • FlowLogsrequired — (map)

            An object that contains information on the status of VPC flow logs as a data source.

            • Statusrequired — (String)

              Denotes whether VPC flow logs is enabled as a data source.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • S3Logsrequired — (map)

            An object that contains information on the status of S3 Data event logs as a data source.

            • Statusrequired — (String)

              A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
      • UnprocessedAccounts — (Array<map>)

        A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.

        • AccountIdrequired — (String)

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

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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

    • AccountIds — (Array<String>)

      A list of account IDs of the GuardDuty member accounts 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:

      • Members — (Array<map>)

        A list of members.

        • AccountIdrequired — (String)

          The ID of the member account.

        • DetectorId — (String)

          The detector ID of the member account.

        • MasterIdrequired — (String)

          The master account ID.

        • Emailrequired — (String)

          The email address of the member account.

        • RelationshipStatusrequired — (String)

          The status of the relationship between the member and the master.

        • InvitedAt — (String)

          The timestamp when the invitation was sent.

        • UpdatedAtrequired — (String)

          The last-updated timestamp of the member.

      • UnprocessedAccounts — (Array<map>)

        A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

          The 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 unique ID of the detector that the threatIntelSet is associated with.

    • ThreatIntelSetId — (String)

      The unique ID of the threatIntelSet that 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:

      • Name — (String)

        A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

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

      • Status — (String)

        The status of threatIntelSet file uploaded.

        Possible values include:
        • "INACTIVE"
        • "ACTIVATING"
        • "ACTIVE"
        • "DEACTIVATING"
        • "ERROR"
        • "DELETE_PENDING"
        • "DELETED"
      • Tags — (map<String>)

        The tags of the threat list resource.

Returns:

  • (AWS.Request)

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

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

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources the cost returned will include only the usage so far under 30 days, this may differ from the cost metrics in the console, which projects usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.

Service Reference:

Examples:

Calling the getUsageStatistics operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  UsageCriteria: { /* required */
    DataSources: [ /* required */
      FLOW_LOGS | CLOUD_TRAIL | DNS_LOGS | S3_LOGS,
      /* more items */
    ],
    AccountIds: [
      'STRING_VALUE',
      /* more items */
    ],
    Resources: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  UsageStatisticType: SUM_BY_ACCOUNT | SUM_BY_DATA_SOURCE | SUM_BY_RESOURCE | TOP_RESOURCES, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Unit: 'STRING_VALUE'
};
guardduty.getUsageStatistics(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 usage statistics you want to retrieve.

    • UsageStatisticType — (String)

      The type of usage statistics to retrieve.

      Possible values include:
      • "SUM_BY_ACCOUNT"
      • "SUM_BY_DATA_SOURCE"
      • "SUM_BY_RESOURCE"
      • "TOP_RESOURCES"
    • UsageCriteria — (map)

      Represents the criteria used for querying usage.

      • AccountIds — (Array<String>)

        The account IDs to aggregate usage statistics from.

      • DataSourcesrequired — (Array<String>)

        The data sources to aggregate usage statistics from.

      • Resources — (Array<String>)

        The resources to aggregate usage statistics from. Only accepts exact resource names.

    • Unit — (String)

      The currency unit you would like to view your usage statistics in. Current valid values are USD.

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • UsageStatistics — (map)

        The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.

        • SumByAccount — (Array<map>)

          The usage statistic sum organized by account ID.

          • AccountId — (String)

            The Account ID that generated usage.

          • Total — (map)

            Represents the total of usage for the Account ID.

            • Amount — (String)

              The total usage.

            • Unit — (String)

              The currency unit that the amount is given in.

        • SumByDataSource — (Array<map>)

          The usage statistic sum organized by on data source.

          • DataSource — (String)

            The data source type that generated usage.

            Possible values include:
            • "FLOW_LOGS"
            • "CLOUD_TRAIL"
            • "DNS_LOGS"
            • "S3_LOGS"
          • Total — (map)

            Represents the total of usage for the specified data source.

            • Amount — (String)

              The total usage.

            • Unit — (String)

              The currency unit that the amount is given in.

        • SumByResource — (Array<map>)

          The usage statistic sum organized by resource.

          • Resource — (String)

            The AWS resource that generated usage.

          • Total — (map)

            Represents the sum total of usage for the specified resource type.

            • Amount — (String)

              The total usage.

            • Unit — (String)

              The currency unit that the amount is given in.

        • TopResources — (Array<map>)

          Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.

          • Resource — (String)

            The AWS resource that generated usage.

          • Total — (map)

            Represents the sum total of usage for the specified resource type.

            • Amount — (String)

              The total usage.

            • Unit — (String)

              The currency unit that the amount is given in.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty account that you want to invite members with.

    • AccountIds — (Array<String>)

      A list of account IDs of the accounts that you want to invite to GuardDuty as members.

    • DisableEmailNotification — (Boolean)

      A Boolean value that specifies whether you want to disable email notification to the accounts that you are 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 that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

          The 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 items that 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 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.

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)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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 unique ID of the detector that the filter is associated with.

    • MaxResults — (Integer)

      You can use this parameter to indicate the maximum number of items that 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 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.

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)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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 */
        ],
        Equals: [
          'STRING_VALUE',
          /* more items */
        ],
        GreaterThan: 'NUMBER_VALUE',
        GreaterThanOrEqual: 'NUMBER_VALUE',
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        LessThan: 'NUMBER_VALUE',
        LessThanOrEqual: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ],
        NotEquals: [
          '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. Valid values include:

      • JSON field name

      • accountId

      • region

      • confidence

      • id

      • resource.accessKeyDetails.accessKeyId

      • resource.accessKeyDetails.principalId

      • resource.accessKeyDetails.userName

      • resource.accessKeyDetails.userType

      • resource.instanceDetails.iamInstanceProfile.id

      • resource.instanceDetails.imageId

      • resource.instanceDetails.instanceId

      • resource.instanceDetails.networkInterfaces.ipv6Addresses

      • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

      • resource.instanceDetails.networkInterfaces.publicDnsName

      • resource.instanceDetails.networkInterfaces.publicIp

      • resource.instanceDetails.networkInterfaces.securityGroups.groupId

      • resource.instanceDetails.networkInterfaces.securityGroups.groupName

      • resource.instanceDetails.networkInterfaces.subnetId

      • resource.instanceDetails.networkInterfaces.vpcId

      • resource.instanceDetails.tags.key

      • resource.instanceDetails.tags.value

      • resource.resourceType

      • service.action.actionType

      • service.action.awsApiCallAction.api

      • service.action.awsApiCallAction.callerType

      • service.action.awsApiCallAction.remoteIpDetails.city.cityName

      • service.action.awsApiCallAction.remoteIpDetails.country.countryName

      • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

      • service.action.awsApiCallAction.remoteIpDetails.organization.asn

      • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

      • service.action.awsApiCallAction.serviceName

      • service.action.dnsRequestAction.domain

      • service.action.networkConnectionAction.blocked

      • service.action.networkConnectionAction.connectionDirection

      • service.action.networkConnectionAction.localPortDetails.port

      • service.action.networkConnectionAction.protocol

      • service.action.networkConnectionAction.remoteIpDetails.city.cityName

      • service.action.networkConnectionAction.remoteIpDetails.country.countryName

      • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

      • service.action.networkConnectionAction.remoteIpDetails.organization.asn

      • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

      • service.action.networkConnectionAction.remotePortDetails.port

      • service.additionalInfo.threatListName

      • service.archived

        When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.

      • service.resourceRole

      • severity

      • type

      • updatedAt

        Type: Timestamp in Unix Epoch millisecond format: 1486685375000

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

        • Neq — (Array<String>)

          Represents the not equal condition to be applied to a single field when querying for findings.

        • Gt — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • Gte — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • Lt — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • Lte — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

        • Equals — (Array<String>)

          Represents an equal condition to be applied to a single field when querying for findings.

        • NotEquals — (Array<String>)

          Represents a not equal condition to be applied to a single field when querying for findings.

        • GreaterThan — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • GreaterThanOrEqual — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • LessThan — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • LessThanOrEqual — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

    • SortCriteria — (map)

      Represents the criteria used for sorting findings.

      • AttributeName — (String)

        Represents the finding attribute (for example, accountId) to sort findings by.

      • OrderBy — (String)

        The order by which the sorted findings are to be displayed.

        Possible values include:
        • "ASC"
        • "DESC"
    • 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 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.

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 IDs of the findings that you're listing.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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 items that 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 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.

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)

          The ID of the account that the invitation was sent from.

        • InvitationId — (String)

          The ID of the invitation. This value is used to validate the inviter account to the member account.

        • RelationshipStatus — (String)

          The status of the relationship between the inviter and invitee accounts.

        • InvitedAt — (String)

          The timestamp when the invitation was sent.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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

Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated master account.

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 the IPSet is associated with.

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

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

        The IDs of the IPSet resources.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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 the member is associated with.

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

    • OnlyAssociated — (String)

      Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated).

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

        • AccountIdrequired — (String)

          The ID of the member account.

        • DetectorId — (String)

          The detector ID of the member account.

        • MasterIdrequired — (String)

          The master account ID.

        • Emailrequired — (String)

          The email address of the member account.

        • RelationshipStatusrequired — (String)

          The status of the relationship between the member and the master.

        • InvitedAt — (String)

          The timestamp when the invitation was sent.

        • UpdatedAtrequired — (String)

          The last-updated timestamp of the member.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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

Lists the accounts configured as GuardDuty delegated administrators.

Service Reference:

Examples:

Calling the listOrganizationAdminAccounts operation

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

Parameters:

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

      The maximum number of results to return in the response.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • AdminAccounts — (Array<map>)

        An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated administrators.

        • AdminAccountId — (String)

          The AWS account ID for the account.

        • AdminStatus — (String)

          Indicates whether the account is enabled as the delegated administrator.

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

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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

Returns a list of publishing destinations associated with the specified dectectorId.

Service Reference:

Examples:

Calling the listPublishingDestinations operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
guardduty.listPublishingDestinations(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 retrieve publishing destinations for.

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Destinations — (Array<map>)

        A Destinations object that includes information about each publishing destination returned.

        • DestinationIdrequired — (String)

          The unique ID of the publishing destination.

        • DestinationTyperequired — (String)

          The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.

          Possible values include:
          • "S3"
        • Statusrequired — (String)

          The status of the publishing destination.

          Possible values include:
          • "PENDING_VERIFICATION"
          • "PUBLISHING"
          • "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY"
          • "STOPPED"
      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) for the given GuardDuty resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Tags — (map<String>)

        The tags associated with the resource.

Returns:

  • (AWS.Request)

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

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

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the master account are returned.

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 unique ID of the detector that the threatIntelSet is associated with.

    • MaxResults — (Integer)

      You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

    • NextToken — (String)

      You can use this parameter to paginate results in the response. 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.

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:

      • ThreatIntelSetIds — (Array<String>)

        The IDs of the ThreatIntelSet resources.

      • NextToken — (String)

        The pagination parameter to be used on the next list operation to retrieve more items.

Returns:

  • (AWS.Request)

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

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

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

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: {})
    • DetectorId — (String)

      The unique ID of the detector of the GuardDuty master account associated with the member accounts to monitor.

    • AccountIds — (Array<String>)

      A list of account IDs of the GuardDuty member accounts to start monitoring.

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 that contain the unprocessed account and a result string that explains why it was unprocessed.

        • AccountIdrequired — (String)

          The 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

Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.

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: {})
    • DetectorId — (String)

      The unique ID of the detector associated with the GuardDuty master account that is monitoring member accounts.

    • AccountIds — (Array<String>)

      A list of account IDs for the member accounts to stop monitoring.

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 that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.

        • AccountIdrequired — (String)

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

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

Adds tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
guardduty.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.

    • Tags — (map<String>)

      The tags to be added to a resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Unarchives GuardDuty findings specified by the findingIds.

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 associated with the findings to unarchive.

    • FindingIds — (Array<String>)

      The IDs of the findings 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.

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

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) for the resource to remove tags from.

    • TagKeys — (Array<String>)

      The tag keys to remove from the resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Updates the Amazon GuardDuty detector specified by the detectorId.

Service Reference:

Examples:

Calling the updateDetector operation

var params = {
  DetectorId: 'STRING_VALUE', /* required */
  DataSources: {
    S3Logs: {
      Enable: true || false /* 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 to update.

    • Enable — (Boolean)

      Specifies whether the detector is enabled or not enabled.

    • FindingPublishingFrequency — (String)

      An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.

      Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • DataSources — (map)

      An object that describes which data sources will be updated.

      • S3Logs — (map)

        Describes whether S3 data event logs are enabled as a data source.

        • Enablerequired — (Boolean)

          The status of S3 data event logs as a data source.

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 */
        ],
        Equals: [
          'STRING_VALUE',
          /* more items */
        ],
        GreaterThan: 'NUMBER_VALUE',
        GreaterThanOrEqual: 'NUMBER_VALUE',
        Gt: 'NUMBER_VALUE',
        Gte: 'NUMBER_VALUE',
        LessThan: 'NUMBER_VALUE',
        LessThanOrEqual: 'NUMBER_VALUE',
        Lt: 'NUMBER_VALUE',
        Lte: 'NUMBER_VALUE',
        Neq: [
          'STRING_VALUE',
          /* more items */
        ],
        NotEquals: [
          '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: {})
    • 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.

    • Description — (String)

      The description of the filter.

    • Action — (String)

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

      Possible values include:
      • "NOOP"
      • "ARCHIVE"
    • 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.

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

        • Neq — (Array<String>)

          Represents the not equal condition to be applied to a single field when querying for findings.

        • Gt — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • Gte — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • Lt — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • Lte — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for findings.

        • Equals — (Array<String>)

          Represents an equal condition to be applied to a single field when querying for findings.

        • NotEquals — (Array<String>)

          Represents a not equal condition to be applied to a single field when querying for findings.

        • GreaterThan — (Integer)

          Represents a greater than condition to be applied to a single field when querying for findings.

        • GreaterThanOrEqual — (Integer)

          Represents a greater than or equal condition to be applied to a single field when querying for findings.

        • LessThan — (Integer)

          Represents a less than condition to be applied to a single field when querying for findings.

        • LessThanOrEqual — (Integer)

          Represents a less than or equal condition to be applied to a single field when querying for 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 the specified 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: {})
    • DetectorId — (String)

      The ID of the detector associated with the findings to update feedback for.

    • FindingIds — (Array<String>)

      The IDs of the findings that you want to mark as useful or not useful.

    • Feedback — (String)

      The feedback for the finding.

      Possible values include:
      • "USEFUL"
      • "NOT_USEFUL"
    • Comments — (String)

      Additional feedback about the GuardDuty 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.

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: {})
    • 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.

    • Name — (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.

    • Activate — (Boolean)

      The updated Boolean value that specifies whether the IPSet is active or not.

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.

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

Contains information on member accounts to be updated.

Service Reference:

Examples:

Calling the updateMemberDetectors operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DetectorId: 'STRING_VALUE', /* required */
  DataSources: {
    S3Logs: {
      Enable: true || false /* required */
    }
  }
};
guardduty.updateMemberDetectors(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 of the master account.

    • AccountIds — (Array<String>)

      A list of member account IDs to be updated.

    • DataSources — (map)

      An object describes which data sources will be updated.

      • S3Logs — (map)

        Describes whether S3 data event logs are enabled as a data source.

        • Enablerequired — (Boolean)

          The status of S3 data event logs as a data source.

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 member account IDs that were unable to be processed along with an explanation for why they were not processed.

        • AccountIdrequired — (String)

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

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

Updates the delegated administrator account with the values provided.

Service Reference:

Examples:

Calling the updateOrganizationConfiguration operation

var params = {
  AutoEnable: true || false, /* required */
  DetectorId: 'STRING_VALUE', /* required */
  DataSources: {
    S3Logs: {
      AutoEnable: true || false /* required */
    }
  }
};
guardduty.updateOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The ID of the detector to update the delegated administrator for.

    • AutoEnable — (Boolean)

      Indicates whether to automatically enable member accounts in the organization.

    • DataSources — (map)

      An object describes which data sources will be updated.

      • S3Logs — (map)

        Describes whether S3 data event logs are enabled for new members of the organization.

        • AutoEnablerequired — (Boolean)

          A value that contains information on whether S3 data event logs will be enabled automatically as a data source for the organization.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Updates information about the publishing destination specified by the destinationId.

Service Reference:

Examples:

Calling the updatePublishingDestination operation

var params = {
  DestinationId: 'STRING_VALUE', /* required */
  DetectorId: 'STRING_VALUE', /* required */
  DestinationProperties: {
    DestinationArn: 'STRING_VALUE',
    KmsKeyArn: 'STRING_VALUE'
  }
};
guardduty.updatePublishingDestination(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 associated with the publishing destinations to update.

    • DestinationId — (String)

      The ID of the publishing destination to update.

    • DestinationProperties — (map)

      A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

      • DestinationArn — (String)

        The ARN of the resource to publish to.

      • KmsKeyArn — (String)

        The ARN of the KMS key to use for encryption.

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 the 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: {})
    • DetectorId — (String)

      The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.

    • ThreatIntelSetId — (String)

      The unique ID that specifies the ThreatIntelSet that you want to update.

    • Name — (String)

      The unique ID that specifies the ThreatIntelSet that 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.

    • Activate — (Boolean)

      The updated Boolean value that specifies whether the ThreateIntelSet is active or not.

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.