AutomationRulesFindingFilters - AWS Security Hub
ContentsSee Also

AutomationRulesFindingFilters

The criteria that determine which findings a rule applies to.

Contents

AwsAccountId

The AWS account ID in which a finding was generated.

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

Type: Array of StringFilter objects

Required: No

AwsAccountName

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

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

Type: Array of StringFilter objects

Required: No

CompanyName

The name of the company for the product that generated the finding. For control-based findings, the company is AWS.

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

Type: Array of StringFilter objects

Required: No

ComplianceAssociatedStandardsId

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

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

Type: Array of StringFilter objects

Required: No

ComplianceSecurityControlId

The security control ID for which a finding was generated. Security control IDs are the same across standards.

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

Type: Array of StringFilter objects

Required: No

ComplianceStatus

The result of a security check. This field is only used for findings generated from controls.

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

Type: Array of StringFilter objects

Required: No

Confidence

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. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the AWS Security Hub User Guide.

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

Type: Array of NumberFilter objects

Required: No

CreatedAt

A timestamp that indicates when this finding record was created.

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 with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

Type: Array of DateFilter objects

Required: No

Criticality

The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the AWS Security Hub User Guide.

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

Type: Array of NumberFilter objects

Required: No

Description

A finding's description.

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

Type: Array of StringFilter objects

Required: No

FirstObservedAt

A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.

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 with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

Type: Array of DateFilter objects

Required: No

GeneratorId

The identifier for the solution-specific component that generated a finding.

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

Type: Array of StringFilter objects

Required: No

Id

The product-specific identifier for a finding.

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

Type: Array of StringFilter objects

Required: No

LastObservedAt

A timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings product.

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 with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

Type: Array of DateFilter objects

Required: No

NoteText

The text of a user-defined note that's added to a finding.

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

Type: Array of StringFilter objects

Required: No

NoteUpdatedAt

The timestamp of when the note was updated.

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 with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

Type: Array of DateFilter objects

Required: No

NoteUpdatedBy

The principal that created a note.

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

Type: Array of StringFilter objects

Required: No

ProductArn

The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

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

Type: Array of StringFilter objects

Required: No

ProductName

Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

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

Type: Array of StringFilter objects

Required: No

RecordState

Provides the current state of a finding.

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

Type: Array of StringFilter objects

Required: No

RelatedFindingsId

The product-generated identifier for a related finding.

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

Type: Array of StringFilter objects

Required: No

RelatedFindingsProductArn

The ARN for the product that generated a related finding.

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

Type: Array of StringFilter objects

Required: No

ResourceApplicationArn

The Amazon Resource Name (ARN) of the application that is related to a finding.

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

Type: Array of StringFilter objects

Required: No

ResourceApplicationName

The name of the application that is related to a finding.

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

Type: Array of StringFilter objects

Required: No

ResourceDetailsOther

Custom fields and values about the resource that a finding pertains to.

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

Type: Array of MapFilter objects

Required: No

ResourceId

The identifier for the given resource type. For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS service that created the resource. For non-AWS resources, this is a unique identifier that is associated with the resource.

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

Type: Array of StringFilter objects

Required: No

ResourcePartition

The partition in which the resource that the finding pertains to is located. A partition is a group of AWS Regions. Each AWS account is scoped to one partition.

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

Type: Array of StringFilter objects

Required: No

ResourceRegion

The AWS Region where the resource that a finding pertains to is located.

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

Type: Array of StringFilter objects

Required: No

ResourceTags

A list of AWS tags associated with a resource at the time the finding was processed.

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

Type: Array of MapFilter objects

Required: No

ResourceType

The type of resource that the finding pertains to.

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

Type: Array of StringFilter objects

Required: No

SeverityLabel

The severity value of the finding.

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

Type: Array of StringFilter objects

Required: No

SourceUrl

Provides a URL that links to a page about the current finding in the finding product.

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

Type: Array of StringFilter objects

Required: No

Title

A finding's title.

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

Type: Array of StringFilter objects

Required: No

Type

One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the AWS Security Hub User Guide.

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

Type: Array of StringFilter objects

Required: No

UpdatedAt

A timestamp that indicates when the finding record was most recently updated.

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 with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

Type: Array of DateFilter objects

Required: No

UserDefinedFields

A list of user-defined name and value string pairs added to a finding.

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

Type: Array of MapFilter objects

Required: No

VerificationState

Provides the veracity of a finding.

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

Type: Array of StringFilter objects

Required: No

WorkflowStatus

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

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

Type: Array of StringFilter objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: