Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14128667.3 KB

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

get/export-search-jobs/{ExportJobIdentifier}

Path parameters

ExportJobIdentifierstring required
<p>This is the unique string that identifies a specific export job.</p> <p>Required for this operation.</p>

Response

Success

ExportJobIdentifierstring required

This is the unique string that identifies the specified export job.

ExportJobArnstring

The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

Status'RUNNING' | 'FAILED' | 'COMPLETED'

This is the current status of the export job.

CreationTimestring date-time

The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CompletionTimestring date-time

The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

StatusMessagestring

A status message is a string that is returned for search job with a status of <code>FAILED</code>, along with steps to remedy and retry the operation.

SearchJobArnstring

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.