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

StartSearchResultExportJob

This operations starts a job to export the results of search job to a designated S3 bucket.

Request Syntax


PUT /export-search-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ExportSpecification": { ... },
   "RoleArn": "string",
   "SearchJobIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

Type: String

Required: No

ExportSpecification

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

Type: ExportSpecification object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

RoleArn

This parameter specifies the role ARN used to start the search results export jobs.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)

Required: No

SearchJobIdentifier

The unique string that specifies the search job.

Type: String

Required: Yes

Tags

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ExportJobArn": "string",
   "ExportJobIdentifier": "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.

ExportJobArn

This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

Type: String

ExportJobIdentifier

This is the unique identifier that specifies the new export job.

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.

message: User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

message: Updating or deleting a resource can cause an inconsistent state.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Retry your request.

message: Unexpected error during processing of request.
retryAfterSeconds: Retry the call after number of seconds.

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.

message: Request references a resource which does not exist.
resourceId: Hypothetical identifier of the resource affected.
resourceType: Hypothetical type of the resource affected.

HTTP Status Code: 404

ServiceQuotaExceededException

The request denied due to exceeding the quota limits permitted.

message: This request was not successful due to a service quota exceeding limits.
quotaCode: This is the code specific to the quota type.
resourceId: Identifier of the resource.
resourceType: Type of resource.
serviceCode: This is the code unique to the originating service with the quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

message: Request was unsuccessful due to request throttling.
quotaCode: This is the code unique to the originating service with the quota.
retryAfterSeconds: Retry the call after number of seconds.
serviceCode: This is the code unique to the originating service.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by a service.

message: The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400