Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Forecast.DescribeForecast

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data DescribeForecast Source #

See: newDescribeForecast smart constructor.

Constructors

DescribeForecast'
Fields forecastArn :: Text The Amazon Resource Name (ARN) of the forecast.

Instances

Instances details

Eq DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods (==) :: DescribeForecast -> DescribeForecast -> Bool # (/=) :: DescribeForecast -> DescribeForecast -> Bool #
Read DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods readsPrec :: Int -> ReadS DescribeForecast # readList :: ReadS [DescribeForecast] # readPrec :: ReadPrec DescribeForecast # readListPrec :: ReadPrec [DescribeForecast] #
Show DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods showsPrec :: Int -> DescribeForecast -> ShowS # show :: DescribeForecast -> String # showList :: [DescribeForecast] -> ShowS #
Generic DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Associated Types type Rep DescribeForecast :: Type -> Type # Methods from :: DescribeForecast -> Rep DescribeForecast x # to :: Rep DescribeForecast x -> DescribeForecast #
NFData DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods rnf :: DescribeForecast -> () #
Hashable DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods hashWithSalt :: Int -> DescribeForecast -> Int # hash :: DescribeForecast -> Int #
ToJSON DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods toJSON :: DescribeForecast -> Value # toEncoding :: DescribeForecast -> Encoding # toJSONList :: [DescribeForecast] -> Value # toEncodingList :: [DescribeForecast] -> Encoding #
AWSRequest DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Associated Types type AWSResponse DescribeForecast # Methods request :: DescribeForecast -> Request DescribeForecast # response :: MonadResource m => Logger -> Service -> Proxy DescribeForecast -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeForecast))) #
ToHeaders DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods toHeaders :: DescribeForecast -> [Header] #
ToPath DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods toPath :: DescribeForecast -> ByteString #
ToQuery DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods toQuery :: DescribeForecast -> QueryString #
type Rep DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast type Rep DescribeForecast = D1 ('MetaData "DescribeForecast" "Amazonka.Forecast.DescribeForecast" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeForecast'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeForecast Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast type AWSResponse DescribeForecast = DescribeForecastResponse

newDescribeForecast Source #

Arguments

:: Text	`$sel:forecastArn: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:

$sel:forecastArn:DescribeForecast', describeForecast_forecastArn - The Amazon Resource Name (ARN) of the forecast.

Request Lenses

describeForecast_forecastArn :: Lens' DescribeForecast Text Source #

The Amazon Resource Name (ARN) of the forecast.

Destructuring the Response

data DescribeForecastResponse Source #

See: newDescribeForecastResponse smart constructor.

Constructors

DescribeForecastResponse'

Fields

creationTime :: Maybe POSIX
When the forecast creation task was created.
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.
predictorArn :: Maybe Text
The ARN of the predictor used to generate the forecast.
forecastArn :: Maybe Text
The forecast ARN as specified in the request.
estimatedTimeRemainingInMinutes :: Maybe Integer
The estimated time remaining in minutes for the forecast job to complete.
forecastName :: Maybe Text
The name of the forecast.
forecastTypes :: Maybe (NonEmpty Text)
The quantiles at which probabilistic forecasts were generated.
datasetGroupArn :: Maybe Text
The ARN of the dataset group that provided the data used to train the predictor.
message :: Maybe Text
If an error occurred, an informational message about the error.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods (==) :: DescribeForecastResponse -> DescribeForecastResponse -> Bool # (/=) :: DescribeForecastResponse -> DescribeForecastResponse -> Bool #
Read DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods readsPrec :: Int -> ReadS DescribeForecastResponse # readList :: ReadS [DescribeForecastResponse] # readPrec :: ReadPrec DescribeForecastResponse # readListPrec :: ReadPrec [DescribeForecastResponse] #
Show DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods showsPrec :: Int -> DescribeForecastResponse -> ShowS # show :: DescribeForecastResponse -> String # showList :: [DescribeForecastResponse] -> ShowS #
Generic DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Associated Types type Rep DescribeForecastResponse :: Type -> Type # Methods from :: DescribeForecastResponse -> Rep DescribeForecastResponse x # to :: Rep DescribeForecastResponse x -> DescribeForecastResponse #
NFData DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast Methods rnf :: DescribeForecastResponse -> () #
type Rep DescribeForecastResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeForecast type Rep DescribeForecastResponse = D1 ('MetaData "DescribeForecastResponse" "Amazonka.Forecast.DescribeForecast" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DescribeForecastResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "predictorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "forecastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "forecastTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeForecastResponse Source #

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:

$sel:creationTime:DescribeForecastResponse', describeForecastResponse_creationTime - When the forecast creation task was created.

$sel:status: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:predictorArn:DescribeForecastResponse', describeForecastResponse_predictorArn - The ARN of the predictor used to generate the forecast.

$sel:forecastArn:DescribeForecast', describeForecastResponse_forecastArn - The forecast ARN as specified in the request.

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

$sel:forecastName:DescribeForecastResponse', describeForecastResponse_forecastName - The name of the forecast.

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

$sel:datasetGroupArn:DescribeForecastResponse', describeForecastResponse_datasetGroupArn - The ARN of the dataset group that provided the data used to train the predictor.

$sel:message:DescribeForecastResponse', describeForecastResponse_message - If an error occurred, an informational message about the error.

$sel:lastModificationTime: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.

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

Response Lenses

describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime) Source #

When the forecast creation task was created.

describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text) Source #

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_predictorArn :: Lens' DescribeForecastResponse (Maybe Text) Source #

The ARN of the predictor used to generate the forecast.

describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text) Source #

The forecast ARN as specified in the request.

describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer) Source #

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

describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text) Source #

The name of the forecast.

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

The quantiles at which probabilistic forecasts were generated.

describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text) Source #

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

describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text) Source #

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

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

describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int Source #

The response's http status code.