2026/10/08 - AWS SecurityHub - 4 new api methods
Changes Release findings export APIs - StartExportJobV2, GetExportJobV2, ListExportJobsV2, and CancelExportJobV2. This supports exporting findings from AWS Security Hub to Amazon S3 bucket.
Returns the findings export jobs in your account as a paginated list of ExportSummary objects. You can filter the results by job Status or DataType.
To page through the results, use the MaxResults and NextToken parameters. If the response includes a NextToken value, pass it in a subsequent request to retrieve the next page of results.
Each ExportSummary reports the output Format of the job but not its full OutputConfiguration. To retrieve the filters and selected fields that a job was started with, call GetExportJobV2.
See also: AWS API Documentation
Request Syntax
client.list_export_jobs_v2(
Status='RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
DataType='FINDINGS',
MaxResults=123,
NextToken='string'
)
string
Filters the results to export jobs that have the specified status.
string
Filters the results to export jobs that produce the specified data type.
integer
The maximum number of results to return in a single call. Valid range is 1–20.
string
The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
dict
Response Syntax
{
'Items': [
{
'ExportJobId': 'string',
'Name': 'string',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
'DataType': 'FINDINGS',
'OutputConfiguration': {
'Findings': {
'Format': 'CSV'|'OCSF_JSON'
}
},
'Scopes': {
'AwsOrganizations': [
{
'OrganizationId': 'string',
'OrganizationalUnitId': 'string'
},
]
},
'Destination': {
'S3': {
'BucketArn': 'string',
'KmsKeyArn': 'string',
'ObjectPrefix': 'string'
}
},
'FailureCode': 'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'INTERNAL_ERROR',
'FailureMessage': 'string',
'StartedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The export jobs that match the request, as ExportSummary objects.
(dict) --
A summary of an export job, as returned by ListExportJobsV2.
ExportJobId (string) --
The unique identifier of the export job.
Name (string) --
The user-provided name of the export job, if one was specified.
Status (string) --
The current state of the export job.
DataType (string) --
The category of data that the export job produces.
OutputConfiguration (dict) --
The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.
Findings (dict) --
The output configuration summary for a findings export.
Format (string) --
The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.
Scopes (dict) --
The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.
AwsOrganizations (list) --
A list of Organizations scopes to include in the export. Each entry in the list specifies an organization or organizational unit to include for the delegated administrator's account. If the list specifies multiple entries, the entries are combined using OR logic.
(dict) --
Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.
To scope to a specific organizational unit, provide OrganizationalUnitId. You can optionally include OrganizationId. If you omit OrganizationId, Security Hub uses the caller's organization ID. To scope to the delegated administrator's entire organization, provide only OrganizationId.
The organization ID and organizational unit must belong to the delegated administrator's own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId, or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId. You can't combine both approaches in the same request.
OrganizationId (string) --
The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.
OrganizationalUnitId (string) --
The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.
Destination (dict) --
The destination that the export job writes to.
S3 (dict) --
The Amazon Simple Storage Service (Amazon S3) bucket and Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Security Hub uses to write the export.
BucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal ( exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.
KmsKeyArn (string) --
The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal ( exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.
The key must meet all of the following requirements:
It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.
It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.
You must specify the full key ARN. Key IDs and aliases are rejected.
The key must be in the same Amazon Web Services account as the export job.
The key must be in the same Amazon Web Services Region as the export job.
The key must be in the aws, aws-cn, or aws-us-gov partition.
ObjectPrefix (string) --
An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.
FailureCode (string) --
A code that classifies why the export job failed. Present only when Status is FAILED.
FailureMessage (string) --
A human-readable message about why the export job failed. Present only when Status is FAILED.
StartedAt (datetime) --
The time when the export job was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
EndedAt (datetime) --
The time when the export job reached a terminal state. Absent while the job is RUNNING.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
NextToken (string) --
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Cancels a findings export job that is in progress. Security Hub transitions a running job to the CANCELLED state and returns the ExportJobId and its new Status. Canceling a job that is already in the CANCELLED state succeeds and returns the same result, so you can safely retry a cancel request.
You can't cancel an export job that has already reached a terminal SUCCEEDED or FAILED state; in that case, this operation returns a ConflictException. If no export job matches the ExportJobId that you provide, this operation returns a ResourceNotFoundException.
The Status value returned by this operation reflects the cancellation immediately, even though the job can take a short time to stop completely.
See also: AWS API Documentation
Request Syntax
client.cancel_export_job_v2(
ExportJobId='string'
)
string
[REQUIRED]
The unique identifier of the export job to cancel. This is the value returned by StartExportJobV2.
dict
Response Syntax
{
'ExportJobId': 'string',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
ExportJobId (string) --
The unique identifier of the export job.
Status (string) --
The state of the export job after the cancel request.
Starts an ad hoc export job that writes Security Hub findings to an Amazon Simple Storage Service (Amazon S3) bucket that you own. Because the export runs asynchronously, this operation returns only the ExportJobId of the new job; it doesn't wait for the export to finish. Use GetExportJobV2 to poll the job, and ListExportJobsV2 to view the export jobs in your account.
Security Hub allows only one export job in the RUNNING state per account at a time. If an export job is already running, this operation returns a ServiceQuotaExceededException. Wait for the running job to finish, or cancel it with CancelExportJobV2, before you start a new one.
Specify the destination bucket and Amazon Web Services Key Management Service (Amazon Web Services KMS) key in the Destination parameter, and the output format ( CSV or OCSF_JSON), optional filters, and field selection in the OutputConfiguration parameter. Before you call this operation, you must grant Security Hub permission to write to your bucket and use your Amazon Web Services KMS key by adding the bucket policy and key policy statements shown in the Examples section.
Two identities use your Amazon Web Services KMS key, and each needs its own permission. Security Hub uses the key when it writes the export objects to your bucket. The IAM principal that calls StartExportJobV2 must also have kms:GenerateDataKey and kms:Decrypt permissions on the key. The Examples section shows both grants.
A delegated administrator can use the optional Scopes parameter to export findings for specific organizations or organizational units (OUs).
To make the request idempotent, provide a ClientToken. If you retry a StartExportJobV2 request with the same ClientToken and the same request parameters, Security Hub returns the ExportJobId of the original job instead of starting a new one. If you reuse a ClientToken with different request parameters, this operation returns a ConflictException.
See also: AWS API Documentation
Request Syntax
client.start_export_job_v2(
Name='string',
Destination={
'S3': {
'BucketArn': 'string',
'KmsKeyArn': 'string',
'ObjectPrefix': 'string'
}
},
OutputConfiguration={
'Findings': {
'Format': 'CSV'|'OCSF_JSON',
'Filters': {
'CompositeFilters': [
{
'StringFilters': [
{
'FieldName': 'metadata.uid'|'activity_name'|'cloud.account.uid'|'cloud.provider'|'cloud.region'|'compliance.assessments.category'|'compliance.assessments.name'|'compliance.control'|'compliance.status'|'compliance.standards'|'finding_info.desc'|'finding_info.src_url'|'finding_info.title'|'finding_info.types'|'finding_info.uid'|'finding_info.related_events.traits.category'|'finding_info.related_events.uid'|'finding_info.related_events.product.uid'|'finding_info.related_events.title'|'metadata.product.name'|'metadata.product.uid'|'metadata.product.vendor_name'|'remediation.desc'|'remediation.references'|'resources.cloud_partition'|'resources.name'|'resources.owner.account.uid'|'resources.owner.org.uid'|'resources.owner.account.name'|'resources.provider'|'resources.region'|'resources.type'|'resources.uid'|'severity'|'status'|'comment'|'vulnerabilities.fix_coverage'|'class_name'|'databucket.encryption_details.algorithm'|'databucket.encryption_details.key_uid'|'databucket.file.data_classifications.classifier_details.type'|'evidences.actor.user.account.uid'|'evidences.api.operation'|'evidences.api.response.error_message'|'evidences.api.service.name'|'evidences.connection_info.direction'|'evidences.connection_info.protocol_name'|'evidences.dst_endpoint.autonomous_system.name'|'evidences.dst_endpoint.location.city'|'evidences.dst_endpoint.location.country'|'evidences.src_endpoint.autonomous_system.name'|'evidences.src_endpoint.hostname'|'evidences.src_endpoint.location.city'|'evidences.src_endpoint.location.country'|'finding_info.analytic.name'|'malware.name'|'malware_scan_info.uid'|'malware.severity'|'resources.cloud_function.layers.uid_alt'|'resources.cloud_function.runtime'|'resources.cloud_function.user.uid'|'resources.device.encryption_details.key_uid'|'resources.device.image.uid'|'resources.image.architecture'|'resources.image.registry_uid'|'resources.image.repository_name'|'resources.image.uid'|'resources.subnet_info.uid'|'resources.vpc_uid'|'vulnerabilities.affected_code.file.path'|'vulnerabilities.affected_packages.name'|'vulnerabilities.cve.epss.score'|'vulnerabilities.cve.uid'|'vulnerabilities.related_vulnerabilities'|'cloud.account.name'|'vendor_attributes.severity',
'Filter': {
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
}
},
],
'DateFilters': [
{
'FieldName': 'finding_info.created_time_dt'|'finding_info.first_seen_time_dt'|'finding_info.last_seen_time_dt'|'finding_info.modified_time_dt'|'resources.image.created_time_dt'|'resources.image.last_used_time_dt'|'resources.modified_time_dt',
'Filter': {
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
}
},
],
'BooleanFilters': [
{
'FieldName': 'compliance.assessments.meets_criteria'|'vulnerabilities.is_exploit_available'|'vulnerabilities.is_fix_available',
'Filter': {
'Value': True|False
}
},
],
'NumberFilters': [
{
'FieldName': 'activity_id'|'compliance.status_id'|'confidence_score'|'severity_id'|'status_id'|'finding_info.related_events_count'|'evidences.api.response.code'|'evidences.dst_endpoint.autonomous_system.number'|'evidences.dst_endpoint.port'|'evidences.src_endpoint.autonomous_system.number'|'evidences.src_endpoint.port'|'resources.image.in_use_count'|'vulnerabilities.cve.cvss.base_score'|'vendor_attributes.severity_id',
'Filter': {
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
}
},
],
'MapFilters': [
{
'FieldName': 'resources.tags'|'compliance.control_parameters'|'databucket.tags'|'finding_info.tags',
'Filter': {
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
}
},
],
'IpFilters': [
{
'FieldName': 'evidences.dst_endpoint.ip'|'evidences.src_endpoint.ip',
'Filter': {
'Cidr': 'string'
}
},
],
'NestedCompositeFilters': {'... recursive ...'},
'Operator': 'AND'|'OR'
},
],
'CompositeOperator': 'AND'|'OR'
},
'SelectedFields': [
'metadata.uid'|'activity_name'|'cloud.account.name'|'cloud.account.uid'|'cloud.provider'|'cloud.region'|'compliance.assessments.category'|'compliance.assessments.name'|'compliance.control'|'compliance.status'|'compliance.standards'|'finding_info.desc'|'finding_info.src_url'|'finding_info.title'|'finding_info.types'|'finding_info.uid'|'finding_info.related_events.traits.category'|'finding_info.related_events.uid'|'finding_info.related_events.product.uid'|'finding_info.related_events.title'|'metadata.product.feature.uid'|'metadata.product.name'|'metadata.product.uid'|'metadata.product.vendor_name'|'remediation.desc'|'remediation.references'|'resources.cloud_partition'|'resources.name'|'resources.owner.account.uid'|'resources.owner.org.uid'|'resources.owner.account.name'|'resources.provider'|'resources.region'|'resources.type'|'resources.uid'|'severity'|'status'|'comment'|'vulnerabilities.fix_coverage'|'class_name'|'databucket.encryption_details.algorithm'|'databucket.encryption_details.key_uid'|'databucket.file.data_classifications.classifier_details.type'|'evidences.actor.user.account.uid'|'evidences.api.operation'|'evidences.api.response.error_message'|'evidences.api.service.name'|'evidences.connection_info.direction'|'evidences.connection_info.protocol_name'|'evidences.dst_endpoint.autonomous_system.name'|'evidences.dst_endpoint.location.city'|'evidences.dst_endpoint.location.country'|'evidences.src_endpoint.autonomous_system.name'|'evidences.src_endpoint.hostname'|'evidences.src_endpoint.location.city'|'evidences.src_endpoint.location.country'|'finding_info.analytic.name'|'malware.name'|'malware_scan_info.uid'|'malware.severity'|'resources.cloud_function.layers.uid_alt'|'resources.cloud_function.runtime'|'resources.cloud_function.user.uid'|'resources.device.encryption_details.key_uid'|'resources.device.image.uid'|'resources.image.architecture'|'resources.image.registry_uid'|'resources.image.repository_name'|'resources.image.uid'|'resources.subnet_info.uid'|'resources.vpc_uid'|'vulnerabilities.affected_code.file.path'|'vulnerabilities.affected_packages.name'|'vulnerabilities.cve.cvss.vendor_name'|'vulnerabilities.cve.cvss.version'|'vulnerabilities.cve.epss.score'|'vulnerabilities.cve.uid'|'vulnerabilities.related_vulnerabilities'|'vendor_attributes.severity'|'activity_id'|'compliance.status_id'|'confidence_score'|'severity_id'|'status_id'|'finding_info.related_events_count'|'evidences.api.response.code'|'evidences.dst_endpoint.autonomous_system.number'|'evidences.dst_endpoint.port'|'evidences.src_endpoint.autonomous_system.number'|'evidences.src_endpoint.port'|'resources.image.in_use_count'|'vulnerabilities.cve.cvss.base_score'|'vendor_attributes.severity_id'|'finding_info.created_time_dt'|'finding_info.first_seen_time_dt'|'finding_info.last_seen_time_dt'|'finding_info.modified_time_dt'|'resources.image.created_time_dt'|'resources.image.last_used_time_dt'|'resources.modified_time_dt'|'compliance.assessments.meets_criteria'|'vulnerabilities.is_exploit_available'|'vulnerabilities.is_fix_available'|'resources.tags'|'compliance.control_parameters'|'databucket.tags'|'finding_info.tags'|'evidences.dst_endpoint.ip'|'evidences.src_endpoint.ip',
]
}
},
Scopes={
'AwsOrganizations': [
{
'OrganizationId': 'string',
'OrganizationalUnitId': 'string'
},
]
},
ClientToken='string'
)
string
An optional, user-provided name for the export job that helps you identify it in ListExportJobsV2 results. The value can be 1–256 characters. Alphanumeric characters, spaces, and the following ASCII characters are permitted: . _ , : ( ) / + -.
dict
[REQUIRED]
The destination that Security Hub writes the export to. You must specify exactly one destination type. Currently, the only supported type is Amazon S3.
S3 (dict) --
The Amazon Simple Storage Service (Amazon S3) bucket and Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Security Hub uses to write the export.
BucketArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal ( exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.
KmsKeyArn (string) -- [REQUIRED]
The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal ( exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.
The key must meet all of the following requirements:
It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.
It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.
You must specify the full key ARN. Key IDs and aliases are rejected.
The key must be in the same Amazon Web Services account as the export job.
The key must be in the same Amazon Web Services Region as the export job.
The key must be in the aws, aws-cn, or aws-us-gov partition.
ObjectPrefix (string) --
An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.
dict
[REQUIRED]
Specifies what data to export and how to format it. You must specify exactly one output type. Currently, the only supported type is Findings.
Findings (dict) --
Configures an export of Security Hub findings, including the output format and any filters or selected fields.
Format (string) -- [REQUIRED]
The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.
Filters (dict) --
An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.
CompositeFilters (list) --
Enables the creation of complex filtering conditions by combining filter criteria.
(dict) --
Enables the creation of filtering criteria for security findings.
StringFilters (list) --
Enables filtering based on string field values.
(dict) --
Enables filtering of security findings based on string field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A string filter for filtering Security Hub CSPM findings.
Value (string) --
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is Security Hub CSPM. If you provide security hub as the filter value, there's no match.
Comparison (string) --
The condition to apply to a string value when filtering Security Hub CSPM findings.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront.
To search for values that contain a word matching the filter value, regardless of case, use CONTAINS_WORD. For example, the filter Title CONTAINS_WORD lambda matches a finding whose Title is GuardDuty Lambda Protection, because the Title contains the word Lambda. Including special characters in the filter value might produce unexpected search results.
To search for values that exactly match the filter value, use EQUALS. For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012.
To search for values that start with the filter value, use PREFIX. For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us. A ResourceRegion that starts with a different value, such as af, ap, or ca, doesn't match.
CONTAINS, EQUALS, and PREFIX filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront, CloudWatch, or both strings in the title.
To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront.
To search for values other than the filter value, use NOT_EQUALS. For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012.
To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS. For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us.
NOT_CONTAINS, NOT_EQUALS, and PREFIX_NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub CSPM first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.
For example, for the following filters, Security Hub CSPM first identifies findings that have resource types that start with either AwsIam or AwsEc2. It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
The CONTAINS operator works with automation rules V1 and V2. The NOT_CONTAINS operator works only with automation rules V1. The CONTAINS_WORD operator works only in the GetFindingsV2, GetFindingStatisticsV2, GetResourcesV2, and GetResourcesStatisticsV2 APIs. For more information, see Automation rules in the Security Hub CSPM User Guide.
DateFilters (list) --
Enables filtering based on date and timestamp fields.
(dict) --
Enables filtering of security findings based on date and timestamp fields in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A date filter for querying findings.
Start (string) --
A timestamp that provides the start date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
End (string) --
A timestamp that provides the end date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
DateRange (dict) --
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.
Comparison (string) --
The condition to apply to a date range filter. If you specify WITHIN, Security Hub filters for dates within the specified date range. If you specify OLDER_THAN, Security Hub filters for dates before the specified date range. If you don't specify a value, the default is WITHIN.
BooleanFilters (list) --
Enables filtering based on boolean field values.
(dict) --
Enables filtering of security findings based on boolean field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
Boolean filter for querying findings.
Value (boolean) --
The value of the boolean.
NumberFilters (list) --
Enables filtering based on numerical field values.
(dict) --
Enables filtering of security findings based on numerical field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A number filter for querying findings.
Gte (float) --
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte (float) --
The less-than-equal condition to be applied to a single field when querying for findings.
Eq (float) --
The equal-to condition to be applied to a single field when querying for findings.
Gt (float) --
The greater-than condition to be applied to a single field when querying for findings.
Lt (float) --
The less-than condition to be applied to a single field when querying for findings.
MapFilters (list) --
Enables filtering based on map field values.
(dict) --
Enables filtering of security findings based on map field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A map filter for filtering Security Hub CSPM findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.
Key (string) --
The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, 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 be Security. If you provide security as the filter value, then there's no match.
Comparison (string) --
The condition to apply to the key value when filtering Security Hub CSPM findings with a map filter.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match.
To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag.
CONTAINS and EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security, Finance, or both values.
To search for values that don't have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag.
To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag.
NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values.
CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error.
CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub CSPM User Guide.
IpFilters (list) --
A list of IP address filters that allowing you to filter findings based on IP address properties.
(dict) --
The structure for filtering findings based on IP address attributes.
FieldName (string) --
The name of the IP address field to filter on.
Filter (dict) --
The IP filter for querying findings.
Cidr (string) --
A finding's CIDR value.
NestedCompositeFilters (list) --
Provides an additional level of filtering, creating a three-layer nested structure. The first layer is a CompositeFilters array with a CompositeOperator ( AND/ OR). The second layer is a CompositeFilter object that contains direct filters and NestedCompositeFilters. The third layer is NestedCompositeFilters, which contains additional filter conditions.
Operator (string) --
The logical operator used to combine multiple filter conditions.
CompositeOperator (string) --
The logical operators used to combine the filtering on multiple CompositeFilters.
SelectedFields (list) --
The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.
Whether this parameter is required depends on the value of Format:
CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.
OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.
(string) --
An OCSF finding field path that can be included in FindingsOutput.SelectedFields, for example finding_info.title, severity, or cloud.account.uid. Each value corresponds to a field in the OCSF finding schema.
dict
Limits the export to findings from specific organizational units (OUs) or from the delegated administrator's organization. Only the delegated administrator account can use this parameter; other accounts that specify it receive an AccessDeniedException.
This parameter is optional. If you omit it, the delegated administrator exports findings from all accounts across the entire organization, and other accounts export only their own findings.
You can specify up to 10 entries in Scopes.AwsOrganizations. If you specify multiple entries, Security Hub combines them using OR logic.
AwsOrganizations (list) --
A list of Organizations scopes to include in the export. Each entry in the list specifies an organization or organizational unit to include for the delegated administrator's account. If the list specifies multiple entries, the entries are combined using OR logic.
(dict) --
Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.
To scope to a specific organizational unit, provide OrganizationalUnitId. You can optionally include OrganizationId. If you omit OrganizationId, Security Hub uses the caller's organization ID. To scope to the delegated administrator's entire organization, provide only OrganizationId.
The organization ID and organizational unit must belong to the delegated administrator's own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId, or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId. You can't combine both approaches in the same request.
OrganizationId (string) --
The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.
OrganizationalUnitId (string) --
The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.
string
A unique identifier used to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ExportJobId': 'string'
}
Response Structure
(dict) --
ExportJobId (string) --
The unique identifier of the export job that Security Hub started. Use this value with GetExportJobV2 or CancelExportJobV2.
Returns the details of a single findings export job, including its current Status, the Destination it writes to, the OutputConfiguration it was started with, and its StartedAt and EndedAt timestamps. Use this operation to poll an export job that you started with StartExportJobV2 until it reaches a terminal state ( SUCCEEDED, FAILED, or CANCELLED).
If the job failed, the response includes a FailureCode and FailureMessage that describe the reason. Input values such as Scopes and Filters are echoed back as they were submitted, with relative date ranges returned unresolved. If no export job matches the ExportJobId that you provide, this operation returns a ResourceNotFoundException.
See also: AWS API Documentation
Request Syntax
client.get_export_job_v2(
ExportJobId='string'
)
string
[REQUIRED]
The unique identifier of the export job to retrieve. This is the value returned by StartExportJobV2.
dict
Response Syntax
{
'ExportJobId': 'string',
'Name': 'string',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
'DataType': 'FINDINGS',
'OutputConfiguration': {
'Findings': {
'Format': 'CSV'|'OCSF_JSON',
'Filters': {
'CompositeFilters': [
{
'StringFilters': [
{
'FieldName': 'metadata.uid'|'activity_name'|'cloud.account.uid'|'cloud.provider'|'cloud.region'|'compliance.assessments.category'|'compliance.assessments.name'|'compliance.control'|'compliance.status'|'compliance.standards'|'finding_info.desc'|'finding_info.src_url'|'finding_info.title'|'finding_info.types'|'finding_info.uid'|'finding_info.related_events.traits.category'|'finding_info.related_events.uid'|'finding_info.related_events.product.uid'|'finding_info.related_events.title'|'metadata.product.name'|'metadata.product.uid'|'metadata.product.vendor_name'|'remediation.desc'|'remediation.references'|'resources.cloud_partition'|'resources.name'|'resources.owner.account.uid'|'resources.owner.org.uid'|'resources.owner.account.name'|'resources.provider'|'resources.region'|'resources.type'|'resources.uid'|'severity'|'status'|'comment'|'vulnerabilities.fix_coverage'|'class_name'|'databucket.encryption_details.algorithm'|'databucket.encryption_details.key_uid'|'databucket.file.data_classifications.classifier_details.type'|'evidences.actor.user.account.uid'|'evidences.api.operation'|'evidences.api.response.error_message'|'evidences.api.service.name'|'evidences.connection_info.direction'|'evidences.connection_info.protocol_name'|'evidences.dst_endpoint.autonomous_system.name'|'evidences.dst_endpoint.location.city'|'evidences.dst_endpoint.location.country'|'evidences.src_endpoint.autonomous_system.name'|'evidences.src_endpoint.hostname'|'evidences.src_endpoint.location.city'|'evidences.src_endpoint.location.country'|'finding_info.analytic.name'|'malware.name'|'malware_scan_info.uid'|'malware.severity'|'resources.cloud_function.layers.uid_alt'|'resources.cloud_function.runtime'|'resources.cloud_function.user.uid'|'resources.device.encryption_details.key_uid'|'resources.device.image.uid'|'resources.image.architecture'|'resources.image.registry_uid'|'resources.image.repository_name'|'resources.image.uid'|'resources.subnet_info.uid'|'resources.vpc_uid'|'vulnerabilities.affected_code.file.path'|'vulnerabilities.affected_packages.name'|'vulnerabilities.cve.epss.score'|'vulnerabilities.cve.uid'|'vulnerabilities.related_vulnerabilities'|'cloud.account.name'|'vendor_attributes.severity',
'Filter': {
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
}
},
],
'DateFilters': [
{
'FieldName': 'finding_info.created_time_dt'|'finding_info.first_seen_time_dt'|'finding_info.last_seen_time_dt'|'finding_info.modified_time_dt'|'resources.image.created_time_dt'|'resources.image.last_used_time_dt'|'resources.modified_time_dt',
'Filter': {
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
}
},
],
'BooleanFilters': [
{
'FieldName': 'compliance.assessments.meets_criteria'|'vulnerabilities.is_exploit_available'|'vulnerabilities.is_fix_available',
'Filter': {
'Value': True|False
}
},
],
'NumberFilters': [
{
'FieldName': 'activity_id'|'compliance.status_id'|'confidence_score'|'severity_id'|'status_id'|'finding_info.related_events_count'|'evidences.api.response.code'|'evidences.dst_endpoint.autonomous_system.number'|'evidences.dst_endpoint.port'|'evidences.src_endpoint.autonomous_system.number'|'evidences.src_endpoint.port'|'resources.image.in_use_count'|'vulnerabilities.cve.cvss.base_score'|'vendor_attributes.severity_id',
'Filter': {
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
}
},
],
'MapFilters': [
{
'FieldName': 'resources.tags'|'compliance.control_parameters'|'databucket.tags'|'finding_info.tags',
'Filter': {
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
}
},
],
'IpFilters': [
{
'FieldName': 'evidences.dst_endpoint.ip'|'evidences.src_endpoint.ip',
'Filter': {
'Cidr': 'string'
}
},
],
'NestedCompositeFilters': {'... recursive ...'},
'Operator': 'AND'|'OR'
},
],
'CompositeOperator': 'AND'|'OR'
},
'SelectedFields': [
'metadata.uid'|'activity_name'|'cloud.account.name'|'cloud.account.uid'|'cloud.provider'|'cloud.region'|'compliance.assessments.category'|'compliance.assessments.name'|'compliance.control'|'compliance.status'|'compliance.standards'|'finding_info.desc'|'finding_info.src_url'|'finding_info.title'|'finding_info.types'|'finding_info.uid'|'finding_info.related_events.traits.category'|'finding_info.related_events.uid'|'finding_info.related_events.product.uid'|'finding_info.related_events.title'|'metadata.product.feature.uid'|'metadata.product.name'|'metadata.product.uid'|'metadata.product.vendor_name'|'remediation.desc'|'remediation.references'|'resources.cloud_partition'|'resources.name'|'resources.owner.account.uid'|'resources.owner.org.uid'|'resources.owner.account.name'|'resources.provider'|'resources.region'|'resources.type'|'resources.uid'|'severity'|'status'|'comment'|'vulnerabilities.fix_coverage'|'class_name'|'databucket.encryption_details.algorithm'|'databucket.encryption_details.key_uid'|'databucket.file.data_classifications.classifier_details.type'|'evidences.actor.user.account.uid'|'evidences.api.operation'|'evidences.api.response.error_message'|'evidences.api.service.name'|'evidences.connection_info.direction'|'evidences.connection_info.protocol_name'|'evidences.dst_endpoint.autonomous_system.name'|'evidences.dst_endpoint.location.city'|'evidences.dst_endpoint.location.country'|'evidences.src_endpoint.autonomous_system.name'|'evidences.src_endpoint.hostname'|'evidences.src_endpoint.location.city'|'evidences.src_endpoint.location.country'|'finding_info.analytic.name'|'malware.name'|'malware_scan_info.uid'|'malware.severity'|'resources.cloud_function.layers.uid_alt'|'resources.cloud_function.runtime'|'resources.cloud_function.user.uid'|'resources.device.encryption_details.key_uid'|'resources.device.image.uid'|'resources.image.architecture'|'resources.image.registry_uid'|'resources.image.repository_name'|'resources.image.uid'|'resources.subnet_info.uid'|'resources.vpc_uid'|'vulnerabilities.affected_code.file.path'|'vulnerabilities.affected_packages.name'|'vulnerabilities.cve.cvss.vendor_name'|'vulnerabilities.cve.cvss.version'|'vulnerabilities.cve.epss.score'|'vulnerabilities.cve.uid'|'vulnerabilities.related_vulnerabilities'|'vendor_attributes.severity'|'activity_id'|'compliance.status_id'|'confidence_score'|'severity_id'|'status_id'|'finding_info.related_events_count'|'evidences.api.response.code'|'evidences.dst_endpoint.autonomous_system.number'|'evidences.dst_endpoint.port'|'evidences.src_endpoint.autonomous_system.number'|'evidences.src_endpoint.port'|'resources.image.in_use_count'|'vulnerabilities.cve.cvss.base_score'|'vendor_attributes.severity_id'|'finding_info.created_time_dt'|'finding_info.first_seen_time_dt'|'finding_info.last_seen_time_dt'|'finding_info.modified_time_dt'|'resources.image.created_time_dt'|'resources.image.last_used_time_dt'|'resources.modified_time_dt'|'compliance.assessments.meets_criteria'|'vulnerabilities.is_exploit_available'|'vulnerabilities.is_fix_available'|'resources.tags'|'compliance.control_parameters'|'databucket.tags'|'finding_info.tags'|'evidences.dst_endpoint.ip'|'evidences.src_endpoint.ip',
]
}
},
'Scopes': {
'AwsOrganizations': [
{
'OrganizationId': 'string',
'OrganizationalUnitId': 'string'
},
]
},
'Destination': {
'S3': {
'BucketArn': 'string',
'KmsKeyArn': 'string',
'ObjectPrefix': 'string'
}
},
'FailureCode': 'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'INTERNAL_ERROR',
'FailureMessage': 'string',
'StartedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ExportJobId (string) --
The unique identifier of the export job.
Name (string) --
The user-provided name of the export job, if one was specified when the job was started.
Status (string) --
The current state of the export job.
DataType (string) --
The category of data that the export job produces.
OutputConfiguration (dict) --
The output configuration that the export job was started with, including the format and any filters or selected fields.
Findings (dict) --
Configures an export of Security Hub findings, including the output format and any filters or selected fields.
Format (string) --
The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.
Filters (dict) --
An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.
CompositeFilters (list) --
Enables the creation of complex filtering conditions by combining filter criteria.
(dict) --
Enables the creation of filtering criteria for security findings.
StringFilters (list) --
Enables filtering based on string field values.
(dict) --
Enables filtering of security findings based on string field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A string filter for filtering Security Hub CSPM findings.
Value (string) --
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is Security Hub CSPM. If you provide security hub as the filter value, there's no match.
Comparison (string) --
The condition to apply to a string value when filtering Security Hub CSPM findings.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront.
To search for values that contain a word matching the filter value, regardless of case, use CONTAINS_WORD. For example, the filter Title CONTAINS_WORD lambda matches a finding whose Title is GuardDuty Lambda Protection, because the Title contains the word Lambda. Including special characters in the filter value might produce unexpected search results.
To search for values that exactly match the filter value, use EQUALS. For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012.
To search for values that start with the filter value, use PREFIX. For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us. A ResourceRegion that starts with a different value, such as af, ap, or ca, doesn't match.
CONTAINS, EQUALS, and PREFIX filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront, CloudWatch, or both strings in the title.
To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront.
To search for values other than the filter value, use NOT_EQUALS. For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012.
To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS. For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us.
NOT_CONTAINS, NOT_EQUALS, and PREFIX_NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub CSPM first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.
For example, for the following filters, Security Hub CSPM first identifies findings that have resource types that start with either AwsIam or AwsEc2. It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
The CONTAINS operator works with automation rules V1 and V2. The NOT_CONTAINS operator works only with automation rules V1. The CONTAINS_WORD operator works only in the GetFindingsV2, GetFindingStatisticsV2, GetResourcesV2, and GetResourcesStatisticsV2 APIs. For more information, see Automation rules in the Security Hub CSPM User Guide.
DateFilters (list) --
Enables filtering based on date and timestamp fields.
(dict) --
Enables filtering of security findings based on date and timestamp fields in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A date filter for querying findings.
Start (string) --
A timestamp that provides the start date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
End (string) --
A timestamp that provides the end date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
DateRange (dict) --
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.
Comparison (string) --
The condition to apply to a date range filter. If you specify WITHIN, Security Hub filters for dates within the specified date range. If you specify OLDER_THAN, Security Hub filters for dates before the specified date range. If you don't specify a value, the default is WITHIN.
BooleanFilters (list) --
Enables filtering based on boolean field values.
(dict) --
Enables filtering of security findings based on boolean field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
Boolean filter for querying findings.
Value (boolean) --
The value of the boolean.
NumberFilters (list) --
Enables filtering based on numerical field values.
(dict) --
Enables filtering of security findings based on numerical field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A number filter for querying findings.
Gte (float) --
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte (float) --
The less-than-equal condition to be applied to a single field when querying for findings.
Eq (float) --
The equal-to condition to be applied to a single field when querying for findings.
Gt (float) --
The greater-than condition to be applied to a single field when querying for findings.
Lt (float) --
The less-than condition to be applied to a single field when querying for findings.
MapFilters (list) --
Enables filtering based on map field values.
(dict) --
Enables filtering of security findings based on map field values in OCSF.
FieldName (string) --
The name of the field.
Filter (dict) --
A map filter for filtering Security Hub CSPM findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.
Key (string) --
The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, 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 be Security. If you provide security as the filter value, then there's no match.
Comparison (string) --
The condition to apply to the key value when filtering Security Hub CSPM findings with a map filter.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match.
To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag.
CONTAINS and EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security, Finance, or both values.
To search for values that don't have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag.
To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag.
NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values.
CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error.
CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub CSPM User Guide.
IpFilters (list) --
A list of IP address filters that allowing you to filter findings based on IP address properties.
(dict) --
The structure for filtering findings based on IP address attributes.
FieldName (string) --
The name of the IP address field to filter on.
Filter (dict) --
The IP filter for querying findings.
Cidr (string) --
A finding's CIDR value.
NestedCompositeFilters (list) --
Provides an additional level of filtering, creating a three-layer nested structure. The first layer is a CompositeFilters array with a CompositeOperator ( AND/ OR). The second layer is a CompositeFilter object that contains direct filters and NestedCompositeFilters. The third layer is NestedCompositeFilters, which contains additional filter conditions.
Operator (string) --
The logical operator used to combine multiple filter conditions.
CompositeOperator (string) --
The logical operators used to combine the filtering on multiple CompositeFilters.
SelectedFields (list) --
The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.
Whether this parameter is required depends on the value of Format:
CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.
OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.
(string) --
An OCSF finding field path that can be included in FindingsOutput.SelectedFields, for example finding_info.title, severity, or cloud.account.uid. Each value corresponds to a field in the OCSF finding schema.
Scopes (dict) --
The organization scopes that the export job was started with, echoed verbatim. This parameter is absent if the caller didn't supply Scopes. It contains only the organization or organizational unit (OU) identifiers that the caller submitted; it never contains resolved member-account identifiers.
AwsOrganizations (list) --
A list of Organizations scopes to include in the export. Each entry in the list specifies an organization or organizational unit to include for the delegated administrator's account. If the list specifies multiple entries, the entries are combined using OR logic.
(dict) --
Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.
To scope to a specific organizational unit, provide OrganizationalUnitId. You can optionally include OrganizationId. If you omit OrganizationId, Security Hub uses the caller's organization ID. To scope to the delegated administrator's entire organization, provide only OrganizationId.
The organization ID and organizational unit must belong to the delegated administrator's own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId, or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId. You can't combine both approaches in the same request.
OrganizationId (string) --
The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.
OrganizationalUnitId (string) --
The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.
Destination (dict) --
The destination that the export job writes to.
S3 (dict) --
The Amazon Simple Storage Service (Amazon S3) bucket and Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Security Hub uses to write the export.
BucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal ( exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.
KmsKeyArn (string) --
The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal ( exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.
The key must meet all of the following requirements:
It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.
It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.
You must specify the full key ARN. Key IDs and aliases are rejected.
The key must be in the same Amazon Web Services account as the export job.
The key must be in the same Amazon Web Services Region as the export job.
The key must be in the aws, aws-cn, or aws-us-gov partition.
ObjectPrefix (string) --
An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.
FailureCode (string) --
A code that classifies why the export job failed. Present only when Status is FAILED.
FailureMessage (string) --
A human-readable message that provides more detail about why the export job failed. Present only when Status is FAILED.
StartedAt (datetime) --
The time when the export job was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
EndedAt (datetime) --
The time when the export job reached a terminal state ( SUCCEEDED, FAILED, or CANCELLED). This parameter is absent while the job is RUNNING.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.