DescribeBulkImportJob - AWS IoT SiteWise

DescribeBulkImportJob

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (AWS CLI) in the Amazon Simple Storage Service User Guide.

Request Syntax

GET /jobs/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId

The ID of the job.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "errorReportLocation": { "bucket": "string", "prefix": "string" }, "files": [ { "bucket": "string", "key": "string", "versionId": "string" } ], "jobConfiguration": { "fileFormat": { "csv": { "columnNames": [ "string" ] } } }, "jobCreationDate": number, "jobId": "string", "jobLastUpdateDate": number, "jobName": "string", "jobRoleArn": "string", "jobStatus": "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.

errorReportLocation

The Amazon S3 destination where errors associated with the job creation request are saved.

Type: ErrorReportLocation object

files

The files in the specified Amazon S3 bucket that contain your data.

Type: Array of File objects

jobConfiguration

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

Type: JobConfiguration object

jobCreationDate

The date the job was created, in Unix epoch TIME.

Type: Timestamp

jobId

The ID of the job.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

jobLastUpdateDate

The date the job was last updated, in Unix epoch time.

Type: Timestamp

jobName

The unique name that helps identify the job request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

jobRoleArn

The ARN of the IAM role that allows AWS IoT SiteWise to read Amazon S3 data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: .*

jobStatus

The status of the bulk import job can be one of following values.

  • PENDING – AWS IoT SiteWise is waiting for the current bulk import job to finish.

  • CANCELLED – The bulk import job has been canceled.

  • RUNNING – AWS IoT SiteWise is processing your request to import your data from Amazon S3.

  • COMPLETED – AWS IoT SiteWise successfully completed your request to import data from Amazon S3.

  • FAILED – AWS 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.

  • COMPLETED_WITH_FAILURES – AWS 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.

Type: String

Valid Values: PENDING | CANCELLED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_FAILURES

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: