Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AwsSecurityFinding

import type { AwsSecurityFinding } from "https://aws-api.deno.dev/v0.4/services/securityhub.ts?docs=full";

Provides a consistent format for Security Hub findings. AwsSecurityFinding format allows you to share findings between Amazon Web Services security services and third-party solutions.

Note: A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party solutions and standards checks.

interface AwsSecurityFinding {

Action?: Action | null;

AwsAccountId: string;

CompanyName?: string | null;

Compliance?: Compliance | null;

Confidence?: number | null;

CreatedAt: string;

Criticality?: number | null;

Description: string;

FindingProviderFields?: FindingProviderFields | null;

FirstObservedAt?: string | null;

GeneratorId: string;

Id: string;

LastObservedAt?: string | null;

Malware?: Malware[] | null;

Network?: Network | null;

NetworkPath?: NetworkPathComponent[] | null;

Note?: Note | null;

PatchSummary?: PatchSummary | null;

Process?: ProcessDetails | null;

ProductArn: string;

ProductFields?: {

[key: string]: string | null | undefined;

} | null;

ProductName?: string | null;

RecordState?: RecordState | null;

Region?: string | null;

RelatedFindings?: RelatedFinding[] | null;

Remediation?: Remediation | null;

Resources: Resource[];

Sample?: boolean | null;

SchemaVersion: string;

Severity?: Severity | null;

SourceUrl?: string | null;

ThreatIntelIndicators?: ThreatIntelIndicator[] | null;

Threats?: Threat[] | null;

Title: string;

Types?: string[] | null;

UpdatedAt: string;

UserDefinedFields?: {

[key: string]: string | null | undefined;

} | null;

VerificationState?: VerificationState | null;

Vulnerabilities?: Vulnerability[] | null;

Workflow?: Workflow | null;

WorkflowState?: WorkflowState | null;

}

§Properties

Action?: Action | null

Provides details about an action that affects or that was taken on a resource.

AwsAccountId: string

The Amazon Web Services account ID that a finding is generated in.

CompanyName?: string | null

The name of the company for the product that generated the finding.

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

When you use the Security Hub console or API to filter findings by company name, you use this attribute.

Compliance?: Compliance | null

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

Confidence?: number | null

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.

CreatedAt: string

Indicates when the security-findings provider created the potential security issue that a finding captured.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Criticality?: number | null

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.

Description: string

A finding's description.

Note: In this release, Description is a required property.

FindingProviderFields?: FindingProviderFields | null

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.

FirstObservedAt?: string | null

Indicates when the security-findings provider first observed the potential security issue that a finding captured.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

GeneratorId: string

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 plugin, etc.

Id: string

The security findings provider-specific identifier for a finding.

LastObservedAt?: string | null

Indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Malware?: Malware[] | null

A list of malware related to a finding.

Network?: Network | null

The details of network-related information about a finding.

NetworkPath?: NetworkPathComponent[] | null

Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.

Note?: Note | null

A user-defined note added to a finding.

PatchSummary?: PatchSummary | null

Provides an overview of the patch compliance status for an instance against a selected compliance standard.

Process?: ProcessDetails | null

The details of process-related information about a finding.

ProductArn: string

The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

ProductFields?: {

[key: string]: string | null | undefined;

} | null

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

Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

ProductName?: string | null

The name of the product that generated the finding.

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

When you use the Security Hub console or API to filter findings by product name, you use this attribute.

RecordState?: RecordState | null

The record state of a finding.

Region?: string | null

The Region from which the finding was generated.

Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

RelatedFindings?: RelatedFinding[] | null

A list of related findings.

Remediation?: Remediation | null

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

Resources: Resource[]

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

Sample?: boolean | null

Indicates whether the finding is a sample finding.

SchemaVersion: string

The schema version that a finding is formatted for.

Severity?: Severity | null

A finding's severity.

SourceUrl?: string | null

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

ThreatIntelIndicators?: ThreatIntelIndicator[] | null

Threat intelligence details related to a finding.

Threats?: Threat[] | null

Details about the threat detected in a security finding and the file paths that were affected by the threat.

Title: string

A finding's title.

Note: In this release, Title is a required property.

Types?: string[] | null

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

UpdatedAt: string

Indicates when the security-findings provider last updated the finding record.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

UserDefinedFields?: {

[key: string]: string | null | undefined;

} | null

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

VerificationState?: VerificationState | null

Indicates the veracity of a finding.

Vulnerabilities?: Vulnerability[] | null

Provides a list of vulnerabilities associated with the findings.

Workflow?: Workflow | null

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

WorkflowState?: WorkflowState | null

The workflow state of a finding.