Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings
do not affect the value of
UpdatedAt
for a finding.
Administrator and member accounts can use BatchUpdateFindings
to
update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
Synopsis
- data BatchUpdateFindings = BatchUpdateFindings' {
- criticality :: Maybe Natural
- note :: Maybe NoteUpdate
- severity :: Maybe SeverityUpdate
- types :: Maybe [Text]
- relatedFindings :: Maybe [RelatedFinding]
- confidence :: Maybe Natural
- workflow :: Maybe WorkflowUpdate
- verificationState :: Maybe VerificationState
- userDefinedFields :: Maybe (HashMap Text Text)
- findingIdentifiers :: [AwsSecurityFindingIdentifier]
- newBatchUpdateFindings :: BatchUpdateFindings
- batchUpdateFindings_criticality :: Lens' BatchUpdateFindings (Maybe Natural)
- batchUpdateFindings_note :: Lens' BatchUpdateFindings (Maybe NoteUpdate)
- batchUpdateFindings_severity :: Lens' BatchUpdateFindings (Maybe SeverityUpdate)
- batchUpdateFindings_types :: Lens' BatchUpdateFindings (Maybe [Text])
- batchUpdateFindings_relatedFindings :: Lens' BatchUpdateFindings (Maybe [RelatedFinding])
- batchUpdateFindings_confidence :: Lens' BatchUpdateFindings (Maybe Natural)
- batchUpdateFindings_workflow :: Lens' BatchUpdateFindings (Maybe WorkflowUpdate)
- batchUpdateFindings_verificationState :: Lens' BatchUpdateFindings (Maybe VerificationState)
- batchUpdateFindings_userDefinedFields :: Lens' BatchUpdateFindings (Maybe (HashMap Text Text))
- batchUpdateFindings_findingIdentifiers :: Lens' BatchUpdateFindings [AwsSecurityFindingIdentifier]
- data BatchUpdateFindingsResponse = BatchUpdateFindingsResponse' {}
- newBatchUpdateFindingsResponse :: Int -> BatchUpdateFindingsResponse
- batchUpdateFindingsResponse_httpStatus :: Lens' BatchUpdateFindingsResponse Int
- batchUpdateFindingsResponse_processedFindings :: Lens' BatchUpdateFindingsResponse [AwsSecurityFindingIdentifier]
- batchUpdateFindingsResponse_unprocessedFindings :: Lens' BatchUpdateFindingsResponse [BatchUpdateFindingsUnprocessedFinding]
Creating a Request
data BatchUpdateFindings Source #
See: newBatchUpdateFindings
smart constructor.
BatchUpdateFindings' | |
|
Instances
newBatchUpdateFindings :: BatchUpdateFindings Source #
Create a value of BatchUpdateFindings
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:criticality:BatchUpdateFindings'
, batchUpdateFindings_criticality
- The updated value for the level of importance assigned to the resources
associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
$sel:note:BatchUpdateFindings'
, batchUpdateFindings_note
- Undocumented member.
$sel:severity:BatchUpdateFindings'
, batchUpdateFindings_severity
- Used to update the finding severity.
$sel:types:BatchUpdateFindings'
, batchUpdateFindings_types
- One or more finding types in the format of
namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
- Software and Configuration Checks
- TTPs
- Effects
- Unusual Behaviors
- Sensitive Data Identifications
$sel:relatedFindings:BatchUpdateFindings'
, batchUpdateFindings_relatedFindings
- A list of findings that are related to the updated findings.
$sel:confidence:BatchUpdateFindings'
, batchUpdateFindings_confidence
- The updated value for the finding confidence. Confidence is defined as
the likelihood that a finding accurately identifies the behavior or
issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
$sel:workflow:BatchUpdateFindings'
, batchUpdateFindings_workflow
- Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
$sel:verificationState:BatchUpdateFindings'
, batchUpdateFindings_verificationState
- Indicates the veracity of a finding.
The available values for VerificationState
are as follows.
UNKNOWN
– The default disposition of a security findingTRUE_POSITIVE
– The security finding is confirmedFALSE_POSITIVE
– The security finding was determined to be a false alarmBENIGN_POSITIVE
– A special case ofTRUE_POSITIVE
where the finding doesn't pose any threat, is expected, or both
$sel:userDefinedFields:BatchUpdateFindings'
, batchUpdateFindings_userDefinedFields
- A list of name/value string pairs associated with the finding. These
are custom, user-defined fields added to a finding.
$sel:findingIdentifiers:BatchUpdateFindings'
, batchUpdateFindings_findingIdentifiers
- The list of findings to update. BatchUpdateFindings
can be used to
update up to 100 findings at a time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
Request Lenses
batchUpdateFindings_criticality :: Lens' BatchUpdateFindings (Maybe Natural) Source #
The updated value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
batchUpdateFindings_note :: Lens' BatchUpdateFindings (Maybe NoteUpdate) Source #
Undocumented member.
batchUpdateFindings_severity :: Lens' BatchUpdateFindings (Maybe SeverityUpdate) Source #
Used to update the finding severity.
batchUpdateFindings_types :: Lens' BatchUpdateFindings (Maybe [Text]) Source #
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
- Software and Configuration Checks
- TTPs
- Effects
- Unusual Behaviors
- Sensitive Data Identifications
batchUpdateFindings_relatedFindings :: Lens' BatchUpdateFindings (Maybe [RelatedFinding]) Source #
A list of findings that are related to the updated findings.
batchUpdateFindings_confidence :: Lens' BatchUpdateFindings (Maybe Natural) Source #
The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
batchUpdateFindings_workflow :: Lens' BatchUpdateFindings (Maybe WorkflowUpdate) Source #
Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
batchUpdateFindings_verificationState :: Lens' BatchUpdateFindings (Maybe VerificationState) Source #
Indicates the veracity of a finding.
The available values for VerificationState
are as follows.
UNKNOWN
– The default disposition of a security findingTRUE_POSITIVE
– The security finding is confirmedFALSE_POSITIVE
– The security finding was determined to be a false alarmBENIGN_POSITIVE
– A special case ofTRUE_POSITIVE
where the finding doesn't pose any threat, is expected, or both
batchUpdateFindings_userDefinedFields :: Lens' BatchUpdateFindings (Maybe (HashMap Text Text)) Source #
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
batchUpdateFindings_findingIdentifiers :: Lens' BatchUpdateFindings [AwsSecurityFindingIdentifier] Source #
The list of findings to update. BatchUpdateFindings
can be used to
update up to 100 findings at a time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
Destructuring the Response
data BatchUpdateFindingsResponse Source #
See: newBatchUpdateFindingsResponse
smart constructor.
BatchUpdateFindingsResponse' | |
|
Instances
newBatchUpdateFindingsResponse Source #
Create a value of BatchUpdateFindingsResponse
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:httpStatus:BatchUpdateFindingsResponse'
, batchUpdateFindingsResponse_httpStatus
- The response's http status code.
$sel:processedFindings:BatchUpdateFindingsResponse'
, batchUpdateFindingsResponse_processedFindings
- The list of findings that were updated successfully.
$sel:unprocessedFindings:BatchUpdateFindingsResponse'
, batchUpdateFindingsResponse_unprocessedFindings
- The list of findings that were not updated.
Response Lenses
batchUpdateFindingsResponse_httpStatus :: Lens' BatchUpdateFindingsResponse Int Source #
The response's http status code.
batchUpdateFindingsResponse_processedFindings :: Lens' BatchUpdateFindingsResponse [AwsSecurityFindingIdentifier] Source #
The list of findings that were updated successfully.
batchUpdateFindingsResponse_unprocessedFindings :: Lens' BatchUpdateFindingsResponse [BatchUpdateFindingsUnprocessedFinding] Source #
The list of findings that were not updated.