---
title: "POST /jobs"
method: POST
path: "/jobs"
---

# POST /jobs

`POST /jobs`

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see [Create a bulk import job (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html) in the _Amazon Simple Storage Service User Guide_.

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 [PutStorageConfiguration](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html).

## Request body

- object
  - `jobName` string, required — The unique name that helps identify the job request.
  - `jobRoleArn` string, required — 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` File[], required — The files in the specified Amazon S3 bucket that contain your data.
    - `bucket` string, required — The name of the Amazon S3 bucket from which data is imported.
    - `key` string, required — The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
    - `versionId` string — The version ID to identify a specific version of the Amazon S3 object that contains your data.
  - `errorReportLocation` object, required — The Amazon S3 destination where errors associated with the job creation request are saved.
    - `bucket` string — The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
    - `prefix` string — Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.
  - `jobConfiguration` object, required — Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
    - `fileFormat` object — The file format of the data in Amazon S3.
      - `csv` object — The .csv file format.
        - `columnNames` ColumnName[] — The column names specified in the .csv file.

## Response `202`

Success

- CreateBulkImportJobResponse
  - `jobId` string, required — The ID of the job.
  - `jobName` string, required — The unique name that helps identify the job request.
  - `jobStatus` 'PENDING' | 'CANCELLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'COMPLETED_WITH_FAILURES', required — <p>The status of the bulk import job can be one of following values.</p> <ul> <li> <p> <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p> </li> <li> <p> <code>CANCELLED</code> – The bulk import job has been canceled.</p> </li> <li> <p> <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p> </li> <li> <p> <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p> </li> <li> <p> <code>FAILED</code> – 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> – 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>

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceAlreadyExistsException
- `482` — ResourceNotFoundException
- `483` — InternalFailureException
- `484` — ThrottlingException
- `485` — LimitExceededException
- `486` — ConflictingOperationException

---

[API](https://skmtc.net/aws/apis/iotsitewise.md) · [All operations](https://skmtc.net/aws/apis/iotsitewise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotsitewise/versions/d13e5d3e0a6f/schema)