Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.DescribeAutoPredictor

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a predictor created using the CreateAutoPredictor operation.

Synopsis

Creating a Request

data DescribeAutoPredictor Source #

See: newDescribeAutoPredictor smart constructor.

Constructors

DescribeAutoPredictor'
Fields predictorArn :: Text The Amazon Resource Name (ARN) of the predictor.

Instances

Instances details

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

newDescribeAutoPredictor Source #

Arguments

:: Text	`DescribeAutoPredictor`
-> DescribeAutoPredictor

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

DescribeAutoPredictor, describeAutoPredictor_predictorArn - The Amazon Resource Name (ARN) of the predictor.

Request Lenses

describeAutoPredictor_predictorArn :: Lens' DescribeAutoPredictor Text Source #

The Amazon Resource Name (ARN) of the predictor.

Destructuring the Response

data DescribeAutoPredictorResponse Source #

See: newDescribeAutoPredictorResponse smart constructor.

Constructors

DescribeAutoPredictorResponse'

Fields

creationTime :: Maybe POSIX
The timestamp of the CreateAutoPredictor request.
dataConfig :: Maybe DataConfig
The data configuration for your dataset group and any additional datasets.
datasetImportJobArns :: Maybe [Text]
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
encryptionConfig :: Maybe EncryptionConfig
estimatedTimeRemainingInMinutes :: Maybe Integer
The estimated time remaining in minutes for the predictor training job to complete.
explainabilityInfo :: Maybe ExplainabilityInfo
Provides the status and ARN of the Predictor Explainability.
forecastDimensions :: Maybe (NonEmpty Text)
An array of dimension (field) names that specify the attributes used to group your time series.
forecastFrequency :: Maybe Text
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
forecastHorizon :: Maybe Int
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
forecastTypes :: Maybe (NonEmpty Text)
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
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
In the event of an error, a message detailing the cause of the error.
monitorInfo :: Maybe MonitorInfo
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
optimizationMetric :: Maybe OptimizationMetric
The accuracy metric used to optimize the predictor.
predictorArn :: Maybe Text
The Amazon Resource Name (ARN) of the predictor
predictorName :: Maybe Text
The name of the predictor.
referencePredictorSummary :: Maybe ReferencePredictorSummary
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
status :: Maybe Text
The status of the predictor. States include:
- ```
ACTIVE
```
- CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
- CREATE_STOPPING, CREATE_STOPPED
- DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
timeAlignmentBoundary :: Maybe TimeAlignmentBoundary
The time boundary Forecast uses when aggregating data.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor Associated Types type Rep DescribeAutoPredictorResponse :: Type -> Type # Methods from :: DescribeAutoPredictorResponse -> Rep DescribeAutoPredictorResponse x # to :: Rep DescribeAutoPredictorResponse x -> DescribeAutoPredictorResponse #
Read DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor Methods readsPrec :: Int -> ReadS DescribeAutoPredictorResponse # readList :: ReadS [DescribeAutoPredictorResponse] # readPrec :: ReadPrec DescribeAutoPredictorResponse # readListPrec :: ReadPrec [DescribeAutoPredictorResponse] #
Show DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor Methods showsPrec :: Int -> DescribeAutoPredictorResponse -> ShowS # show :: DescribeAutoPredictorResponse -> String # showList :: [DescribeAutoPredictorResponse] -> ShowS #
NFData DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor Methods rnf :: DescribeAutoPredictorResponse -> () #
Eq DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor Methods (==) :: DescribeAutoPredictorResponse -> DescribeAutoPredictorResponse -> Bool # (/=) :: DescribeAutoPredictorResponse -> DescribeAutoPredictorResponse -> Bool #
type Rep DescribeAutoPredictorResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeAutoPredictor type Rep DescribeAutoPredictorResponse = D1 ('MetaData "DescribeAutoPredictorResponse" "Amazonka.Forecast.DescribeAutoPredictor" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeAutoPredictorResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataConfig))) :: (S1 ('MetaSel ('Just "datasetImportJobArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "encryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfig)) :: S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "explainabilityInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExplainabilityInfo)) :: S1 ('MetaSel ('Just "forecastDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "forecastFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "forecastHorizon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: 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 "monitorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitorInfo)) :: (S1 ('MetaSel ('Just "optimizationMetric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OptimizationMetric)) :: S1 ('MetaSel ('Just "predictorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "predictorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "referencePredictorSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReferencePredictorSummary))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timeAlignmentBoundary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeAlignmentBoundary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeAutoPredictorResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAutoPredictorResponse'`
-> DescribeAutoPredictorResponse

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

DescribeAutoPredictorResponse, describeAutoPredictorResponse_creationTime - The timestamp of the CreateAutoPredictor request.

$sel:dataConfig:DescribeAutoPredictorResponse', describeAutoPredictorResponse_dataConfig - The data configuration for your dataset group and any additional datasets.

$sel:datasetImportJobArns:DescribeAutoPredictorResponse', describeAutoPredictorResponse_datasetImportJobArns - An array of the ARNs of the dataset import jobs used to import training data for the predictor.

$sel:encryptionConfig:DescribeAutoPredictorResponse', describeAutoPredictorResponse_encryptionConfig - Undocumented member.

$sel:estimatedTimeRemainingInMinutes:DescribeAutoPredictorResponse', describeAutoPredictorResponse_estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the predictor training job to complete.

$sel:explainabilityInfo:DescribeAutoPredictorResponse', describeAutoPredictorResponse_explainabilityInfo - Provides the status and ARN of the Predictor Explainability.

DescribeAutoPredictorResponse, describeAutoPredictorResponse_forecastDimensions - An array of dimension (field) names that specify the attributes used to group your time series.

DescribeAutoPredictorResponse, describeAutoPredictorResponse_forecastFrequency - The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

$sel:forecastHorizon:DescribeAutoPredictorResponse', describeAutoPredictorResponse_forecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

$sel:forecastTypes:DescribeAutoPredictorResponse', describeAutoPredictorResponse_forecastTypes - The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].

DescribeAutoPredictorResponse, describeAutoPredictorResponse_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.

DescribeAutoPredictorResponse, describeAutoPredictorResponse_message - In the event of an error, a message detailing the cause of the error.

$sel:monitorInfo:DescribeAutoPredictorResponse', describeAutoPredictorResponse_monitorInfo - A object with the Amazon Resource Name (ARN) and status of the monitor resource.

$sel:optimizationMetric:DescribeAutoPredictorResponse', describeAutoPredictorResponse_optimizationMetric - The accuracy metric used to optimize the predictor.

DescribeAutoPredictor, describeAutoPredictorResponse_predictorArn - The Amazon Resource Name (ARN) of the predictor

DescribeAutoPredictorResponse, describeAutoPredictorResponse_predictorName - The name of the predictor.

DescribeAutoPredictorResponse, describeAutoPredictorResponse_referencePredictorSummary - The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

DescribeAutoPredictorResponse, describeAutoPredictorResponse_status - The status of the predictor. States include:

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

$sel:timeAlignmentBoundary:DescribeAutoPredictorResponse', describeAutoPredictorResponse_timeAlignmentBoundary - The time boundary Forecast uses when aggregating data.

$sel:httpStatus:DescribeAutoPredictorResponse', describeAutoPredictorResponse_httpStatus - The response's http status code.

Response Lenses

describeAutoPredictorResponse_creationTime :: Lens' DescribeAutoPredictorResponse (Maybe UTCTime) Source #

The timestamp of the CreateAutoPredictor request.

describeAutoPredictorResponse_dataConfig :: Lens' DescribeAutoPredictorResponse (Maybe DataConfig) Source #

The data configuration for your dataset group and any additional datasets.

describeAutoPredictorResponse_datasetImportJobArns :: Lens' DescribeAutoPredictorResponse (Maybe [Text]) Source #

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

describeAutoPredictorResponse_encryptionConfig :: Lens' DescribeAutoPredictorResponse (Maybe EncryptionConfig) Source #

Undocumented member.

describeAutoPredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeAutoPredictorResponse (Maybe Integer) Source #

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

describeAutoPredictorResponse_explainabilityInfo :: Lens' DescribeAutoPredictorResponse (Maybe ExplainabilityInfo) Source #

Provides the status and ARN of the Predictor Explainability.

describeAutoPredictorResponse_forecastDimensions :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text)) Source #

An array of dimension (field) names that specify the attributes used to group your time series.

describeAutoPredictorResponse_forecastFrequency :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

describeAutoPredictorResponse_forecastHorizon :: Lens' DescribeAutoPredictorResponse (Maybe Int) Source #

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

describeAutoPredictorResponse_forecastTypes :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text)) Source #

The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].

describeAutoPredictorResponse_lastModificationTime :: Lens' DescribeAutoPredictorResponse (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.

describeAutoPredictorResponse_message :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #

In the event of an error, a message detailing the cause of the error.

describeAutoPredictorResponse_monitorInfo :: Lens' DescribeAutoPredictorResponse (Maybe MonitorInfo) Source #

A object with the Amazon Resource Name (ARN) and status of the monitor resource.

describeAutoPredictorResponse_optimizationMetric :: Lens' DescribeAutoPredictorResponse (Maybe OptimizationMetric) Source #

The accuracy metric used to optimize the predictor.

describeAutoPredictorResponse_predictorArn :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the predictor

describeAutoPredictorResponse_predictorName :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #

The name of the predictor.

describeAutoPredictorResponse_referencePredictorSummary :: Lens' DescribeAutoPredictorResponse (Maybe ReferencePredictorSummary) Source #

The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

describeAutoPredictorResponse_status :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #

The status of the predictor. States include:

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

describeAutoPredictorResponse_timeAlignmentBoundary :: Lens' DescribeAutoPredictorResponse (Maybe TimeAlignmentBoundary) Source #

The time boundary Forecast uses when aggregating data.

describeAutoPredictorResponse_httpStatus :: Lens' DescribeAutoPredictorResponse Int Source #

The response's http status code.