Amazonka.MacieV2.Types.Record

Documentation

data Record

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

FromJSON Record

Defined in Amazonka.MacieV2.Types.Record

Methods

parseJSON :: Value -> Parser Record

parseJSONList :: Value -> Parser [Record]

Generic Record

Defined in Amazonka.MacieV2.Types.Record

Associated Types

type Rep Record :: Type -> Type

Methods

from :: Record -> Rep Record x

to :: Rep Record x -> Record

Read Record

Defined in Amazonka.MacieV2.Types.Record

Methods

readsPrec :: Int -> ReadS Record

readList :: ReadS [Record]

readPrec :: ReadPrec Record

readListPrec :: ReadPrec [Record]

Show Record

Defined in Amazonka.MacieV2.Types.Record

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

NFData Record

Defined in Amazonka.MacieV2.Types.Record

Methods

rnf :: Record -> ()

Eq Record

Defined in Amazonka.MacieV2.Types.Record

Methods

(==) :: Record -> Record -> Bool

(/=) :: Record -> Record -> Bool

Hashable Record

Defined in Amazonka.MacieV2.Types.Record

Methods

hashWithSalt :: Int -> Record -> Int

hash :: Record -> Int

type Rep Record

Defined in Amazonka.MacieV2.Types.Record

type Rep Record = D1 ('MetaData "Record" "Amazonka.MacieV2.Types.Record" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" '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

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)

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)

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.