GuardDuty / Client / get_filter

get_filter#

GuardDuty.Client.get_filter(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_filter(
    DetectorId='string',
    FilterName='string'
)
Parameters:
  • DetectorId (string) –

    [REQUIRED]

    The unique ID of the detector that the filter is associated with.

  • FilterName (string) –

    [REQUIRED]

    The name of the filter you want to get.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'Action': 'NOOP'|'ARCHIVE',
    'Rank': 123,
    'FindingCriteria': {
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

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

    • 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 (dict) –

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

      • Criterion (dict) –

        Represents a map of finding properties that match specified conditions and values when querying findings.

        • (string) –

          • (dict) –

            Contains information about the condition.

            • Eq (list) –

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

              • (string) –

            • Neq (list) –

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

              • (string) –

            • 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 (list) –

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

              • (string) –

            • NotEquals (list) –

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

              • (string) –

            • 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 (dict) –

      The tags of the filter resource.

      • (string) –

        • (string) –

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException