amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.DescribeBulkImportJob

Description

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

Synopsis

Creating a Request

data DescribeBulkImportJob Source #

See: newDescribeBulkImportJob smart constructor.

Constructors

DescribeBulkImportJob' 

Fields

Instances

Instances details
ToHeaders DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

toHeaders :: DescribeBulkImportJob -> [Header] #

ToPath DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

toPath :: DescribeBulkImportJob -> ByteString #

ToQuery DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

toQuery :: DescribeBulkImportJob -> QueryString #

AWSRequest DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Associated Types

type AWSResponse DescribeBulkImportJob #

Methods

request :: (Service -> Service) -> DescribeBulkImportJob -> Request DescribeBulkImportJob #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBulkImportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBulkImportJob))) #

Generic DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Associated Types

type Rep DescribeBulkImportJob :: Type -> Type #

Methods

from :: DescribeBulkImportJob -> Rep DescribeBulkImportJob x #

to :: Rep DescribeBulkImportJob x -> DescribeBulkImportJob #

Read DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

readsPrec :: Int -> ReadS DescribeBulkImportJob #

readList :: ReadS [DescribeBulkImportJob] #

readPrec :: ReadPrec DescribeBulkImportJob #

readListPrec :: ReadPrec [DescribeBulkImportJob] #

Show DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

showsPrec :: Int -> DescribeBulkImportJob -> ShowS #

show :: DescribeBulkImportJob -> String #

showList :: [DescribeBulkImportJob] -> ShowS #

NFData DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

rnf :: DescribeBulkImportJob -> () #

Eq DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

(==) :: DescribeBulkImportJob -> DescribeBulkImportJob -> Bool #

(/=) :: DescribeBulkImportJob -> DescribeBulkImportJob -> Bool #

Hashable DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

hashWithSalt :: Int -> DescribeBulkImportJob -> Int #

hash :: DescribeBulkImportJob -> Int #

type AWSResponse DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

type AWSResponse DescribeBulkImportJob = DescribeBulkImportJobResponse
type Rep DescribeBulkImportJob Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

type Rep DescribeBulkImportJob = D1 ('MetaData "DescribeBulkImportJob" "Amazonka.IoTSiteWise.DescribeBulkImportJob" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeBulkImportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeBulkImportJob Source #

Arguments

:: Text

DescribeBulkImportJob

-> DescribeBulkImportJob 

Create a value of DescribeBulkImportJob 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:

DescribeBulkImportJob, describeBulkImportJob_jobId - The ID of the job.

Request Lenses

describeBulkImportJob_jobId :: Lens' DescribeBulkImportJob Text Source #

The ID of the job.

Destructuring the Response

data DescribeBulkImportJobResponse Source #

See: newDescribeBulkImportJobResponse smart constructor.

Constructors

DescribeBulkImportJobResponse' 

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.
  • 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.

  • jobCreationDate :: POSIX

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

  • jobLastUpdateDate :: POSIX

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

Instances

Instances details
Generic DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Associated Types

type Rep DescribeBulkImportJobResponse :: Type -> Type #

Methods

from :: DescribeBulkImportJobResponse -> Rep DescribeBulkImportJobResponse x #

to :: Rep DescribeBulkImportJobResponse x -> DescribeBulkImportJobResponse #

Read DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

readsPrec :: Int -> ReadS DescribeBulkImportJobResponse #

readList :: ReadS [DescribeBulkImportJobResponse] #

readPrec :: ReadPrec DescribeBulkImportJobResponse #

readListPrec :: ReadPrec [DescribeBulkImportJobResponse] #

Show DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

showsPrec :: Int -> DescribeBulkImportJobResponse -> ShowS #

show :: DescribeBulkImportJobResponse -> String #

showList :: [DescribeBulkImportJobResponse] -> ShowS #

NFData DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

rnf :: DescribeBulkImportJobResponse -> () #

Eq DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

Methods

(==) :: DescribeBulkImportJobResponse -> DescribeBulkImportJobResponse -> Bool #

(/=) :: DescribeBulkImportJobResponse -> DescribeBulkImportJobResponse -> Bool #

type Rep DescribeBulkImportJobResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DescribeBulkImportJob

type Rep DescribeBulkImportJobResponse = D1 ('MetaData "DescribeBulkImportJobResponse" "Amazonka.IoTSiteWise.DescribeBulkImportJob" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeBulkImportJobResponse'" '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) :*: 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) :*: (S1 ('MetaSel ('Just "jobCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "jobLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeBulkImportJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeBulkImportJobResponse'

-> Text

DescribeBulkImportJob

-> Text

$sel:jobName:DescribeBulkImportJobResponse'

-> JobStatus

$sel:jobStatus:DescribeBulkImportJobResponse'

-> Text

$sel:jobRoleArn:DescribeBulkImportJobResponse'

-> ErrorReportLocation

$sel:errorReportLocation:DescribeBulkImportJobResponse'

-> JobConfiguration

$sel:jobConfiguration:DescribeBulkImportJobResponse'

-> UTCTime

$sel:jobCreationDate:DescribeBulkImportJobResponse'

-> UTCTime

$sel:jobLastUpdateDate:DescribeBulkImportJobResponse'

-> DescribeBulkImportJobResponse 

Create a value of DescribeBulkImportJobResponse 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:DescribeBulkImportJobResponse', describeBulkImportJobResponse_httpStatus - The response's http status code.

DescribeBulkImportJob, describeBulkImportJobResponse_jobId - The ID of the job.

$sel:jobName:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobName - The unique name that helps identify the job request.

$sel:jobStatus:DescribeBulkImportJobResponse', describeBulkImportJobResponse_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.

$sel:jobRoleArn:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobRoleArn - The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

$sel:files:DescribeBulkImportJobResponse', describeBulkImportJobResponse_files - The files in the specified Amazon S3 bucket that contain your data.

$sel:errorReportLocation:DescribeBulkImportJobResponse', describeBulkImportJobResponse_errorReportLocation - The Amazon S3 destination where errors associated with the job creation request are saved.

$sel:jobConfiguration:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobConfiguration - Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

$sel:jobCreationDate:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobCreationDate - The date the job was created, in Unix epoch TIME.

$sel:jobLastUpdateDate:DescribeBulkImportJobResponse', describeBulkImportJobResponse_jobLastUpdateDate - The date the job was last updated, in Unix epoch time.

Response Lenses

describeBulkImportJobResponse_httpStatus :: Lens' DescribeBulkImportJobResponse Int Source #

The response's http status code.

describeBulkImportJobResponse_jobId :: Lens' DescribeBulkImportJobResponse Text Source #

The ID of the job.

describeBulkImportJobResponse_jobName :: Lens' DescribeBulkImportJobResponse Text Source #

The unique name that helps identify the job request.

describeBulkImportJobResponse_jobStatus :: Lens' DescribeBulkImportJobResponse 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.

describeBulkImportJobResponse_jobRoleArn :: Lens' DescribeBulkImportJobResponse Text Source #

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

describeBulkImportJobResponse_files :: Lens' DescribeBulkImportJobResponse [File] Source #

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

describeBulkImportJobResponse_errorReportLocation :: Lens' DescribeBulkImportJobResponse ErrorReportLocation Source #

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

describeBulkImportJobResponse_jobConfiguration :: Lens' DescribeBulkImportJobResponse JobConfiguration Source #

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

describeBulkImportJobResponse_jobCreationDate :: Lens' DescribeBulkImportJobResponse UTCTime Source #

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

describeBulkImportJobResponse_jobLastUpdateDate :: Lens' DescribeBulkImportJobResponse UTCTime Source #

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