NAME

Paws::GuardDuty::ListFindings - Arguments for method ListFindings on Paws::GuardDuty

DESCRIPTION

This class represents the parameters used for calling the method ListFindings on the Amazon GuardDuty service. Use the attributes of this class as arguments to method ListFindings.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListFindings.

SYNOPSIS

my $guardduty = Paws->service('GuardDuty');
my $ListFindingsResponse = $guardduty->ListFindings(
  DetectorId      => 'MyDetectorId',
  FindingCriteria => {
    Criterion => {
      'MyString' => {
        Eq                 => [ 'MyString', ... ],    # OPTIONAL
        Equals             => [ 'MyString', ... ],    # OPTIONAL
        GreaterThan        => 1,                      # OPTIONAL
        GreaterThanOrEqual => 1,                      # OPTIONAL
        Gt                 => 1,                      # OPTIONAL
        Gte                => 1,                      # OPTIONAL
        LessThan           => 1,                      # OPTIONAL
        LessThanOrEqual    => 1,                      # OPTIONAL
        Lt                 => 1,                      # OPTIONAL
        Lte                => 1,                      # OPTIONAL
        Neq                => [ 'MyString', ... ],    # OPTIONAL
        NotEquals          => [ 'MyString', ... ],    # OPTIONAL
      },
    },    # OPTIONAL
  },    # OPTIONAL
  MaxResults   => 1,             # OPTIONAL
  NextToken    => 'MyString',    # OPTIONAL
  SortCriteria => {
    AttributeName => 'MyString',
    OrderBy       => 'ASC',        # values: ASC, DESC; OPTIONAL
  },    # OPTIONAL
);

# Results:
my $FindingIds = $ListFindingsResponse->FindingIds;
my $NextToken  = $ListFindingsResponse->NextToken;

# Returns a L<Paws::GuardDuty::ListFindingsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/guardduty/ListFindings

ATTRIBUTES

REQUIRED DetectorId => Str

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

FindingCriteria => Paws::GuardDuty::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.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

MaxResults => Int

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 => Str

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.

SortCriteria => Paws::GuardDuty::SortCriteria

Represents the criteria used for sorting findings.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListFindings in Paws::GuardDuty

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues