NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $guardduty = Paws->service('GuardDuty');
my $CreateFilterResponse = $guardduty->CreateFilter(
  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
  },
  Name        => 'MyFilterName',
  Action      => 'NOOP',                   # OPTIONAL
  ClientToken => 'MyClientToken',          # OPTIONAL
  Description => 'MyFilterDescription',    # OPTIONAL
  Rank        => 1,                        # OPTIONAL
  Tags        => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
);

# Results:
my $Name = $CreateFilterResponse->Name;

# Returns a L<Paws::GuardDuty::CreateFilterResponse> 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/CreateFilter

ATTRIBUTES

Action => Str

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

Valid values are: "NOOP", "ARCHIVE"

ClientToken => Str

The idempotency token for the create request.

Description => Str

The description of the filter.

REQUIRED DetectorId => Str

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

REQUIRED FindingCriteria => Paws::GuardDuty::FindingCriteria

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

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

REQUIRED Name => Str

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

Rank => Int

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.

Tags => Paws::GuardDuty::TagMap

The tags to be added to a new filter resource.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateFilter 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