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

Description

 
Synopsis

Documentation

data Finding Source #

Provides the details of a finding.

See: newFinding smart constructor.

Constructors

Finding' 

Fields

  • accountId :: Maybe Text

    The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

  • archived :: Maybe Bool

    Specifies whether the finding is archived (suppressed).

  • category :: Maybe FindingCategory

    The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

  • classificationDetails :: Maybe ClassificationDetails

    The details of a sensitive data finding. This value is null for a policy finding.

  • count :: Maybe Integer

    The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

  • createdAt :: Maybe ISO8601

    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

  • description :: Maybe Text

    The description of the finding.

  • id :: Maybe Text

    The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

  • partition :: Maybe Text

    The Amazon Web Services partition that Amazon Macie created the finding in.

  • policyDetails :: Maybe PolicyDetails

    The details of a policy finding. This value is null for a sensitive data finding.

  • region :: Maybe Text

    The Amazon Web Services Region that Amazon Macie created the finding in.

  • resourcesAffected :: Maybe ResourcesAffected

    The resources that the finding applies to.

  • sample :: Maybe Bool

    Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

  • schemaVersion :: Maybe Text

    The version of the schema that was used to define the data structures in the finding.

  • severity :: Maybe Severity

    The severity level and score for the finding.

  • title :: Maybe Text

    The brief description of the finding.

  • type' :: Maybe FindingType

    The type of the finding.

  • updatedAt :: Maybe ISO8601

    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

Instances

Instances details
FromJSON Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Generic Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Associated Types

type Rep Finding :: Type -> Type #

Methods

from :: Finding -> Rep Finding x #

to :: Rep Finding x -> Finding #

Read Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Show Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

NFData Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Methods

rnf :: Finding -> () #

Eq Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Methods

(==) :: Finding -> Finding -> Bool #

(/=) :: Finding -> Finding -> Bool #

Hashable Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

Methods

hashWithSalt :: Int -> Finding -> Int #

hash :: Finding -> Int #

type Rep Finding Source # 
Instance details

Defined in Amazonka.MacieV2.Types.Finding

type Rep Finding = D1 ('MetaData "Finding" "Amazonka.MacieV2.Types.Finding" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "Finding'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "archived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingCategory)) :*: S1 ('MetaSel ('Just "classificationDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClassificationDetails)))) :*: ((S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "partition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "policyDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PolicyDetails)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourcesAffected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcesAffected)) :*: S1 ('MetaSel ('Just "sample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Severity))) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingType)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))))

newFinding :: Finding Source #

Create a value of Finding 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:accountId:Finding', finding_accountId - The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

$sel:archived:Finding', finding_archived - Specifies whether the finding is archived (suppressed).

$sel:category:Finding', finding_category - The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

$sel:classificationDetails:Finding', finding_classificationDetails - The details of a sensitive data finding. This value is null for a policy finding.

$sel:count:Finding', finding_count - The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

$sel:createdAt:Finding', finding_createdAt - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

Finding, finding_description - The description of the finding.

$sel:id:Finding', finding_id - The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

$sel:partition:Finding', finding_partition - The Amazon Web Services partition that Amazon Macie created the finding in.

$sel:policyDetails:Finding', finding_policyDetails - The details of a policy finding. This value is null for a sensitive data finding.

$sel:region:Finding', finding_region - The Amazon Web Services Region that Amazon Macie created the finding in.

$sel:resourcesAffected:Finding', finding_resourcesAffected - The resources that the finding applies to.

$sel:sample:Finding', finding_sample - Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

$sel:schemaVersion:Finding', finding_schemaVersion - The version of the schema that was used to define the data structures in the finding.

$sel:severity:Finding', finding_severity - The severity level and score for the finding.

$sel:title:Finding', finding_title - The brief description of the finding.

$sel:type':Finding', finding_type - The type of the finding.

$sel:updatedAt:Finding', finding_updatedAt - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

finding_accountId :: Lens' Finding (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

finding_archived :: Lens' Finding (Maybe Bool) Source #

Specifies whether the finding is archived (suppressed).

finding_category :: Lens' Finding (Maybe FindingCategory) Source #

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

finding_classificationDetails :: Lens' Finding (Maybe ClassificationDetails) Source #

The details of a sensitive data finding. This value is null for a policy finding.

finding_count :: Lens' Finding (Maybe Integer) Source #

The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

finding_createdAt :: Lens' Finding (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

finding_description :: Lens' Finding (Maybe Text) Source #

The description of the finding.

finding_id :: Lens' Finding (Maybe Text) Source #

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

finding_partition :: Lens' Finding (Maybe Text) Source #

The Amazon Web Services partition that Amazon Macie created the finding in.

finding_policyDetails :: Lens' Finding (Maybe PolicyDetails) Source #

The details of a policy finding. This value is null for a sensitive data finding.

finding_region :: Lens' Finding (Maybe Text) Source #

The Amazon Web Services Region that Amazon Macie created the finding in.

finding_resourcesAffected :: Lens' Finding (Maybe ResourcesAffected) Source #

The resources that the finding applies to.

finding_sample :: Lens' Finding (Maybe Bool) Source #

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

finding_schemaVersion :: Lens' Finding (Maybe Text) Source #

The version of the schema that was used to define the data structures in the finding.

finding_severity :: Lens' Finding (Maybe Severity) Source #

The severity level and score for the finding.

finding_title :: Lens' Finding (Maybe Text) Source #

The brief description of the finding.

finding_type :: Lens' Finding (Maybe FindingType) Source #

The type of the finding.

finding_updatedAt :: Lens' Finding (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.