Amazon IoT SiteWise · Schema
DescribeBulkImportJobResponse
DescribeBulkImportJobResponse schema
Asset ManagementIndustrial IoTIoTTime Series Data
Properties
| Name | Type | Description |
|---|---|---|
| jobId | object | |
| jobName | object | |
| jobStatus | object | |
| jobRoleArn | object | |
| files | object | |
| errorReportLocation | object | |
| jobConfiguration | object | |
| jobCreationDate | object | |
| jobLastUpdateDate | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-describe-bulk-import-job-response-schema.json",
"title": "DescribeBulkImportJobResponse",
"description": "DescribeBulkImportJobResponse schema",
"type": "object",
"properties": {
"jobId": {
"allOf": [
{
"$ref": "#/components/schemas/ID"
},
{
"description": "The ID of the job."
}
]
},
"jobName": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "The unique name that helps identify the job request."
}
]
},
"jobStatus": {
"allOf": [
{
"$ref": "#/components/schemas/JobStatus"
},
{
"description": "<p>The status of the bulk import job can be one of following values.</p> <ul> <li> <p> <code>PENDING</code> \u2013 IoT SiteWise is waiting for the current bulk import job to finish.</p> </li> <li> <p> <code>CANCELLED</code> \u2013 The bulk import job has been canceled.</p> </li> <li> <p> <code>RUNNING</code> \u2013 IoT SiteWise is processing your request to import your data from Amazon S3.</p> </li> <li> <p> <code>COMPLETED</code> \u2013 IoT SiteWise successfully completed your request to import data from Amazon S3.</p> </li> <li> <p> <code>FAILED</code> \u2013 IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p> </li> <li> <p> <code>COMPLETED_WITH_FAILURES</code> \u2013 IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p> </li> </ul>"
}
]
},
"jobRoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/ARN"
},
{
"description": "The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data."
}
]
},
"files": {
"allOf": [
{
"$ref": "#/components/schemas/Files"
},
{
"description": "The files in the specified Amazon S3 bucket that contain your data."
}
]
},
"errorReportLocation": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorReportLocation"
},
{
"description": "The Amazon S3 destination where errors associated with the job creation request are saved."
}
]
},
"jobConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/JobConfiguration"
},
{
"description": "Contains the configuration information of a job, such as the file format used to save data in Amazon S3."
}
]
},
"jobCreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date the job was created, in Unix epoch TIME."
}
]
},
"jobLastUpdateDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date the job was last updated, in Unix epoch time."
}
]
}
},
"required": [
"jobId",
"jobName",
"jobStatus",
"jobRoleArn",
"files",
"errorReportLocation",
"jobConfiguration",
"jobCreationDate",
"jobLastUpdateDate"
]
}