Amazonka.Forecast.Types.ForecastExportJobSummary

Documentation

data ForecastExportJobSummary

Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.

See: newForecastExportJobSummary smart constructor.

Constructors

ForecastExportJobSummary'

Fields

• creationTime :: Maybe POSIX

  When the forecast export job was created.

• destination :: Maybe DataDestination

  The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

• forecastExportJobArn :: Maybe Text

  The Amazon Resource Name (ARN) of the forecast export job.

• forecastExportJobName :: Maybe Text

  The name of the forecast export 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 forecast export job. States include:

  • ACTIVE

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

  The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

Instances

FromJSON ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

parseJSON :: Value -> Parser ForecastExportJobSummary

parseJSONList :: Value -> Parser [ForecastExportJobSummary]

Generic ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Associated Types

type Rep ForecastExportJobSummary :: Type -> Type

Methods

from :: ForecastExportJobSummary -> Rep ForecastExportJobSummary x

to :: Rep ForecastExportJobSummary x -> ForecastExportJobSummary

Read ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

readsPrec :: Int -> ReadS ForecastExportJobSummary

readList :: ReadS [ForecastExportJobSummary]

readPrec :: ReadPrec ForecastExportJobSummary

readListPrec :: ReadPrec [ForecastExportJobSummary]

Show ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

showsPrec :: Int -> ForecastExportJobSummary -> ShowS

show :: ForecastExportJobSummary -> String

showList :: [ForecastExportJobSummary] -> ShowS

NFData ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

rnf :: ForecastExportJobSummary -> ()

Eq ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

(==) :: ForecastExportJobSummary -> ForecastExportJobSummary -> Bool

(/=) :: ForecastExportJobSummary -> ForecastExportJobSummary -> Bool

Hashable ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

Methods

hashWithSalt :: Int -> ForecastExportJobSummary -> Int

hash :: ForecastExportJobSummary -> Int

type Rep ForecastExportJobSummary

Defined in Amazonka.Forecast.Types.ForecastExportJobSummary

type Rep ForecastExportJobSummary = D1 ('MetaData "ForecastExportJobSummary" "Amazonka.Forecast.Types.ForecastExportJobSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ForecastExportJobSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataDestination)) :*: S1 ('MetaSel ('Just "forecastExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "forecastExportJobName") '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))))))

newForecastExportJobSummary :: ForecastExportJobSummary

Create a value of ForecastExportJobSummary 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:ForecastExportJobSummary', forecastExportJobSummary_creationTime - When the forecast export job was created.

$sel:destination:ForecastExportJobSummary', forecastExportJobSummary_destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

$sel:forecastExportJobArn:ForecastExportJobSummary', forecastExportJobSummary_forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.

$sel:forecastExportJobName:ForecastExportJobSummary', forecastExportJobSummary_forecastExportJobName - The name of the forecast export job.

$sel:lastModificationTime:ForecastExportJobSummary', forecastExportJobSummary_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:ForecastExportJobSummary', forecastExportJobSummary_message - If an error occurred, an informational message about the error.

$sel:status:ForecastExportJobSummary', forecastExportJobSummary_status - The status of the forecast export job. States include:

• ACTIVE

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

forecastExportJobSummary_creationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)

When the forecast export job was created.

forecastExportJobSummary_destination :: Lens' ForecastExportJobSummary (Maybe DataDestination)

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

forecastExportJobSummary_forecastExportJobArn :: Lens' ForecastExportJobSummary (Maybe Text)

The Amazon Resource Name (ARN) of the forecast export job.

forecastExportJobSummary_forecastExportJobName :: Lens' ForecastExportJobSummary (Maybe Text)

The name of the forecast export job.

forecastExportJobSummary_lastModificationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)

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.

forecastExportJobSummary_message :: Lens' ForecastExportJobSummary (Maybe Text)

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

forecastExportJobSummary_status :: Lens' ForecastExportJobSummary (Maybe Text)

The status of the forecast export job. States include:

• ACTIVE

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.