libZSservicesZSamazonka-securityhubZSamazonka-securityhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecurityHub.Types.Workflow

Description

 
Synopsis

Documentation

data Workflow Source #

Provides information about the status of the investigation into a finding.

See: newWorkflow smart constructor.

Constructors

Workflow' 

Fields

  • status :: Maybe WorkflowStatus

    The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

    The allowed values are the following.

    • NEW - The initial state of a finding, before it is reviewed.

      Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

      • RecordState changes from ARCHIVED to ACTIVE.
      • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
    • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
    • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
    • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

Instances

Instances details
Eq Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Read Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Show Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Generic Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Associated Types

type Rep Workflow :: Type -> Type #

Methods

from :: Workflow -> Rep Workflow x #

to :: Rep Workflow x -> Workflow #

NFData Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Methods

rnf :: Workflow -> () #

Hashable Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

Methods

hashWithSalt :: Int -> Workflow -> Int #

hash :: Workflow -> Int #

ToJSON Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

FromJSON Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

type Rep Workflow Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.Workflow

type Rep Workflow = D1 ('MetaData "Workflow" "Amazonka.SecurityHub.Types.Workflow" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "Workflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStatus))))

newWorkflow :: Workflow Source #

Create a value of Workflow 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:status:Workflow', workflow_status - The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

The allowed values are the following.

  • NEW - The initial state of a finding, before it is reviewed.

    Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

    • RecordState changes from ARCHIVED to ACTIVE.
    • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
  • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
  • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
  • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

workflow_status :: Lens' Workflow (Maybe WorkflowStatus) Source #

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

The allowed values are the following.

  • NEW - The initial state of a finding, before it is reviewed.

    Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

    • RecordState changes from ARCHIVED to ACTIVE.
    • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
  • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
  • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
  • RESOLVED - The finding was reviewed and remediated and is now considered resolved.