[ aws . securityhub ]
Lists and describes insights for the specified insight ARNs.
See also: AWS API Documentation
get-insights
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Insights
get-insights
[--insight-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--insight-arns
(list)
The ARNs of the insights to describe. If you do not provide any insight ARNs, then
GetInsights
returns all of your custom insights. It does not return any managed insights.(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To retrieve details about an insight
The following get-insights
example retrieves the configuration details for the insight with the specified ARN.
aws securityhub get-insights \
--insight-arns "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
Output:
{
"Insights": [
{
"Filters": {
"ResourceType": [
{
"Comparison": "EQUALS",
"Value": "AwsIamRole"
}
],
"SeverityLabel": [
{
"Comparison": "EQUALS",
"Value": "CRITICAL"
}
],
},
"GroupByAttribute": "ResourceId",
"InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Name": "Critical role findings"
}
]
}
For more information, see Insights in AWS Security Hub in the AWS Security Hub User Guide.
Insights -> (list)
The insights returned by the operation.
(structure)
Contains information about a Security Hub insight.
InsightArn -> (string)
The ARN of a Security Hub insight.
Name -> (string)
The name of a Security Hub insight.
Filters -> (structure)
One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
ProductArn -> (list)
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.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
AwsAccountId -> (list)
The Amazon Web Services account ID that a finding is generated in.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Id -> (list)
The security findings provider-specific identifier for a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
GeneratorId -> (list)
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.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Region -> (list)
The Region from which the finding was generated.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Type -> (list)
A finding type in the format of
namespace/category/classifier
that classifies a finding.(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
FirstObservedAt -> (list)
An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
LastObservedAt -> (list)
An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
CreatedAt -> (list)
An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
UpdatedAt -> (list)
An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
SeverityProduct -> (list)
The native severity as defined by the security-findings provider’s solution that generated the finding.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
SeverityNormalized -> (list)
The normalized severity of a finding.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
SeverityLabel -> (list)
The label of a finding’s severity.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Confidence -> (list)
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.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
Criticality -> (list)
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.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
Title -> (list)
A finding’s title.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Description -> (list)
A finding’s description.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
RecommendationText -> (list)
The recommendation of what to do about the issue described in a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
SourceUrl -> (list)
A URL that links to a page about the current finding in the security-findings provider’s solution.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ProductFields -> (list)
A data type where security-findings providers can include additional solution-specific details that aren’t part of the defined
AwsSecurityFinding
format.(structure)
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
Key -> (string)
The key of the map filter. For example, for
ResourceTags
,Key
identifies the name of the tag. ForUserDefinedFields
,Key
is the name of the field.Value -> (string)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called
Department
might beSecurity
. If you providesecurity
as the filter value, then there is no match.Comparison -> (string)
The condition to apply to the key value when querying for findings with a map filter.
To search for values that exactly match the filter value, use
EQUALS
. For example, for theResourceTags
field, the filterDepartment EQUALS Security
matches findings that have the valueSecurity
for the tagDepartment
.To search for values other than the filter value, use
NOT_EQUALS
. For example, for theResourceTags
field, the filterDepartment NOT_EQUALS Finance
matches findings that do not have the valueFinance
for the tagDepartment
.
EQUALS
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.
NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.You cannot have both an
EQUALS
filter and aNOT_EQUALS
filter on the same field.ProductName -> (list)
The name of the solution (product) that generates findings.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
CompanyName -> (list)
The name of the findings provider (company) that owns the solution (product) that generates findings.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
UserDefinedFields -> (list)
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
(structure)
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
Key -> (string)
The key of the map filter. For example, for
ResourceTags
,Key
identifies the name of the tag. ForUserDefinedFields
,Key
is the name of the field.Value -> (string)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called
Department
might beSecurity
. If you providesecurity
as the filter value, then there is no match.Comparison -> (string)
The condition to apply to the key value when querying for findings with a map filter.
To search for values that exactly match the filter value, use
EQUALS
. For example, for theResourceTags
field, the filterDepartment EQUALS Security
matches findings that have the valueSecurity
for the tagDepartment
.To search for values other than the filter value, use
NOT_EQUALS
. For example, for theResourceTags
field, the filterDepartment NOT_EQUALS Finance
matches findings that do not have the valueFinance
for the tagDepartment
.
EQUALS
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.
NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.You cannot have both an
EQUALS
filter and aNOT_EQUALS
filter on the same field.MalwareName -> (list)
The name of the malware that was observed.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
MalwareType -> (list)
The type of the malware that was observed.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
MalwarePath -> (list)
The filesystem path of the malware that was observed.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
MalwareState -> (list)
The state of the malware that was observed.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NetworkDirection -> (list)
Indicates the direction of network traffic associated with a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NetworkProtocol -> (list)
The protocol of network-related information about a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NetworkSourceIpV4 -> (list)
The source IPv4 address of network-related information about a finding.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
NetworkSourceIpV6 -> (list)
The source IPv6 address of network-related information about a finding.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
NetworkSourcePort -> (list)
The source port of network-related information about a finding.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
NetworkSourceDomain -> (list)
The source domain of network-related information about a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NetworkSourceMac -> (list)
The source media access control (MAC) address of network-related information about a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NetworkDestinationIpV4 -> (list)
The destination IPv4 address of network-related information about a finding.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
NetworkDestinationIpV6 -> (list)
The destination IPv6 address of network-related information about a finding.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
NetworkDestinationPort -> (list)
The destination port of network-related information about a finding.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
NetworkDestinationDomain -> (list)
The destination domain of network-related information about a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ProcessName -> (list)
The name of the process.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ProcessPath -> (list)
The path to the process executable.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ProcessPid -> (list)
The process ID.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
ProcessParentPid -> (list)
The parent process ID.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
ProcessLaunchedAt -> (list)
The date/time that the process was launched.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ProcessTerminatedAt -> (list)
The date/time that the process was terminated.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ThreatIntelIndicatorType -> (list)
The type of a threat intelligence indicator.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ThreatIntelIndicatorValue -> (list)
The value of a threat intelligence indicator.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ThreatIntelIndicatorCategory -> (list)
The category of a threat intelligence indicator.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ThreatIntelIndicatorLastObservedAt -> (list)
The date/time of the last observation of a threat intelligence indicator.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ThreatIntelIndicatorSource -> (list)
The source of the threat intelligence.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ThreatIntelIndicatorSourceUrl -> (list)
The URL for more details from the source of the threat intelligence.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceType -> (list)
Specifies the type of the resource that details are provided for.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceId -> (list)
The canonical identifier for the given resource type.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourcePartition -> (list)
The canonical Amazon Web Services partition name that the Region is assigned to.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceRegion -> (list)
The canonical Amazon Web Services external Region name where this resource is located.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceTags -> (list)
A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
(structure)
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
Key -> (string)
The key of the map filter. For example, for
ResourceTags
,Key
identifies the name of the tag. ForUserDefinedFields
,Key
is the name of the field.Value -> (string)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called
Department
might beSecurity
. If you providesecurity
as the filter value, then there is no match.Comparison -> (string)
The condition to apply to the key value when querying for findings with a map filter.
To search for values that exactly match the filter value, use
EQUALS
. For example, for theResourceTags
field, the filterDepartment EQUALS Security
matches findings that have the valueSecurity
for the tagDepartment
.To search for values other than the filter value, use
NOT_EQUALS
. For example, for theResourceTags
field, the filterDepartment NOT_EQUALS Finance
matches findings that do not have the valueFinance
for the tagDepartment
.
EQUALS
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.
NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.You cannot have both an
EQUALS
filter and aNOT_EQUALS
filter on the same field.ResourceAwsEc2InstanceType -> (list)
The instance type of the instance.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceImageId -> (list)
The Amazon Machine Image (AMI) ID of the instance.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceIpV4Addresses -> (list)
The IPv4 addresses associated with the instance.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
ResourceAwsEc2InstanceIpV6Addresses -> (list)
The IPv6 addresses associated with the instance.
(structure)
The IP filter for querying findings.
Cidr -> (string)
A finding’s CIDR value.
ResourceAwsEc2InstanceKeyName -> (list)
The key name associated with the instance.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceIamInstanceProfileArn -> (list)
The IAM profile ARN of the instance.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceVpcId -> (list)
The identifier of the VPC that the instance was launched in.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceSubnetId -> (list)
The identifier of the subnet that the instance was launched in.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsEc2InstanceLaunchedAt -> (list)
The date and time the instance was launched.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ResourceAwsS3BucketOwnerId -> (list)
The canonical user ID of the owner of the S3 bucket.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsS3BucketOwnerName -> (list)
The display name of the owner of the S3 bucket.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsIamAccessKeyUserName -> (list)
The user associated with the IAM access key related to a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsIamAccessKeyPrincipalName -> (list)
The name of the principal that is associated with an IAM access key.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsIamAccessKeyStatus -> (list)
The status of the IAM access key related to a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceAwsIamAccessKeyCreatedAt -> (list)
The creation date/time of the IAM access key related to a finding.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ResourceAwsIamUserUserName -> (list)
The name of an IAM user.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceContainerName -> (list)
The name of the container related to a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceContainerImageId -> (list)
The identifier of the image related to a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceContainerImageName -> (list)
The name of the image related to a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
ResourceContainerLaunchedAt -> (list)
The date/time that the container was started.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
ResourceDetailsOther -> (list)
The details of a resource that doesn’t have a specific subfield for the resource type defined.
(structure)
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
Key -> (string)
The key of the map filter. For example, for
ResourceTags
,Key
identifies the name of the tag. ForUserDefinedFields
,Key
is the name of the field.Value -> (string)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called
Department
might beSecurity
. If you providesecurity
as the filter value, then there is no match.Comparison -> (string)
The condition to apply to the key value when querying for findings with a map filter.
To search for values that exactly match the filter value, use
EQUALS
. For example, for theResourceTags
field, the filterDepartment EQUALS Security
matches findings that have the valueSecurity
for the tagDepartment
.To search for values other than the filter value, use
NOT_EQUALS
. For example, for theResourceTags
field, the filterDepartment NOT_EQUALS Finance
matches findings that do not have the valueFinance
for the tagDepartment
.
EQUALS
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.
NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.You cannot have both an
EQUALS
filter and aNOT_EQUALS
filter on the same field.ComplianceStatus -> (list)
Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
VerificationState -> (list)
The veracity of a finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
WorkflowState -> (list)
The workflow state of a finding.
Note that this field is deprecated. To search for a finding based on its workflow status, use
WorkflowStatus
.(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
WorkflowStatus -> (list)
The status of the investigation into a finding. Allowed values are the following.
NEW
- The initial state of a finding, before it is reviewed. Security Hub also resets the workflow status fromNOTIFIED
orRESOLVED
toNEW
in the following cases:
RecordState
changes fromARCHIVED
toACTIVE
.
Compliance.Status
changes fromPASSED
to eitherWARNING
,FAILED
, orNOT_AVAILABLE
.
NOTIFIED
- Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. If one of the following occurs, the workflow status is changed automatically fromNOTIFIED
toNEW
:
RecordState
changes fromARCHIVED
toACTIVE
.
Compliance.Status
changes fromPASSED
toFAILED
,WARNING
, orNOT_AVAILABLE
.
SUPPRESSED
- Indicates that you reviewed the finding and do not believe that any action is needed. The workflow status of aSUPPRESSED
finding does not change ifRecordState
changes fromARCHIVED
toACTIVE
.
RESOLVED
- The finding was reviewed and remediated and is now considered resolved. The finding remainsRESOLVED
unless one of the following occurs:
RecordState
changes fromARCHIVED
toACTIVE
.
Compliance.Status
changes fromPASSED
toFAILED
,WARNING
, orNOT_AVAILABLE
.In those cases, the workflow status is automatically reset to
NEW
.For findings from controls, if
Compliance.Status
isPASSED
, then Security Hub automatically sets the workflow status toRESOLVED
.(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
RecordState -> (list)
The updated record state for the finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
RelatedFindingsProductArn -> (list)
The ARN of the solution that generated a related finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
RelatedFindingsId -> (list)
The solution-generated identifier for a related finding.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NoteText -> (list)
The text of a note.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
NoteUpdatedAt -> (list)
The timestamp of when the note was updated.
(structure)
A date filter for querying findings.
Start -> (string)
A start date for the date filter.
End -> (string)
An end date for the date filter.
DateRange -> (structure)
A date range for the date filter.
Value -> (integer)
A date range value for the date filter.
Unit -> (string)
A date range unit for the date filter.
NoteUpdatedBy -> (list)
The principal that created a note.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Keyword -> (list)
A keyword for a finding.
(structure)
A keyword filter for querying findings.
Value -> (string)
A value for the keyword.
FindingProviderFieldsConfidence -> (list)
The finding provider 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.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
FindingProviderFieldsCriticality -> (list)
The finding provider 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.
(structure)
A number filter for querying findings.
Gte -> (double)
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte -> (double)
The less-than-equal condition to be applied to a single field when querying for findings.
Eq -> (double)
The equal-to condition to be applied to a single field when querying for findings.
FindingProviderFieldsRelatedFindingsId -> (list)
The finding identifier of a related finding that is identified by the finding provider.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
FindingProviderFieldsRelatedFindingsProductArn -> (list)
The ARN of the solution that generated a related finding that is identified by the finding provider.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
FindingProviderFieldsSeverityLabel -> (list)
The finding provider value for the severity label.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
FindingProviderFieldsSeverityOriginal -> (list)
The finding provider’s original value for the severity.
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
FindingProviderFieldsTypes -> (list)
One or more finding types that the finding provider assigned to the finding. Uses 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
(structure)
A string filter for querying findings.
Value -> (string)
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub
. If you providesecurity hub
as the filter text, then there is no match.Comparison -> (string)
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use
EQUALS
. For example, the filterResourceType EQUALS AwsEc2SecurityGroup
only matches findings that have a resource type ofAwsEc2SecurityGroup
.To search for values that start with the filter value, use
PREFIX
. For example, the filterResourceType PREFIX AwsIam
matches findings that have a resource type that starts withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all match.
EQUALS
andPREFIX
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters.To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use
NOT_EQUALS
. For example, the filterResourceType NOT_EQUALS AwsIamPolicy
matches findings that have a resource type other thanAwsIamPolicy
.To search for values that do not start with the filter value, use
PREFIX_NOT_EQUALS
. For example, the filterResourceType PREFIX_NOT_EQUALS AwsIam
matches findings that have a resource type that does not start withAwsIam
. Findings with a resource type ofAwsIamPolicy
,AwsIamRole
, orAwsIamUser
would all be excluded from the results.
NOT_EQUALS
andPREFIX_NOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters.For filters on the same field, you cannot provide both an
EQUALS
filter and aNOT_EQUALS
orPREFIX_NOT_EQUALS
filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.You can combine
PREFIX
filters withNOT_EQUALS
orPREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes thePREFIX
filters, then theNOT_EQUALS
orPREFIX_NOT_EQUALS
filters.For example, for the following filter, Security Hub first identifies findings that have resource types that start with either
AwsIAM
orAwsEc2
. It then excludes findings that have a resource type ofAwsIamPolicy
and findings that have a resource type ofAwsEc2NetworkInterface
.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
Sample -> (list)
Indicates whether or not sample findings are included in the filter results.
(structure)
Boolean filter for querying findings.
Value -> (boolean)
The value of the boolean.
GroupByAttribute -> (string)
The grouping attribute for the insight’s findings. Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
NextToken -> (string)
The pagination token to use to request the next page of results.