GetSearchResultExportJob
此操作可检索导出作业的元数据。
导出作业是一项将搜索作业的结果传输到 .csv 文件中的指定 S3 存储桶的操作。
导出作业可让您将搜索结果保留超过搜索作业预设的 7 天保留期限。
请求语法
GET /export-search-jobs/ExportJobIdentifier HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- ExportJobIdentifier
-
这是标识特定导出作业的唯一字符串。
对于此操作来说是必填项。
必需:是
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"CompletionTime": number,
"CreationTime": number,
"ExportJobArn": "string",
"ExportJobIdentifier": "string",
"ExportSpecification": { ... },
"SearchJobArn": "string",
"Status": "string",
"StatusMessage": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- CompletionTime
-
导出作业的完成日期和时间,采用 Unix 格式和协调世界时(UTC)。
CreationTime的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- CreationTime
-
导出作业的创建日期和时间,采用 Unix 时间格式和协调世界时(UTC)。
CreationTime的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- ExportJobArn
-
唯一标识导出作业的唯一 Amazon 资源名称(ARN)。
类型:字符串
- ExportJobIdentifier
-
这是标识指定导出作业的唯一字符串。
类型:字符串
- ExportSpecification
-
导出规范由搜索结果导出到的目标 S3 存储桶以及目标前缀组成。
类型:ExportSpecification 对象
注意:此对象是 Union 类型。只能指定或返回此对象的一个成员。
- SearchJobArn
-
标识指定搜索作业的 Amazon 资源名称(ARN)的唯一字符串。
类型:字符串
- Status
-
这是导出作业的当前状态。
类型:字符串
有效值:
RUNNING | FAILED | COMPLETED - StatusMessage
-
状态消息是针对状态为
FAILED的搜索作业返回的字符串,其中包含补救和重试操作的步骤。类型:字符串
错误
有关所有操作的常见错误信息,请参阅 常见错误。
- AccessDeniedException
-
您没有足够的访问权限,无法执行该操作。
- message
-
用户没有足够的访问权限,无法执行该操作。
HTTP 状态代码:403
- InternalServerException
-
发生内部服务器错误。重试您的请求。
- message
-
请求处理过程中发生意外错误。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
HTTP 状态代码:500
- ResourceNotFoundException
-
未找到此请求所需的资源。
确认资源信息(例如 ARN 或类型)正确无误且存在,然后重试请求。
- message
-
请求引用的资源不存在。
- resourceId
-
受影响资源的假设性标识符。
- resourceType
-
受影响资源的假设性类型。
HTTP 状态代码:404
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
- message
-
由于请求节流,请求失败。
- quotaCode
-
这是具有限额的原始服务所独有的代码。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
- serviceCode
-
这是原始服务所独有的代码。
HTTP 状态代码:429
- ValidationException
-
输入未能满足服务指定的约束条件。
- message
-
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: