amazonka-forecast-2.0: Amazon Forecast Service 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.Forecast.Types.DatasetImportJobSummary

Description

 
Synopsis

Documentation

data DatasetImportJobSummary Source #

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the DatasetImportJobArn.

See: newDatasetImportJobSummary smart constructor.

Constructors

DatasetImportJobSummary' 

Fields

  • creationTime :: Maybe POSIX

    When the dataset import job was created.

  • dataSource :: Maybe DataSource

    The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

    If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

  • datasetImportJobArn :: Maybe Text

    The Amazon Resource Name (ARN) of the dataset import job.

  • datasetImportJobName :: Maybe Text

    The name of the dataset import job.

  • lastModificationTime :: Maybe POSIX

    The last time the resource was modified. The timestamp depends on the status of the job:

    • CREATE_PENDING - The CreationTime.
    • CREATE_IN_PROGRESS - The current timestamp.
    • CREATE_STOPPING - The current timestamp.
    • CREATE_STOPPED - When the job stopped.
    • ACTIVE or CREATE_FAILED - When the job finished or failed.
  • message :: Maybe Text

    If an error occurred, an informational message about the error.

  • status :: Maybe Text

    The status of the dataset import job. States include:

    • ACTIVE
    • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    • CREATE_STOPPING, CREATE_STOPPED

Instances

Instances details
FromJSON DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

parseJSON :: Value -> Parser DatasetImportJobSummary #

parseJSONList :: Value -> Parser [DatasetImportJobSummary] #

Generic DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Associated Types

type Rep DatasetImportJobSummary :: Type -> Type #

Methods

from :: DatasetImportJobSummary -> Rep DatasetImportJobSummary x #

to :: Rep DatasetImportJobSummary x -> DatasetImportJobSummary #

Read DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

readsPrec :: Int -> ReadS DatasetImportJobSummary #

readList :: ReadS [DatasetImportJobSummary] #

readPrec :: ReadPrec DatasetImportJobSummary #

readListPrec :: ReadPrec [DatasetImportJobSummary] #

Show DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

showsPrec :: Int -> DatasetImportJobSummary -> ShowS #

show :: DatasetImportJobSummary -> String #

showList :: [DatasetImportJobSummary] -> ShowS #

NFData DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

rnf :: DatasetImportJobSummary -> () #

Eq DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

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

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

Hashable DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

Methods

hashWithSalt :: Int -> DatasetImportJobSummary -> Int #

hash :: DatasetImportJobSummary -> Int #

type Rep DatasetImportJobSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.DatasetImportJobSummary

type Rep DatasetImportJobSummary = D1 ('MetaData "DatasetImportJobSummary" "Amazonka.Forecast.Types.DatasetImportJobSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DatasetImportJobSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSource)) :*: S1 ('MetaSel ('Just "datasetImportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "datasetImportJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDatasetImportJobSummary :: DatasetImportJobSummary Source #

Create a value of DatasetImportJobSummary 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:creationTime:DatasetImportJobSummary', datasetImportJobSummary_creationTime - When the dataset import job was created.

$sel:dataSource:DatasetImportJobSummary', datasetImportJobSummary_dataSource - The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

$sel:datasetImportJobArn:DatasetImportJobSummary', datasetImportJobSummary_datasetImportJobArn - The Amazon Resource Name (ARN) of the dataset import job.

$sel:datasetImportJobName:DatasetImportJobSummary', datasetImportJobSummary_datasetImportJobName - The name of the dataset import job.

$sel:lastModificationTime:DatasetImportJobSummary', datasetImportJobSummary_lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.
  • CREATE_IN_PROGRESS - The current timestamp.
  • CREATE_STOPPING - The current timestamp.
  • CREATE_STOPPED - When the job stopped.
  • ACTIVE or CREATE_FAILED - When the job finished or failed.

$sel:message:DatasetImportJobSummary', datasetImportJobSummary_message - If an error occurred, an informational message about the error.

$sel:status:DatasetImportJobSummary', datasetImportJobSummary_status - The status of the dataset import job. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED

datasetImportJobSummary_creationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #

When the dataset import job was created.

datasetImportJobSummary_dataSource :: Lens' DatasetImportJobSummary (Maybe DataSource) Source #

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset import job.

datasetImportJobSummary_datasetImportJobName :: Lens' DatasetImportJobSummary (Maybe Text) Source #

The name of the dataset import job.

datasetImportJobSummary_lastModificationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.
  • CREATE_IN_PROGRESS - The current timestamp.
  • CREATE_STOPPING - The current timestamp.
  • CREATE_STOPPED - When the job stopped.
  • ACTIVE or CREATE_FAILED - When the job finished or failed.

datasetImportJobSummary_message :: Lens' DatasetImportJobSummary (Maybe Text) Source #

If an error occurred, an informational message about the error.

datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text) Source #

The status of the dataset import job. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED