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.Types.JobSummary

Description

 
Synopsis

Documentation

data JobSummary Source #

Contains a job summary information.

See: newJobSummary smart constructor.

Constructors

JobSummary' 

Fields

  • id :: Text

    The ID of the job.

  • name :: Text

    The unique name that helps identify the job request.

  • status :: 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
FromJSON JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

Generic JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

Associated Types

type Rep JobSummary :: Type -> Type #

Read JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

Show JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

NFData JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

Methods

rnf :: JobSummary -> () #

Eq JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

Hashable JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

type Rep JobSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.JobSummary

type Rep JobSummary = D1 ('MetaData "JobSummary" "Amazonka.IoTSiteWise.Types.JobSummary" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "JobSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus))))

newJobSummary Source #

Create a value of JobSummary 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:id:JobSummary', jobSummary_id - The ID of the job.

$sel:name:JobSummary', jobSummary_name - The unique name that helps identify the job request.

$sel:status:JobSummary', jobSummary_status - 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.

jobSummary_id :: Lens' JobSummary Text Source #

The ID of the job.

jobSummary_name :: Lens' JobSummary Text Source #

The unique name that helps identify the job request.

jobSummary_status :: Lens' JobSummary 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.