AWS Security Hub · Schema

StartExportJobV2Request

SecurityCloud Security Posture ManagementComplianceFindingsThreat DetectionCloudAmazon Web Services

Properties

Name Type Description
Name 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 c
Destination object
OutputConfiguration object
Scopes object
ClientToken string A unique identifier used to ensure idempotency.
View JSON Schema on GitHub

JSON Schema

aws-security-hub-start-export-job-v2-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aws-security-hub/json-schema/aws-security-hub-start-export-job-v2-request-schema.json",
  "title": "StartExportJobV2Request",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aws-security-hub-exportjobsv2-api-openapi.yml#/components/schemas/StartExportJobV2Request",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "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: . _ , : ( ) / + -."
    },
    "Destination": {
      "$ref": "#/$defs/ExportDestination"
    },
    "OutputConfiguration": {
      "$ref": "#/$defs/ExportOutput"
    },
    "Scopes": {
      "$ref": "#/$defs/ExportScopes"
    },
    "ClientToken": {
      "type": "string",
      "description": "A unique identifier used to ensure idempotency."
    }
  },
  "required": [
    "Destination",
    "OutputConfiguration"
  ],
  "$defs": {
    "AwsOrganizationScope": {
      "type": "object",
      "properties": {
        "OrganizationId": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "description": "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."
        }
      }
    },
    "BooleanFilter": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "boolean",
          "description": "The value of the boolean."
        }
      }
    },
    "CompositeFilter": {
      "type": "object",
      "properties": {
        "StringFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfStringFilter"
          },
          "description": "Enables filtering based on string field values."
        },
        "DateFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfDateFilter"
          },
          "description": "Enables filtering based on date and timestamp fields."
        },
        "BooleanFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfBooleanFilter"
          },
          "description": "Enables filtering based on boolean field values."
        },
        "NumberFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfNumberFilter"
          },
          "description": "Enables filtering based on numerical field values."
        },
        "MapFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfMapFilter"
          },
          "description": "Enables filtering based on map field values."
        },
        "IpFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcsfIpFilter"
          },
          "description": "A list of IP address filters that allowing you to filter findings based on IP address properties."
        },
        "NestedCompositeFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CompositeFilter"
          },
          "description": "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": {
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ],
          "description": "The logical operator used to combine multiple filter conditions."
        }
      }
    },
    "DateFilter": {
      "type": "object",
      "properties": {
        "Start": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "description": "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": {
          "$ref": "#/$defs/DateRange"
        }
      }
    },
    "DateRange": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "integer",
          "description": "A date range value for the date filter."
        },
        "Unit": {
          "type": "string",
          "enum": [
            "DAYS"
          ],
          "description": "A date range unit for the date filter."
        },
        "Comparison": {
          "type": "string",
          "enum": [
            "WITHIN",
            "OLDER_THAN"
          ],
          "description": "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."
        }
      }
    },
    "ExportDestination": {
      "type": "object",
      "properties": {
        "S3": {
          "$ref": "#/$defs/S3ExportDestination"
        }
      },
      "description": "Exactly one member is set."
    },
    "ExportOutput": {
      "type": "object",
      "properties": {
        "Findings": {
          "$ref": "#/$defs/FindingsOutput"
        }
      },
      "description": "Exactly one member is set."
    },
    "ExportScopes": {
      "type": "object",
      "properties": {
        "AwsOrganizations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AwsOrganizationScope"
          },
          "description": "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."
        }
      }
    },
    "FindingsOutput": {
      "type": "object",
      "properties": {
        "Format": {
          "type": "string",
          "enum": [
            "CSV",
            "OCSF_JSON"
          ],
          "description": "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": {
          "$ref": "#/$defs/OcsfFindingFilters"
        },
        "SelectedFields": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "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"
            ]
          },
          "description": "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."
        }
      },
      "required": [
        "Format"
      ]
    },
    "IpFilter": {
      "type": "object",
      "properties": {
        "Cidr": {
          "type": "string",
          "description": "A finding's CIDR value."
        }
      }
    },
    "MapFilter": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "enum": [
            "EQUALS",
            "NOT_EQUALS",
            "CONTAINS",
            "NOT_CONTAINS"
          ],
          "description": "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 "
        }
      }
    },
    "NumberFilter": {
      "type": "object",
      "properties": {
        "Gte": {
          "type": "number",
          "description": "The greater-than-equal condition to be applied to a single field when querying for findings."
        },
        "Lte": {
          "type": "number",
          "description": "The less-than-equal condition to be applied to a single field when querying for findings."
        },
        "Eq": {
          "type": "number",
          "description": "The equal-to condition to be applied to a single field when querying for findings."
        },
        "Gt": {
          "type": "number",
          "description": "The greater-than condition to be applied to a single field when querying for findings."
        },
        "Lt": {
          "type": "number",
          "description": "The less-than condition to be applied to a single field when querying for findings."
        }
      }
    },
    "OcsfBooleanFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "compliance.assessments.meets_criteria",
            "vulnerabilities.is_exploit_available",
            "vulnerabilities.is_fix_available"
          ],
          "description": "The name of the field."
        },
        "Filter": {
          "$ref": "#/$defs/BooleanFilter"
        }
      }
    },
    "OcsfDateFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "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"
          ],
          "description": "The name of the field."
        },
        "Filter": {
          "$ref": "#/$defs/DateFilter"
        }
      }
    },
    "OcsfFindingFilters": {
      "type": "object",
      "properties": {
        "CompositeFilters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CompositeFilter"
          },
          "description": "Enables the creation of complex filtering conditions by combining filter criteria."
        },
        "CompositeOperator": {
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ],
          "description": "The logical operators used to combine the filtering on multiple CompositeFilters."
        }
      }
    },
    "OcsfIpFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "evidences.dst_endpoint.ip",
            "evidences.src_endpoint.ip"
          ],
          "description": "The name of the IP address field to filter on."
        },
        "Filter": {
          "$ref": "#/$defs/IpFilter"
        }
      }
    },
    "OcsfMapFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "resources.tags",
            "compliance.control_parameters",
            "databucket.tags",
            "finding_info.tags"
          ],
          "description": "The name of the field."
        },
        "Filter": {
          "$ref": "#/$defs/MapFilter"
        }
      }
    },
    "OcsfNumberFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "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"
          ],
          "description": "The name of the field."
        },
        "Filter": {
          "$ref": "#/$defs/NumberFilter"
        }
      }
    },
    "OcsfStringFilter": {
      "type": "object",
      "properties": {
        "FieldName": {
          "type": "string",
          "enum": [
            "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"
          ],
          "description": "The name of the field."
        },
        "Filter": {
          "$ref": "#/$defs/StringFilter"
        }
      }
    },
    "S3ExportDestination": {
      "type": "object",
      "properties": {
        "BucketArn": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "description": "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 "
        },
        "ObjectPrefix": {
          "type": "string",
          "description": "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."
        }
      },
      "required": [
        "BucketArn",
        "KmsKeyArn"
      ]
    },
    "StringFilter": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "enum": [
            "EQUALS",
            "PREFIX",
            "NOT_EQUALS",
            "PREFIX_NOT_EQUALS",
            "CONTAINS",
            "NOT_CONTAINS",
            "CONTAINS_WORD"
          ],
          "description": "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 "
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aws-security-hub-start-export-job-v2-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.