Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MacieV2.Types.Record

Description

Synopsis

data Record = Record' {
- jsonPath :: Maybe Text
- recordIndex :: Maybe Integer
}
newRecord :: Record
record_jsonPath :: Lens' Record (Maybe Text)
record_recordIndex :: Lens' Record (Maybe Integer)

Documentation

data Record Source #

Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.

See: newRecord smart constructor.

Constructors

Record'

Fields

jsonPath :: Maybe Text
The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
recordIndex :: Maybe Integer
For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

Instances

Instances details

Eq Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods (==) :: Record -> Record -> Bool # (/=) :: Record -> Record -> Bool #
Read Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods readsPrec :: Int -> ReadS Record # readList :: ReadS [Record] # readPrec :: ReadPrec Record # readListPrec :: ReadPrec [Record] #
Show Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods showsPrec :: Int -> Record -> ShowS # show :: Record -> String # showList :: [Record] -> ShowS #
Generic Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Associated Types type Rep Record :: Type -> Type # Methods from :: Record -> Rep Record x # to :: Rep Record x -> Record #
NFData Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods rnf :: Record -> () #
Hashable Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods hashWithSalt :: Int -> Record -> Int # hash :: Record -> Int #
FromJSON Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record Methods parseJSON :: Value -> Parser Record # parseJSONList :: Value -> Parser [Record] #
type Rep Record Source #
Instance details Defined in Amazonka.MacieV2.Types.Record type Rep Record = D1 ('MetaData "Record" "Amazonka.MacieV2.Types.Record" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "Record'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jsonPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recordIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

newRecord :: Record Source #

Create a value of Record 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:jsonPath:Record', record_jsonPath - The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

$sel:recordIndex:Record', record_recordIndex - For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

record_jsonPath :: Lens' Record (Maybe Text) Source #

The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

record_recordIndex :: Lens' Record (Maybe Integer) Source #

For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.