AWS CLI Command Reference

[ aws . securityhub ]

list-export-jobs-v2

Description

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

list-export-jobs-v2 is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Items

Synopsis

  list-export-jobs-v2
[--status <value>]
[--data-type <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--status (string)

Filters the results to export jobs that have the specified status.

Possible values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED

--data-type (string)

Filters the results to export jobs that produce the specified data type.

Possible values:

  • FINDINGS

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 20

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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

Output

Items -> (list)

The export jobs that match the request, as ExportSummary objects.

(structure)

A summary of an export job, as returned by ListExportJobsV2 .

ExportJobId -> (string) [required]

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.

Constraints:

  • min: 1
  • max: 256

Status -> (string) [required]

The current state of the export job.

Possible values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED

DataType -> (string) [required]

The category of data that the export job produces.

Possible values:

  • FINDINGS

OutputConfiguration -> (tagged union structure)

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.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Findings.

Findings -> (structure)

The output configuration summary for a findings export.

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

Scopes -> (structure)

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.

(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) [required]

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 about why the export job failed. Present only when Status is FAILED .

Constraints:

  • pattern: .*\S.*

StartedAt -> (timestamp) [required]

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 -> (timestamp)

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.
© Copyright 2026, Amazon Web Services. Created using Sphinx.