Class: Aws::SecurityHub::Types::BatchUpdateFindingsRequest

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::BatchUpdateFindingsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #confidence ⇒ Integer

  The updated value for the finding confidence.

• #criticality ⇒ Integer

  The updated value for the level of importance assigned to the resources associated with the findings.

• #finding_identifiers ⇒ Array<Types::AwsSecurityFindingIdentifier>

  The list of findings to update.

• #note ⇒ Types::NoteUpdate

  The updated note.

• #related_findings ⇒ Array<Types::RelatedFinding>

  A list of findings that are related to the updated findings.

• #severity ⇒ Types::SeverityUpdate

  Used to update the finding severity.

• #types ⇒ Array<String>

  One or more finding types in the format of namespace/category/classifier that classify a finding.

• #user_defined_fields ⇒ Hash<String,String>

  A list of name/value string pairs associated with the finding.

• #verification_state ⇒ String

  Indicates the veracity of a finding.

• #workflow ⇒ Types::WorkflowUpdate

  Used to update the workflow status of a finding.

Instance Attribute Details

#confidence ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#criticality ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#finding_identifiers ⇒ Array<Types::AwsSecurityFindingIdentifier>

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.

Returns:

• (Array<Types::AwsSecurityFindingIdentifier>)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#note ⇒ Types::NoteUpdate

The updated note.

Returns:

• (Types::NoteUpdate)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#related_findings ⇒ Array<Types::RelatedFinding>

A list of findings that are related to the updated findings.

Returns:

• (Array<Types::RelatedFinding>)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ Types::SeverityUpdate

Used to update the finding severity.

Returns:

• (Types::SeverityUpdate)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#user_defined_fields ⇒ Hash<String,String>

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#verification_state ⇒ String

Indicates the veracity of a finding.

The available values for ‘VerificationState` are as follows.

• ‘UNKNOWN` – The default disposition of a security finding

• ‘TRUE_POSITIVE` – The security finding is confirmed

• ‘FALSE_POSITIVE` – The security finding was determined to be a false alarm

• ‘BENIGN_POSITIVE` – A special case of `TRUE_POSITIVE` where the finding doesn’t pose any threat, is expected, or both

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end

#workflow ⇒ Types::WorkflowUpdate

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Returns:

• (Types::WorkflowUpdate)

# File 'lib/aws-sdk-securityhub/types.rb', line 22772

class BatchUpdateFindingsRequest < Struct.new(
  :finding_identifiers,
  :note,
  :severity,
  :verification_state,
  :confidence,
  :criticality,
  :types,
  :user_defined_fields,
  :workflow,
  :related_findings)
  SENSITIVE = []
  include Aws::Structure
end