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

Description

 
Synopsis

Documentation

data Detection Source #

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.

See: newDetection smart constructor.

Constructors

Detection' 

Fields

  • arn :: Maybe Text

    If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

  • count :: Maybe Integer

    The total number of occurrences of the sensitive data.

  • id :: Maybe Text

    The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

  • name :: Maybe Text

    The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

  • suppressed :: Maybe Bool

    Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

  • type' :: Maybe DataIdentifierType

    The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

Instances

Instances details
FromJSON Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

Generic Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

Associated Types

type Rep Detection :: Type -> Type #

Read Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

Show Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

NFData Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

Methods

rnf :: Detection -> () #

Eq Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

Hashable Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

type Rep Detection Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Detection

newDetection :: Detection Source #

Create a value of Detection 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:arn:Detection', detection_arn - If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

$sel:count:Detection', detection_count - The total number of occurrences of the sensitive data.

$sel:id:Detection', detection_id - The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

$sel:name:Detection', detection_name - The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

$sel:suppressed:Detection', detection_suppressed - Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

$sel:type':Detection', detection_type - The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

detection_arn :: Lens' Detection (Maybe Text) Source #

If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

detection_count :: Lens' Detection (Maybe Integer) Source #

The total number of occurrences of the sensitive data.

detection_id :: Lens' Detection (Maybe Text) Source #

The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

detection_name :: Lens' Detection (Maybe Text) Source #

The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

detection_suppressed :: Lens' Detection (Maybe Bool) Source #

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

detection_type :: Lens' Detection (Maybe DataIdentifierType) Source #

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.