NAME

Paws::SecurityHub::AwsSecurityFinding

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::SecurityHub::AwsSecurityFinding object:

$service_obj->Method(Att1 => { AwsAccountId => $value, ..., WorkflowState => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::SecurityHub::AwsSecurityFinding object:

$result = $service_obj->Method(...);
$result->Att1->AwsAccountId

DESCRIPTION

Provides consistent format for the contents of the Security Hub-aggregated findings. AwsSecurityFinding format enables you to share findings between AWS security services and third-party solutions, and compliance checks.

A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and compliance checks.

ATTRIBUTES

REQUIRED AwsAccountId => Str

The AWS account ID that a finding is generated in.

Compliance => Paws::SecurityHub::Compliance

This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains compliance-related finding details.

Confidence => Int

A finding's 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.

REQUIRED CreatedAt => Str

An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.

Criticality => Int

The level of importance assigned to the resources associated with the finding.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

REQUIRED Description => Str

A finding's description.

In this release, Description is a required property.

FirstObservedAt => Str

An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

REQUIRED GeneratorId => Str

The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

REQUIRED Id => Str

The security findings provider-specific identifier for a finding.

LastObservedAt => Str

An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

Malware => ArrayRef[Paws::SecurityHub::Malware]

A list of malware related to a finding.

Network => Paws::SecurityHub::Network

The details of network-related information about a finding.

Note => Paws::SecurityHub::Note

A user-defined note added to a finding.

Process => Paws::SecurityHub::ProcessDetails

The details of process-related information about a finding.

REQUIRED ProductArn => Str

The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

ProductFields => Paws::SecurityHub::FieldMap

A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

RecordState => Str

The record state of a finding.

RelatedFindings => ArrayRef[Paws::SecurityHub::RelatedFinding]

A list of related findings.

Remediation => Paws::SecurityHub::Remediation

A data type that describes the remediation options for a finding.

REQUIRED Resources => ArrayRef[Paws::SecurityHub::Resource]

A set of resource data types that describe the resources that the finding refers to.

REQUIRED SchemaVersion => Str

The schema version that a finding is formatted for.

REQUIRED Severity => Paws::SecurityHub::Severity

A finding's severity.

SourceUrl => Str

A URL that links to a page about the current finding in the security-findings provider's solution.

ThreatIntelIndicators => ArrayRef[Paws::SecurityHub::ThreatIntelIndicator]

Threat intelligence details related to a finding.

REQUIRED Title => Str

A finding's title.

In this release, Title is a required property.

REQUIRED Types => ArrayRef[Str|Undef]

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

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

REQUIRED UpdatedAt => Str

An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

UserDefinedFields => Paws::SecurityHub::FieldMap

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

VerificationState => Str

Indicates the veracity of a finding.

WorkflowState => Str

The workflow state of a finding.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::SecurityHub

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues