AwsSecurityFinding

The AWS account ID that a finding is generated in.

Length Constraints: 12.

Type: String

Pattern: .*\S.*

Required: Yes

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

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats that you can send to Security Hub:

If a finding provider sends a finding to Security Hub that contains a timestamp in nanoseconds, we round it to milliseconds. For example, we round 2024-10-31T23:00:00.123456789Z to 2024-10-31T23:00:00.123Z.

Type: String

Pattern: .*\S.*

Required: Yes

A finding's description. Description is a required property.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Type: String

Pattern: .*\S.*

Required: Yes

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, or something else.

Length Constraints: Minimum length of 1. Maximum length of 512.

Type: String

Pattern: .*\S.*

Required: Yes

The security findings provider-specific identifier for a finding.

Length Constraints: Minimum length of 1. Maximum length of 512.

Type: String

Pattern: .*\S.*

Required: Yes

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.

Length Constraints: Minimum length of 12. Maximum length of 2048.

Type: String

Pattern: .*\S.*

Required: Yes

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

Array Members: Minimum number of 1 item. Maximum number of 32 items.

Type: Array of Resource objects

Required: Yes

The schema version that a finding is formatted for. The value is 2018-10-08.

Type: String

Pattern: .*\S.*

Required: Yes

A finding's title. Title is a required property.

Length Constraints: Minimum length of 1. Maximum length of 256.

Type: String

Pattern: .*\S.*

Required: Yes

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

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats that you can send to Security Hub:

If a finding provider sends a finding to Security Hub that contains a timestamp in nanoseconds, we round it to milliseconds. For example, we round 2024-10-31T23:00:00.123456789Z to 2024-10-31T23:00:00.123Z.

Type: String

Pattern: .*\S.*

Required: Yes

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

Type: Action object

Required: No

The name of the AWS account from which a finding was generated.

Length Constraints: Minimum length of 1. Maximum length of 50.

Type: String

Pattern: .*\S.*

Required: No

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.

Length Constraints: Minimum length of 1. Maximum length of 128.

Type: String

Pattern: .*\S.*

Required: No

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 AWS Foundations. Contains security standard-related finding details.

Type: Compliance object

Required: No

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.

Type: Integer

Required: No

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.

Type: Integer

Required: No

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

Type: FindingProviderFields object

Required: No

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

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats that you can send to Security Hub:

If a finding provider sends a finding to Security Hub that contains a timestamp in nanoseconds, we round it to milliseconds. For example, we round 2024-10-31T23:00:00.123456789Z to 2024-10-31T23:00:00.123Z.

Type: String

Pattern: .*\S.*

Required: No

Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to AWS Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. AWS Security Hub receives those findings.

Type: GeneratorDetails object

Required: No

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

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats that you can send to Security Hub:

If a finding provider sends a finding to Security Hub that contains a timestamp in nanoseconds, we round it to milliseconds. For example, we round 2024-10-31T23:00:00.123456789Z to 2024-10-31T23:00:00.123Z.

Type: String

Pattern: .*\S.*

Required: No

A list of malware related to a finding.

Array Members: Maximum number of 5 items.

Type: Array of Malware objects

Required: No

The details of network-related information about a finding.

Type: Network object

Required: No

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

Type: Array of NetworkPathComponent objects

Required: No

A user-defined note added to a finding.

Type: Note object

Required: No

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

Type: PatchSummary object

Required: No

The details of process-related information about a finding.

Type: ProcessDetails object

Required: No

A timestamp that indicates when AWS Security Hub received a finding and begins to process it.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats that you can send to Security Hub:

If a finding provider sends a finding to Security Hub that contains a timestamp in nanoseconds, we round it to milliseconds. For example, we round 2024-10-31T23:00:00.123456789Z to 2024-10-31T23:00:00.123Z.

Type: String

Pattern: .*\S.*

Required: No

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.

Type: String to string map

Key Pattern: .*\S.*

Value Pattern: .*\S.*

Required: No

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.

Length Constraints: Minimum length of 1. Maximum length of 128.

Type: String

Pattern: .*\S.*

Required: No

The record state of a finding.

Type: String

Valid Values: ACTIVE | ARCHIVED

Required: No

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.

Length Constraints: Minimum length of 1. Maximum length of 16.

Type: String

Pattern: .*\S.*

Required: No

A list of related findings.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Type: Array of RelatedFinding objects

Required: No

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

Type: Remediation object

Required: No

Indicates whether the finding is a sample finding.

Type: Boolean

Required: No

A finding's severity.

Type: Severity object

Required: No

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

Type: String

Pattern: .*\S.*

Required: No

Threat intelligence details related to a finding.

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Type: Array of ThreatIntelIndicator objects

Required: No

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

Array Members: Minimum number of 1 item. Maximum number of 32 items.

Type: Array of Threat objects

Required: No

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

Array Members: Maximum number of 50 items.

Type: Array of strings

Pattern: .*\S.*

Required: No

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

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 1024 characters.

Type: String to string map

Key Pattern: .*\S.*

Value Pattern: .*\S.*

Required: No

Indicates the veracity of a finding.

Type: String

Valid Values: UNKNOWN | TRUE_POSITIVE | FALSE_POSITIVE | BENIGN_POSITIVE

Required: No

Provides a list of vulnerabilities associated with the findings.

Type: Array of Vulnerability objects

Required: No

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

Type: Workflow object

Required: No

This member has been deprecated.

The workflow state of a finding.

Type: String

Valid Values: NEW | ASSIGNED | IN_PROGRESS | DEFERRED | RESOLVED

Required: No