Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) 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.
Synopsis
- data CreateBulkImportJob = CreateBulkImportJob' {}
- newCreateBulkImportJob :: Text -> Text -> ErrorReportLocation -> JobConfiguration -> CreateBulkImportJob
- createBulkImportJob_jobName :: Lens' CreateBulkImportJob Text
- createBulkImportJob_jobRoleArn :: Lens' CreateBulkImportJob Text
- createBulkImportJob_files :: Lens' CreateBulkImportJob [File]
- createBulkImportJob_errorReportLocation :: Lens' CreateBulkImportJob ErrorReportLocation
- createBulkImportJob_jobConfiguration :: Lens' CreateBulkImportJob JobConfiguration
- data CreateBulkImportJobResponse = CreateBulkImportJobResponse' {}
- newCreateBulkImportJobResponse :: Int -> Text -> Text -> JobStatus -> CreateBulkImportJobResponse
- createBulkImportJobResponse_httpStatus :: Lens' CreateBulkImportJobResponse Int
- createBulkImportJobResponse_jobId :: Lens' CreateBulkImportJobResponse Text
- createBulkImportJobResponse_jobName :: Lens' CreateBulkImportJobResponse Text
- createBulkImportJobResponse_jobStatus :: Lens' CreateBulkImportJobResponse JobStatus
Creating a Request
data CreateBulkImportJob Source #
See: newCreateBulkImportJob
smart constructor.
CreateBulkImportJob' | |
|
Instances
newCreateBulkImportJob Source #
Create a value of CreateBulkImportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBulkImportJob
, createBulkImportJob_jobName
- The unique name that helps identify the job request.
$sel:jobRoleArn:CreateBulkImportJob'
, createBulkImportJob_jobRoleArn
- The
ARN
of the IAM role that allows IoT SiteWise to read Amazon S3 data.
$sel:files:CreateBulkImportJob'
, createBulkImportJob_files
- The files in the specified Amazon S3 bucket that contain your data.
$sel:errorReportLocation:CreateBulkImportJob'
, createBulkImportJob_errorReportLocation
- The Amazon S3 destination where errors associated with the job creation
request are saved.
$sel:jobConfiguration:CreateBulkImportJob'
, createBulkImportJob_jobConfiguration
- Contains the configuration information of a job, such as the file format
used to save data in Amazon S3.
Request Lenses
createBulkImportJob_jobName :: Lens' CreateBulkImportJob Text Source #
The unique name that helps identify the job request.
createBulkImportJob_jobRoleArn :: Lens' CreateBulkImportJob Text Source #
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
createBulkImportJob_files :: Lens' CreateBulkImportJob [File] Source #
The files in the specified Amazon S3 bucket that contain your data.
createBulkImportJob_errorReportLocation :: Lens' CreateBulkImportJob ErrorReportLocation Source #
The Amazon S3 destination where errors associated with the job creation request are saved.
createBulkImportJob_jobConfiguration :: Lens' CreateBulkImportJob JobConfiguration Source #
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
Destructuring the Response
data CreateBulkImportJobResponse Source #
See: newCreateBulkImportJobResponse
smart constructor.
CreateBulkImportJobResponse' | |
|
Instances
newCreateBulkImportJobResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> JobStatus | |
-> CreateBulkImportJobResponse |
Create a value of CreateBulkImportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBulkImportJobResponse'
, createBulkImportJobResponse_httpStatus
- The response's http status code.
$sel:jobId:CreateBulkImportJobResponse'
, createBulkImportJobResponse_jobId
- The ID of the job.
CreateBulkImportJob
, createBulkImportJobResponse_jobName
- The unique name that helps identify the job request.
$sel:jobStatus:CreateBulkImportJobResponse'
, createBulkImportJobResponse_jobStatus
- The status of the bulk import job can be one of following values.
PENDING
– IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED
– The bulk import job has been canceled.RUNNING
– IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED
– IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED
– 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
– 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.
Response Lenses
createBulkImportJobResponse_httpStatus :: Lens' CreateBulkImportJobResponse Int Source #
The response's http status code.
createBulkImportJobResponse_jobId :: Lens' CreateBulkImportJobResponse Text Source #
The ID of the job.
createBulkImportJobResponse_jobName :: Lens' CreateBulkImportJobResponse Text Source #
The unique name that helps identify the job request.
createBulkImportJobResponse_jobStatus :: Lens' CreateBulkImportJobResponse JobStatus Source #
The status of the bulk import job can be one of following values.
PENDING
– IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED
– The bulk import job has been canceled.RUNNING
– IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED
– IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED
– 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
– 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.