GetSearchResultExportJob
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.
Request Syntax
GET /export-search-jobs/ExportJobIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ExportJobIdentifier
-
This is the unique string that identifies a specific export job.
Required for this operation.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CompletionTime": number,
"CreationTime": number,
"ExportJobArn": "string",
"ExportJobIdentifier": "string",
"ExportSpecification": { ... },
"SearchJobArn": "string",
"Status": "string",
"StatusMessage": "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.
- CompletionTime
-
The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTimeis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- CreationTime
-
The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTimeis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- ExportJobArn
-
The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
Type: String
- ExportJobIdentifier
-
This is the unique string that identifies the specified export job.
Type: String
- ExportSpecification
-
The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
Type: ExportSpecification object
Note: This object is a Union. Only one member of this object can be specified or returned.
- SearchJobArn
-
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
- Status
-
This is the current status of the export job.
Type: String
Valid Values:
RUNNING | FAILED | COMPLETED - StatusMessage
-
A status message is a string that is returned for search job with a status of
FAILED, along with steps to remedy and retry the operation.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
