Class: Aws::GuardDuty::Types::ListFindingsRequest

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::ListFindingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-guardduty/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #detector_id ⇒ String

  The ID of the detector that specifies the GuardDuty service whose findings you want to list.

• #finding_criteria ⇒ Types::FindingCriteria

  Represents the criteria used for querying findings.

• #max_results ⇒ Integer

  You can use this parameter to indicate the maximum number of items you want in the response.

• #next_token ⇒ String

  You can use this parameter when paginating results.

• #sort_criteria ⇒ Types::SortCriteria

  Represents the criteria used for sorting findings.

Instance Attribute Details

#detector_id ⇒ String

The ID of the detector that specifies the GuardDuty service whose findings you want to list.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Returns:

• (String)

# File 'lib/aws-sdk-guardduty/types.rb', line 8785

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :sort_criteria,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#finding_criteria ⇒ Types::FindingCriteria

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.dnsRequestAction.domainWithSuffix

• service.action.networkConnectionAction.blocked

• service.action.networkConnectionAction.connectionDirection

• service.action.networkConnectionAction.localPortDetails.port

• service.action.networkConnectionAction.protocol

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

• service.resourceRole

• severity

• type

• updatedAt

  Type: Timestamp in Unix Epoch millisecond format: 1486685375000

Returns:

• (Types::FindingCriteria)

# File 'lib/aws-sdk-guardduty/types.rb', line 8785

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :sort_criteria,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-guardduty/types.rb', line 8785

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :sort_criteria,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

• (String)

# File 'lib/aws-sdk-guardduty/types.rb', line 8785

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :sort_criteria,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_criteria ⇒ Types::SortCriteria

Represents the criteria used for sorting findings.

Returns:

• (Types::SortCriteria)

# File 'lib/aws-sdk-guardduty/types.rb', line 8785

class ListFindingsRequest < Struct.new(
  :detector_id,
  :finding_criteria,
  :sort_criteria,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end