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

Amazonka.IoTSiteWise.CreateBulkImportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- jobName :: Text
- jobRoleArn :: Text
- files :: [File]
- errorReportLocation :: ErrorReportLocation
- jobConfiguration :: JobConfiguration
}
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' {
- httpStatus :: Int
- jobId :: Text
- jobName :: Text
- jobStatus :: JobStatus
}
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.

Constructors

CreateBulkImportJob'

Fields

jobName :: Text
The unique name that helps identify the job request.
jobRoleArn :: Text
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
files :: [File]
The files in the specified Amazon S3 bucket that contain your data.
errorReportLocation :: ErrorReportLocation
The Amazon S3 destination where errors associated with the job creation request are saved.
jobConfiguration :: JobConfiguration
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

Instances

Instances details

ToJSON CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods toJSON :: CreateBulkImportJob -> Value # toEncoding :: CreateBulkImportJob -> Encoding # toJSONList :: [CreateBulkImportJob] -> Value # toEncodingList :: [CreateBulkImportJob] -> Encoding #
ToHeaders CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods toHeaders :: CreateBulkImportJob -> [Header] #
ToPath CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods toPath :: CreateBulkImportJob -> ByteString #
ToQuery CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods toQuery :: CreateBulkImportJob -> QueryString #
AWSRequest CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Associated Types type AWSResponse CreateBulkImportJob # Methods request :: (Service -> Service) -> CreateBulkImportJob -> Request CreateBulkImportJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBulkImportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBulkImportJob))) #
Generic CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Associated Types type Rep CreateBulkImportJob :: Type -> Type # Methods from :: CreateBulkImportJob -> Rep CreateBulkImportJob x # to :: Rep CreateBulkImportJob x -> CreateBulkImportJob #
Read CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods readsPrec :: Int -> ReadS CreateBulkImportJob # readList :: ReadS [CreateBulkImportJob] # readPrec :: ReadPrec CreateBulkImportJob # readListPrec :: ReadPrec [CreateBulkImportJob] #
Show CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods showsPrec :: Int -> CreateBulkImportJob -> ShowS # show :: CreateBulkImportJob -> String # showList :: [CreateBulkImportJob] -> ShowS #
NFData CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods rnf :: CreateBulkImportJob -> () #
Eq CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods (==) :: CreateBulkImportJob -> CreateBulkImportJob -> Bool # (/=) :: CreateBulkImportJob -> CreateBulkImportJob -> Bool #
Hashable CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods hashWithSalt :: Int -> CreateBulkImportJob -> Int # hash :: CreateBulkImportJob -> Int #
type AWSResponse CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob type AWSResponse CreateBulkImportJob = CreateBulkImportJobResponse
type Rep CreateBulkImportJob Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob type Rep CreateBulkImportJob = D1 ('MetaData "CreateBulkImportJob" "Amazonka.IoTSiteWise.CreateBulkImportJob" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateBulkImportJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [File]) :: (S1 ('MetaSel ('Just "errorReportLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorReportLocation) :: S1 ('MetaSel ('Just "jobConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobConfiguration)))))

newCreateBulkImportJob Source #

Arguments

:: Text	`CreateBulkImportJob`
-> Text	`$sel:jobRoleArn:CreateBulkImportJob'`
-> ErrorReportLocation	`$sel:errorReportLocation:CreateBulkImportJob'`
-> JobConfiguration	`$sel:jobConfiguration:CreateBulkImportJob'`
-> CreateBulkImportJob

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.

Constructors

CreateBulkImportJobResponse'

Fields

httpStatus :: Int
The response's http status code.
jobId :: Text
The ID of the job.
jobName :: Text
The unique name that helps identify the job request.
jobStatus :: 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.

Instances

Instances details

Generic CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Associated Types type Rep CreateBulkImportJobResponse :: Type -> Type # Methods from :: CreateBulkImportJobResponse -> Rep CreateBulkImportJobResponse x # to :: Rep CreateBulkImportJobResponse x -> CreateBulkImportJobResponse #
Read CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods readsPrec :: Int -> ReadS CreateBulkImportJobResponse # readList :: ReadS [CreateBulkImportJobResponse] # readPrec :: ReadPrec CreateBulkImportJobResponse # readListPrec :: ReadPrec [CreateBulkImportJobResponse] #
Show CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods showsPrec :: Int -> CreateBulkImportJobResponse -> ShowS # show :: CreateBulkImportJobResponse -> String # showList :: [CreateBulkImportJobResponse] -> ShowS #
NFData CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods rnf :: CreateBulkImportJobResponse -> () #
Eq CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob Methods (==) :: CreateBulkImportJobResponse -> CreateBulkImportJobResponse -> Bool # (/=) :: CreateBulkImportJobResponse -> CreateBulkImportJobResponse -> Bool #
type Rep CreateBulkImportJobResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.CreateBulkImportJob type Rep CreateBulkImportJobResponse = D1 ('MetaData "CreateBulkImportJobResponse" "Amazonka.IoTSiteWise.CreateBulkImportJob" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateBulkImportJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus))))

newCreateBulkImportJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBulkImportJobResponse'`
-> Text	`$sel:jobId:CreateBulkImportJobResponse'`
-> Text	`CreateBulkImportJob`
-> JobStatus	`$sel:jobStatus:CreateBulkImportJobResponse'`
-> 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.