Amazonka.Forecast.DescribeForecastExportJob

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

• CreationTime

• LastModificationTime

• Status

• Message - If an error occurred, information about the error.

Creating a Request

data DescribeForecastExportJob

See: newDescribeForecastExportJob smart constructor.

Constructors

DescribeForecastExportJob'

Fields

• forecastExportJobArn :: Text

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

Instances

ToJSON DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

toJSON :: DescribeForecastExportJob -> Value

toEncoding :: DescribeForecastExportJob -> Encoding

toJSONList :: [DescribeForecastExportJob] -> Value

toEncodingList :: [DescribeForecastExportJob] -> Encoding

ToHeaders DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

toHeaders :: DescribeForecastExportJob -> [Header]

ToPath DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

toPath :: DescribeForecastExportJob -> ByteString

ToQuery DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

toQuery :: DescribeForecastExportJob -> QueryString

AWSRequest DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Associated Types

type AWSResponse DescribeForecastExportJob

Methods

request :: (Service -> Service) -> DescribeForecastExportJob -> Request DescribeForecastExportJob

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

Generic DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Associated Types

type Rep DescribeForecastExportJob :: Type -> Type

Methods

from :: DescribeForecastExportJob -> Rep DescribeForecastExportJob x

to :: Rep DescribeForecastExportJob x -> DescribeForecastExportJob

Read DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

readsPrec :: Int -> ReadS DescribeForecastExportJob

readList :: ReadS [DescribeForecastExportJob]

readPrec :: ReadPrec DescribeForecastExportJob

readListPrec :: ReadPrec [DescribeForecastExportJob]

Show DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

showsPrec :: Int -> DescribeForecastExportJob -> ShowS

show :: DescribeForecastExportJob -> String

showList :: [DescribeForecastExportJob] -> ShowS

NFData DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

rnf :: DescribeForecastExportJob -> ()

Eq DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

(==) :: DescribeForecastExportJob -> DescribeForecastExportJob -> Bool

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

Hashable DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

hashWithSalt :: Int -> DescribeForecastExportJob -> Int

hash :: DescribeForecastExportJob -> Int

type AWSResponse DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

type AWSResponse DescribeForecastExportJob = DescribeForecastExportJobResponse

type Rep DescribeForecastExportJob

Defined in Amazonka.Forecast.DescribeForecastExportJob

type Rep DescribeForecastExportJob = D1 ('MetaData "DescribeForecastExportJob" "Amazonka.Forecast.DescribeForecastExportJob" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeForecastExportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forecastExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeForecastExportJob

Arguments

:: Text

DescribeForecastExportJob

-> DescribeForecastExportJob

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

DescribeForecastExportJob, describeForecastExportJob_forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.

Request Lenses

describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text

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

Destructuring the Response

data DescribeForecastExportJobResponse

See: newDescribeForecastExportJobResponse smart constructor.

Constructors

DescribeForecastExportJobResponse'

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.

• forecastArn :: Maybe Text

  The Amazon Resource Name (ARN) of the exported forecast.

• forecastExportJobArn :: Maybe Text

  The ARN of the forecast export job.

• forecastExportJobName :: Maybe Text

  The name of the forecast export job.

• format :: Maybe Text

  The format of the exported data, CSV or PARQUET.

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

Associated Types

type Rep DescribeForecastExportJobResponse :: Type -> Type

Methods

from :: DescribeForecastExportJobResponse -> Rep DescribeForecastExportJobResponse x

to :: Rep DescribeForecastExportJobResponse x -> DescribeForecastExportJobResponse

Read DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

readsPrec :: Int -> ReadS DescribeForecastExportJobResponse

readList :: ReadS [DescribeForecastExportJobResponse]

readPrec :: ReadPrec DescribeForecastExportJobResponse

readListPrec :: ReadPrec [DescribeForecastExportJobResponse]

Show DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

showsPrec :: Int -> DescribeForecastExportJobResponse -> ShowS

show :: DescribeForecastExportJobResponse -> String

showList :: [DescribeForecastExportJobResponse] -> ShowS

NFData DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

rnf :: DescribeForecastExportJobResponse -> ()

Eq DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

Methods

(==) :: DescribeForecastExportJobResponse -> DescribeForecastExportJobResponse -> Bool

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

type Rep DescribeForecastExportJobResponse

Defined in Amazonka.Forecast.DescribeForecastExportJob

type Rep DescribeForecastExportJobResponse = D1 ('MetaData "DescribeForecastExportJobResponse" "Amazonka.Forecast.DescribeForecastExportJob" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeForecastExportJobResponse'" '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 "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "forecastExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "forecastExportJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "format") '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)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeForecastExportJobResponse

Arguments

:: Int

$sel:httpStatus:DescribeForecastExportJobResponse'

-> DescribeForecastExportJobResponse

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

DescribeForecastExportJobResponse, describeForecastExportJobResponse_creationTime - When the forecast export job was created.

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

DescribeForecastExportJobResponse, describeForecastExportJobResponse_forecastArn - The Amazon Resource Name (ARN) of the exported forecast.

DescribeForecastExportJob, describeForecastExportJobResponse_forecastExportJobArn - The ARN of the forecast export job.

DescribeForecastExportJobResponse, describeForecastExportJobResponse_forecastExportJobName - The name of the forecast export job.

DescribeForecastExportJobResponse, describeForecastExportJobResponse_format - The format of the exported data, CSV or PARQUET.

DescribeForecastExportJobResponse, describeForecastExportJobResponse_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.

DescribeForecastExportJobResponse, describeForecastExportJobResponse_message - If an error occurred, an informational message about the error.

DescribeForecastExportJobResponse, describeForecastExportJobResponse_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.

$sel:httpStatus:DescribeForecastExportJobResponse', describeForecastExportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime)

When the forecast export job was created.

describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination)

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

describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)

The Amazon Resource Name (ARN) of the exported forecast.

describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)

The ARN of the forecast export job.

describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text)

The name of the forecast export job.

describeForecastExportJobResponse_format :: Lens' DescribeForecastExportJobResponse (Maybe Text)

The format of the exported data, CSV or PARQUET.

describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (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.

describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text)

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

describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (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.

describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int

The response's http status code.