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

Description

 
Synopsis

Documentation

data Occurrences Source #

Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

See: newOccurrences smart constructor.

Constructors

Occurrences' 

Fields

  • cells :: Maybe [Cell]

    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

    Each Cell object specifies a cell or field that contains the sensitive data.

  • lineRanges :: Maybe [Range]

    An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

  • offsetRanges :: Maybe [Range]

    Reserved for future use.

  • pages :: Maybe [Page]

    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

    Each Page object specifies a page that contains the sensitive data.

  • records :: Maybe [Record]

    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

    For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

Instances

Instances details
FromJSON Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

Generic Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

Associated Types

type Rep Occurrences :: Type -> Type #

Read Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

Show Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

NFData Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

Methods

rnf :: Occurrences -> () #

Eq Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

Hashable Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

type Rep Occurrences Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Occurrences

type Rep Occurrences = D1 ('MetaData "Occurrences" "Amazonka.MacieV2.Types.Occurrences" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "Occurrences'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cell])) :*: S1 ('MetaSel ('Just "lineRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Range]))) :*: (S1 ('MetaSel ('Just "offsetRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Range])) :*: (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Page])) :*: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Record]))))))

newOccurrences :: Occurrences Source #

Create a value of Occurrences 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:cells:Occurrences', occurrences_cells - An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

$sel:lineRanges:Occurrences', occurrences_lineRanges - An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

$sel:offsetRanges:Occurrences', occurrences_offsetRanges - Reserved for future use.

$sel:pages:Occurrences', occurrences_pages - An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

$sel:records:Occurrences', occurrences_records - An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

occurrences_cells :: Lens' Occurrences (Maybe [Cell]) Source #

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

occurrences_lineRanges :: Lens' Occurrences (Maybe [Range]) Source #

An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

occurrences_pages :: Lens' Occurrences (Maybe [Page]) Source #

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

occurrences_records :: Lens' Occurrences (Maybe [Record]) Source #

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.