# get-export-job-v2 ## Description 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](https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetExportJobV2) ## Synopsis ``` get-export-job-v2 --export-job-id [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--export-job-id` (string) [required] > The unique identifier of the export job to retrieve. This is the value returned by `StartExportJobV2` . > Constraints: > * min: `1` > * max: `64` > * pattern: `^[a-z0-9]+$` `--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`. `--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. ## Global Options `--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--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. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Output ExportJobId -> (string) > The unique identifier of the export job. > Constraints: > * min: `1` > * max: `64` > * pattern: `^[a-z0-9]+$` Name -> (string) > The user-provided name of the export job, if one was specified when the job was started. > Constraints: > * min: `1` > * max: `256` Status -> (string) > The current state of the export job. > Possible values: > * `RUNNING` > * `SUCCEEDED` > * `FAILED` > * `CANCELLED` DataType -> (string) > The category of data that the export job produces. > Possible values: > * `FINDINGS` OutputConfiguration -> (tagged union structure) > The output configuration that the export job was started with, including the format and any filters or selected fields. > #### NOTE > This is a Tagged Union structure. Only one of the following top level keys can be set: `Findings`. > Findings -> (structure) > > 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. > > > Possible values: > > > * `CSV` > > > * `OCSF_JSON` > > Filters -> (structure) > > > 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. > > > > (structure) > > > > > Enables the creation of filtering criteria for security findings. > > > > > StringFilters -> (list) > > > > > > Enables filtering based on string field values. > > > > > > (structure) > > > > > > > Enables filtering of security findings based on string field values in OCSF. > > > > > > > FieldName -> (string) > > > > > > > > The name of the field. > > > > > > > > Possible values: > > > > > > > > * `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` > > > > > > > > * `impact` > > > > > > > > * `likelihood` > > > > > > > > * `metadata.product.name` > > > > > > > > * `metadata.product.uid` > > > > > > > > * `metadata.product.vendor_name` > > > > > > > > * `remediation.desc` > > > > > > > > * `remediation.references` > > > > > > > > * `resources.cloud_partition` > > > > > > > > * `resources.criticality` > > > > > > > > * `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 -> (structure) > > > > > > > > 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. > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* . > > > > > > > > > Possible values: > > > > > > > > > * `EQUALS` > > > > > > > > > * `PREFIX` > > > > > > > > > * `NOT_EQUALS` > > > > > > > > > * `PREFIX_NOT_EQUALS` > > > > > > > > > * `CONTAINS` > > > > > > > > > * `NOT_CONTAINS` > > > > > > > > > * `CONTAINS_WORD` > > > > > DateFilters -> (list) > > > > > > Enables filtering based on date and timestamp fields. > > > > > > (structure) > > > > > > > Enables filtering of security findings based on date and timestamp fields in OCSF. > > > > > > > FieldName -> (string) > > > > > > > > The name of the field. > > > > > > > > Possible values: > > > > > > > > * `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 -> (structure) > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > 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. > > > > > > > > > > Possible values: > > > > > > > > > > * `DAYS` > > > > > > > > > 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` . > > > > > > > > > > Possible values: > > > > > > > > > > * `WITHIN` > > > > > > > > > > * `OLDER_THAN` > > > > > BooleanFilters -> (list) > > > > > > Enables filtering based on boolean field values. > > > > > > (structure) > > > > > > > Enables filtering of security findings based on boolean field values in OCSF. > > > > > > > FieldName -> (string) > > > > > > > > The name of the field. > > > > > > > > Possible values: > > > > > > > > * `compliance.assessments.meets_criteria` > > > > > > > > * `vulnerabilities.is_exploit_available` > > > > > > > > * `vulnerabilities.is_fix_available` > > > > > > > Filter -> (structure) > > > > > > > > Boolean filter for querying findings. > > > > > > > > Value -> (boolean) > > > > > > > > > The value of the boolean. > > > > > NumberFilters -> (list) > > > > > > Enables filtering based on numerical field values. > > > > > > (structure) > > > > > > > Enables filtering of security findings based on numerical field values in OCSF. > > > > > > > FieldName -> (string) > > > > > > > > The name of the field. > > > > > > > > Possible values: > > > > > > > > * `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 -> (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. > > > > > > > > Gt -> (double) > > > > > > > > > The greater-than condition to be applied to a single field when querying for findings. > > > > > > > > Lt -> (double) > > > > > > > > > The less-than condition to be applied to a single field when querying for findings. > > > > > MapFilters -> (list) > > > > > > Enables filtering based on map field values. > > > > > > (structure) > > > > > > > Enables filtering of security findings based on map field values in OCSF. > > > > > > > FieldName -> (string) > > > > > > > > The name of the field. > > > > > > > > Possible values: > > > > > > > > * `resources.tags` > > > > > > > > * `compliance.control_parameters` > > > > > > > > * `databucket.tags` > > > > > > > > * `finding_info.tags` > > > > > > > Filter -> (structure) > > > > > > > > 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. > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > 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. > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* . > > > > > > > > > Possible values: > > > > > > > > > * `EQUALS` > > > > > > > > > * `NOT_EQUALS` > > > > > > > > > * `CONTAINS` > > > > > > > > > * `NOT_CONTAINS` > > > > > IpFilters -> (list) > > > > > > A list of IP address filters that allowing you to filter findings based on IP address properties. > > > > > > (structure) > > > > > > > The structure for filtering findings based on IP address attributes. > > > > > > > FieldName -> (string) > > > > > > > > The name of the IP address field to filter on. > > > > > > > > Possible values: > > > > > > > > * `evidences.dst_endpoint.ip` > > > > > > > > * `evidences.src_endpoint.ip` > > > > > > > Filter -> (structure) > > > > > > > > The IP filter for querying findings. > > > > > > > > Cidr -> (string) > > > > > > > > > A finding’s CIDR value. > > > > > > > > > Constraints: > > > > > > > > > * pattern: `.*\S.*` > > > > > 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. > > > > > > (structure) > > > > > > > Enables the creation of filtering criteria for security findings. > > > > > > > StringFilters -> (list) > > > > > > > > Enables filtering based on string field values. > > > > > > > > (structure) > > > > > > > > > Enables filtering of security findings based on string field values in OCSF. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the field. > > > > > > > > > > Possible values: > > > > > > > > > > * `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` > > > > > > > > > > * `impact` > > > > > > > > > > * `likelihood` > > > > > > > > > > * `metadata.product.name` > > > > > > > > > > * `metadata.product.uid` > > > > > > > > > > * `metadata.product.vendor_name` > > > > > > > > > > * `remediation.desc` > > > > > > > > > > * `remediation.references` > > > > > > > > > > * `resources.cloud_partition` > > > > > > > > > > * `resources.criticality` > > > > > > > > > > * `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 -> (structure) > > > > > > > > > > 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. > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* . > > > > > > > > > > > Possible values: > > > > > > > > > > > * `EQUALS` > > > > > > > > > > > * `PREFIX` > > > > > > > > > > > * `NOT_EQUALS` > > > > > > > > > > > * `PREFIX_NOT_EQUALS` > > > > > > > > > > > * `CONTAINS` > > > > > > > > > > > * `NOT_CONTAINS` > > > > > > > > > > > * `CONTAINS_WORD` > > > > > > > DateFilters -> (list) > > > > > > > > Enables filtering based on date and timestamp fields. > > > > > > > > (structure) > > > > > > > > > Enables filtering of security findings based on date and timestamp fields in OCSF. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the field. > > > > > > > > > > Possible values: > > > > > > > > > > * `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 -> (structure) > > > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > > > 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. > > > > > > > > > > > > Possible values: > > > > > > > > > > > > * `DAYS` > > > > > > > > > > > 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` . > > > > > > > > > > > > Possible values: > > > > > > > > > > > > * `WITHIN` > > > > > > > > > > > > * `OLDER_THAN` > > > > > > > BooleanFilters -> (list) > > > > > > > > Enables filtering based on boolean field values. > > > > > > > > (structure) > > > > > > > > > Enables filtering of security findings based on boolean field values in OCSF. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the field. > > > > > > > > > > Possible values: > > > > > > > > > > * `compliance.assessments.meets_criteria` > > > > > > > > > > * `vulnerabilities.is_exploit_available` > > > > > > > > > > * `vulnerabilities.is_fix_available` > > > > > > > > > Filter -> (structure) > > > > > > > > > > Boolean filter for querying findings. > > > > > > > > > > Value -> (boolean) > > > > > > > > > > > The value of the boolean. > > > > > > > NumberFilters -> (list) > > > > > > > > Enables filtering based on numerical field values. > > > > > > > > (structure) > > > > > > > > > Enables filtering of security findings based on numerical field values in OCSF. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the field. > > > > > > > > > > Possible values: > > > > > > > > > > * `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 -> (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. > > > > > > > > > > Gt -> (double) > > > > > > > > > > > The greater-than condition to be applied to a single field when querying for findings. > > > > > > > > > > Lt -> (double) > > > > > > > > > > > The less-than condition to be applied to a single field when querying for findings. > > > > > > > MapFilters -> (list) > > > > > > > > Enables filtering based on map field values. > > > > > > > > (structure) > > > > > > > > > Enables filtering of security findings based on map field values in OCSF. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the field. > > > > > > > > > > Possible values: > > > > > > > > > > * `resources.tags` > > > > > > > > > > * `compliance.control_parameters` > > > > > > > > > > * `databucket.tags` > > > > > > > > > > * `finding_info.tags` > > > > > > > > > Filter -> (structure) > > > > > > > > > > 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. > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > > > 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. > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > > > > 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](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* . > > > > > > > > > > > Possible values: > > > > > > > > > > > * `EQUALS` > > > > > > > > > > > * `NOT_EQUALS` > > > > > > > > > > > * `CONTAINS` > > > > > > > > > > > * `NOT_CONTAINS` > > > > > > > IpFilters -> (list) > > > > > > > > A list of IP address filters that allowing you to filter findings based on IP address properties. > > > > > > > > (structure) > > > > > > > > > The structure for filtering findings based on IP address attributes. > > > > > > > > > FieldName -> (string) > > > > > > > > > > The name of the IP address field to filter on. > > > > > > > > > > Possible values: > > > > > > > > > > * `evidences.dst_endpoint.ip` > > > > > > > > > > * `evidences.src_endpoint.ip` > > > > > > > > > Filter -> (structure) > > > > > > > > > > The IP filter for querying findings. > > > > > > > > > > Cidr -> (string) > > > > > > > > > > > A finding’s CIDR value. > > > > > > > > > > > Constraints: > > > > > > > > > > > * pattern: `.*\S.*` > > > > > > > Operator -> (string) > > > > > > > > The logical operator used to combine multiple filter conditions. > > > > > > > > Possible values: > > > > > > > > * `AND` > > > > > > > > * `OR` > > > > > Operator -> (string) > > > > > > The logical operator used to combine multiple filter conditions. > > > > > > Possible values: > > > > > > * `AND` > > > > > > * `OR` > > > CompositeOperator -> (string) > > > > The logical operators used to combine the filtering on multiple `CompositeFilters` . > > > > Possible values: > > > > * `AND` > > > > * `OR` > > 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` . > > > Constraints: > > > * min: `1` > > > * max: `50` > > > (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. > > > > Possible values: > > > > * `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 -> (structure) > 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. > > (structure) > > > 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. > > > > Constraints: > > > > * pattern: `.*\S.*` > > > 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. > > > > Constraints: > > > > * pattern: `.*\S.*` Destination -> (tagged union structure) > The destination that the export job writes to. > #### NOTE > This is a Tagged Union structure. Only one of the following top level keys can be set: `S3`. > S3 -> (structure) > > 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` . > > > Constraints: > > > * pattern: `.*\S.*` > > 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. > > > Constraints: > > > * pattern: `.*\S.*` > > 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. > > > Constraints: > > > * max: `512` FailureCode -> (string) > A code that classifies why the export job failed. Present only when `Status` is `FAILED` . > Possible values: > * `ACCESS_DENIED` > * `RESOURCE_NOT_FOUND` > * `INTERNAL_ERROR` FailureMessage -> (string) > A human-readable message that provides more detail about why the export job failed. Present only when `Status` is `FAILED` . > Constraints: > * pattern: `.*\S.*` StartedAt -> (timestamp) > The time when the export job was created. > For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . EndedAt -> (timestamp) > 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](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) .