StartSearchResultExportJob
此操作会启动一项作业,将搜索作业的结果导出到指定的 S3 存储桶。
请求语法
PUT /export-search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ExportSpecification": { ... },
"RoleArn": "string",
"SearchJobIdentifier": "string",
"Tags": {
"string" : "string"
}
}
URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- ClientToken
-
包含此参数可允许进行多次相同调用,以实现幂等性。
客户端令牌自首次使用该令牌的请求完成后 8 小时内有效。8 小时后,所有具有相同令牌的请求都将视为新请求。
类型:字符串
必需:否
- ExportSpecification
-
此规范包含目标存储桶的必填字符串;您也可以选择包含目标前缀。
类型:ExportSpecification 对象
注意:此对象是 Union 类型。只能指定或返回此对象的一个成员。
必需:是
- RoleArn
-
此参数指定了用于启动搜索结果导出作业的角色 ARN。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
模式:
arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)必需:否
- SearchJobIdentifier
-
指定搜索作业的唯一字符串。
类型:字符串
必需:是
- Tags
-
要包括的可选标签。标签是您可用来管理、筛选和搜索资源的键值对。允许使用的字符包括 UTF-8 字母、数字、空格以及以下字符:+ - = . _ : /。
类型:字符串到字符串映射
必需:否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"ExportJobArn": "string",
"ExportJobIdentifier": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- ExportJobArn
-
这是属于新导出作业的唯一 Amazon 资源名称(ARN)。
类型:字符串
- ExportJobIdentifier
-
这是指定新导出作业的唯一标识符。
类型:字符串
错误
有关所有操作的常见错误信息,请参阅 常见错误。
- AccessDeniedException
-
您没有足够的访问权限,无法执行该操作。
- message
-
用户没有足够的访问权限,无法执行该操作。
HTTP 状态代码:403
- ConflictException
-
当检测到与之前成功执行的操作存在冲突时,会触发此异常。当上一项操作没有时间传播到处理当前请求的主机时,通常会发生这种情况。
对于此异常,建议的应对方式是重试(需配合适当的退避逻辑)。
- message
-
更新或删除资源可能会导致状态不一致。
- resourceId
-
受影响资源的标识符。
- resourceType
-
受影响资源的类型。
HTTP 状态代码:409
- InternalServerException
-
发生内部服务器错误。重试您的请求。
- message
-
请求处理过程中发生意外错误。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
HTTP 状态代码:500
- ResourceNotFoundException
-
未找到此请求所需的资源。
确认资源信息(例如 ARN 或类型)正确无误且存在,然后重试请求。
- message
-
请求引用的资源不存在。
- resourceId
-
受影响资源的假设性标识符。
- resourceType
-
受影响资源的假设性类型。
HTTP 状态代码:404
- ServiceQuotaExceededException
-
由于超出允许的配额限制,请求被拒绝。
- message
-
由于服务配额超过限制,此请求失败。
- quotaCode
-
这是配额类型特有的代码。
- resourceId
-
资源的标识符。
- resourceType
-
资源的类型。
- serviceCode
-
这是具有限额的原始服务所独有的代码。
HTTP 状态代码:402
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
- message
-
由于请求节流,请求失败。
- quotaCode
-
这是具有限额的原始服务所独有的代码。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
- serviceCode
-
这是原始服务所独有的代码。
HTTP 状态代码:429
- ValidationException
-
输入未能满足服务指定的约束条件。
- message
-
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: