amazonka-maciev2-2.0: Amazon Macie 2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MacieV2.Types.SimpleScopeTerm

Description

 
Synopsis

Documentation

data SimpleScopeTerm Source #

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

See: newSimpleScopeTerm smart constructor.

Constructors

SimpleScopeTerm' 

Fields

  • comparator :: Maybe JobComparator

    The operator to use in the condition. Valid values for each supported property (key) are:

    • OBJECT_EXTENSION - EQ (equals) or NE (not equals)
    • OBJECT_KEY - STARTS_WITH
    • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
    • OBJECT_SIZE - Any operator except CONTAINS
  • key :: Maybe ScopeFilterKey

    The object property to use in the condition.

  • values :: Maybe [Text]

    An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

    Valid values for each supported property (key) are:

    • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
    • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
    • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
    • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

    Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

Instances

Instances details
FromJSON SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

ToJSON SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

Generic SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

Associated Types

type Rep SimpleScopeTerm :: Type -> Type #

Read SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

Show SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

NFData SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

Methods

rnf :: SimpleScopeTerm -> () #

Eq SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

Hashable SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

type Rep SimpleScopeTerm Source # 
Instance details

Defined in Amazonka.MacieV2.Types.SimpleScopeTerm

type Rep SimpleScopeTerm = D1 ('MetaData "SimpleScopeTerm" "Amazonka.MacieV2.Types.SimpleScopeTerm" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "SimpleScopeTerm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comparator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobComparator)) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScopeFilterKey)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newSimpleScopeTerm :: SimpleScopeTerm Source #

Create a value of SimpleScopeTerm with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:comparator:SimpleScopeTerm', simpleScopeTerm_comparator - The operator to use in the condition. Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)
  • OBJECT_KEY - STARTS_WITH
  • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
  • OBJECT_SIZE - Any operator except CONTAINS

$sel:key:SimpleScopeTerm', simpleScopeTerm_key - The object property to use in the condition.

$sel:values:SimpleScopeTerm', simpleScopeTerm_values - An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

simpleScopeTerm_comparator :: Lens' SimpleScopeTerm (Maybe JobComparator) Source #

The operator to use in the condition. Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)
  • OBJECT_KEY - STARTS_WITH
  • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
  • OBJECT_SIZE - Any operator except CONTAINS

simpleScopeTerm_key :: Lens' SimpleScopeTerm (Maybe ScopeFilterKey) Source #

The object property to use in the condition.

simpleScopeTerm_values :: Lens' SimpleScopeTerm (Maybe [Text]) Source #

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.