POST

/jobs

http://iotsitewise.{region}.amazonaws.com/jobs

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a bulk import job (CLI)</a> in the Amazon Simple Storage Service User Guide. <important> You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>. </important>

Access Token Required: API Key

Body Params

filesarrayrequired

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

jobNamestringrequired

The unique name that helps identify the job request.

jobRoleArnstringrequired

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.

jobConfigurationobjectrequired

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

errorReportLocationobjectrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iotsitewise.{region}.amazonaws.com/jobs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}