Amazonka.Forecast.DescribeForecast

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

• DatasetGroupArn - The dataset group that provided the training data.

• CreationTime

• LastModificationTime

• Status

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

Creating a Request

data DescribeForecast

See: newDescribeForecast smart constructor.

Constructors

DescribeForecast'

Fields

• forecastArn :: Text

  The Amazon Resource Name (ARN) of the forecast.

Instances

ToJSON DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

toJSON :: DescribeForecast -> Value

toEncoding :: DescribeForecast -> Encoding

toJSONList :: [DescribeForecast] -> Value

toEncodingList :: [DescribeForecast] -> Encoding

ToHeaders DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

toHeaders :: DescribeForecast -> [Header]

ToPath DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

toPath :: DescribeForecast -> ByteString

ToQuery DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

toQuery :: DescribeForecast -> QueryString

AWSRequest DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Associated Types

type AWSResponse DescribeForecast

Methods

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

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

Generic DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Associated Types

type Rep DescribeForecast :: Type -> Type

Methods

from :: DescribeForecast -> Rep DescribeForecast x

to :: Rep DescribeForecast x -> DescribeForecast

Read DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

readsPrec :: Int -> ReadS DescribeForecast

readList :: ReadS [DescribeForecast]

readPrec :: ReadPrec DescribeForecast

readListPrec :: ReadPrec [DescribeForecast]

Show DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

showsPrec :: Int -> DescribeForecast -> ShowS

show :: DescribeForecast -> String

showList :: [DescribeForecast] -> ShowS

NFData DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

rnf :: DescribeForecast -> ()

Eq DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

(==) :: DescribeForecast -> DescribeForecast -> Bool

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

Hashable DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

Methods

hashWithSalt :: Int -> DescribeForecast -> Int

hash :: DescribeForecast -> Int

type AWSResponse DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

type AWSResponse DescribeForecast = DescribeForecastResponse

type Rep DescribeForecast

Defined in Amazonka.Forecast.DescribeForecast

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

newDescribeForecast

Arguments

:: Text

DescribeForecast

-> DescribeForecast

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

DescribeForecast, describeForecast_forecastArn - The Amazon Resource Name (ARN) of the forecast.

Request Lenses

describeForecast_forecastArn :: Lens' DescribeForecast Text

The Amazon Resource Name (ARN) of the forecast.

Destructuring the Response

data DescribeForecastResponse

See: newDescribeForecastResponse smart constructor.

Constructors

DescribeForecastResponse'

Fields

• creationTime :: Maybe POSIX

  When the forecast creation task was created.

• datasetGroupArn :: Maybe Text

  The ARN of the dataset group that provided the data used to train the predictor.

• estimatedTimeRemainingInMinutes :: Maybe Integer

  The estimated time remaining in minutes for the forecast job to complete.

• forecastArn :: Maybe Text

  The forecast ARN as specified in the request.

• forecastName :: Maybe Text

  The name of the forecast.

• forecastTypes :: Maybe (NonEmpty Text)

  The quantiles at which probabilistic forecasts were generated.

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

• predictorArn :: Maybe Text

  The ARN of the predictor used to generate the forecast.

• status :: Maybe Text

  The status of the forecast. 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 must be ACTIVE before you can query or export the forecast.

• timeSeriesSelector :: Maybe TimeSeriesSelector

  The time series to include in the forecast.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

Associated Types

type Rep DescribeForecastResponse :: Type -> Type

Methods

from :: DescribeForecastResponse -> Rep DescribeForecastResponse x

to :: Rep DescribeForecastResponse x -> DescribeForecastResponse

Read DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

Methods

readsPrec :: Int -> ReadS DescribeForecastResponse

readList :: ReadS [DescribeForecastResponse]

readPrec :: ReadPrec DescribeForecastResponse

readListPrec :: ReadPrec [DescribeForecastResponse]

Show DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

Methods

showsPrec :: Int -> DescribeForecastResponse -> ShowS

show :: DescribeForecastResponse -> String

showList :: [DescribeForecastResponse] -> ShowS

NFData DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

Methods

rnf :: DescribeForecastResponse -> ()

Eq DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

Methods

(==) :: DescribeForecastResponse -> DescribeForecastResponse -> Bool

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

type Rep DescribeForecastResponse

Defined in Amazonka.Forecast.DescribeForecast

type Rep DescribeForecastResponse = D1 ('MetaData "DescribeForecastResponse" "Amazonka.Forecast.DescribeForecast" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeForecastResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "forecastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "forecastTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))) :*: ((S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "predictorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timeSeriesSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSeriesSelector)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeForecastResponse

Arguments

:: Int

$sel:httpStatus:DescribeForecastResponse'

-> DescribeForecastResponse

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

DescribeForecastResponse, describeForecastResponse_creationTime - When the forecast creation task was created.

DescribeForecastResponse, describeForecastResponse_datasetGroupArn - The ARN of the dataset group that provided the data used to train the predictor.

$sel:estimatedTimeRemainingInMinutes:DescribeForecastResponse', describeForecastResponse_estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the forecast job to complete.

DescribeForecast, describeForecastResponse_forecastArn - The forecast ARN as specified in the request.

DescribeForecastResponse, describeForecastResponse_forecastName - The name of the forecast.

$sel:forecastTypes:DescribeForecastResponse', describeForecastResponse_forecastTypes - The quantiles at which probabilistic forecasts were generated.

DescribeForecastResponse, describeForecastResponse_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.

DescribeForecastResponse, describeForecastResponse_message - If an error occurred, an informational message about the error.

DescribeForecastResponse, describeForecastResponse_predictorArn - The ARN of the predictor used to generate the forecast.

DescribeForecastResponse, describeForecastResponse_status - The status of the forecast. 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 must be ACTIVE before you can query or export the forecast.

$sel:timeSeriesSelector:DescribeForecastResponse', describeForecastResponse_timeSeriesSelector - The time series to include in the forecast.

$sel:httpStatus:DescribeForecastResponse', describeForecastResponse_httpStatus - The response's http status code.

Response Lenses

describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime)

When the forecast creation task was created.

describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text)

The ARN of the dataset group that provided the data used to train the predictor.

describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer)

The estimated time remaining in minutes for the forecast job to complete.

describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text)

The forecast ARN as specified in the request.

describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text)

The name of the forecast.

describeForecastResponse_forecastTypes :: Lens' DescribeForecastResponse (Maybe (NonEmpty Text))

The quantiles at which probabilistic forecasts were generated.

describeForecastResponse_lastModificationTime :: Lens' DescribeForecastResponse (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.

describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text)

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

describeForecastResponse_predictorArn :: Lens' DescribeForecastResponse (Maybe Text)

The ARN of the predictor used to generate the forecast.

describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text)

The status of the forecast. 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 must be ACTIVE before you can query or export the forecast.

describeForecastResponse_timeSeriesSelector :: Lens' DescribeForecastResponse (Maybe TimeSeriesSelector)

The time series to include in the forecast.

describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int

The response's http status code.