Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListExportJobsV2

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.

Request Syntax


GET /exportjobsv2?DataType=DataType&MaxResults=MaxResults&NextToken=NextToken&Status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DataType

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

Valid Values: FINDINGS

MaxResults

The maximum number of results to return in a single call. Valid range is 1–20.

Valid Range: Minimum value of 1. Maximum value of 20.

NextToken

The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

Status

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

Valid Values: RUNNING | SUCCEEDED | FAILED | CANCELLED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "DataType": "string",
         "Destination": { ... },
         "EndedAt": "string",
         "ExportJobId": "string",
         "FailureCode": "string",
         "FailureMessage": "string",
         "Name": "string",
         "OutputConfiguration": { ... },
         "Scopes": { 
            "AwsOrganizations": [ 
               { 
                  "OrganizationalUnitId": "string",
                  "OrganizationId": "string"
               }
            ]
         },
         "StartedAt": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Items

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

Type: Array of ExportSummary objects

NextToken

The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400