Struct Occurrences

#[non_exhaustive]
pub struct Occurrences {
    pub cells: Option<Vec<Cell>>,
    pub line_ranges: Option<Vec<Range>>,
    pub offset_ranges: Option<Vec<Range>>,
    pub pages: Option<Vec<Page>>,
    pub records: Option<Vec<Record>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cells: Option<Vec<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.

line_ranges: Option<Vec<Range>>

An array of objects, one for each occurrence of sensitive data in an email message or 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.

offset_ranges: Option<Vec<Range>>

Reserved for future use.

pages: Option<Vec<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: Option<Vec<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.

Implementations

impl Occurrences

pub fn cells(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cells.is_none().

pub fn line_ranges(&self) -> &[Range]

An array of objects, one for each occurrence of sensitive data in an email message or 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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .line_ranges.is_none().

pub fn offset_ranges(&self) -> &[Range]

Reserved for future use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .offset_ranges.is_none().

pub fn pages(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pages.is_none().

pub fn records(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .records.is_none().

impl Occurrences

pub fn builder() -> OccurrencesBuilder

Creates a new builder-style object to manufacture Occurrences.

Trait Implementations

impl Clone for Occurrences

fn clone(&self) -> Occurrences

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Occurrences

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Occurrences

fn eq(&self, other: &Occurrences) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Occurrences