Amazonka.Forecast.DescribeWhatIfForecast

Describes the what-if forecast created using the CreateWhatIfForecast operation.

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

• CreationTime

• LastModificationTime

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

• Status

Creating a Request

data DescribeWhatIfForecast

See: newDescribeWhatIfForecast smart constructor.

Constructors

DescribeWhatIfForecast'

Fields

• whatIfForecastArn :: Text

  The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

Instances

ToJSON DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

toJSON :: DescribeWhatIfForecast -> Value

toEncoding :: DescribeWhatIfForecast -> Encoding

toJSONList :: [DescribeWhatIfForecast] -> Value

toEncodingList :: [DescribeWhatIfForecast] -> Encoding

ToHeaders DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

toHeaders :: DescribeWhatIfForecast -> [Header]

ToPath DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

toPath :: DescribeWhatIfForecast -> ByteString

ToQuery DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

toQuery :: DescribeWhatIfForecast -> QueryString

AWSRequest DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Associated Types

type AWSResponse DescribeWhatIfForecast

Methods

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

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

Generic DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Associated Types

type Rep DescribeWhatIfForecast :: Type -> Type

Methods

from :: DescribeWhatIfForecast -> Rep DescribeWhatIfForecast x

to :: Rep DescribeWhatIfForecast x -> DescribeWhatIfForecast

Read DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

readsPrec :: Int -> ReadS DescribeWhatIfForecast

readList :: ReadS [DescribeWhatIfForecast]

readPrec :: ReadPrec DescribeWhatIfForecast

readListPrec :: ReadPrec [DescribeWhatIfForecast]

Show DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

showsPrec :: Int -> DescribeWhatIfForecast -> ShowS

show :: DescribeWhatIfForecast -> String

showList :: [DescribeWhatIfForecast] -> ShowS

NFData DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

rnf :: DescribeWhatIfForecast -> ()

Eq DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

(==) :: DescribeWhatIfForecast -> DescribeWhatIfForecast -> Bool

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

Hashable DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

hashWithSalt :: Int -> DescribeWhatIfForecast -> Int

hash :: DescribeWhatIfForecast -> Int

type AWSResponse DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

type AWSResponse DescribeWhatIfForecast = DescribeWhatIfForecastResponse

type Rep DescribeWhatIfForecast

Defined in Amazonka.Forecast.DescribeWhatIfForecast

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

newDescribeWhatIfForecast

Arguments

:: Text

DescribeWhatIfForecast

-> DescribeWhatIfForecast

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

DescribeWhatIfForecast, describeWhatIfForecast_whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

Request Lenses

describeWhatIfForecast_whatIfForecastArn :: Lens' DescribeWhatIfForecast Text

The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

Destructuring the Response

data DescribeWhatIfForecastResponse

See: newDescribeWhatIfForecastResponse smart constructor.

Constructors

DescribeWhatIfForecastResponse'

Fields

• creationTime :: Maybe POSIX

  When the what-if forecast was created.

• estimatedTimeRemainingInMinutes :: Maybe Integer

  The approximate time remaining to complete the what-if forecast, in minutes.

• forecastTypes :: Maybe (NonEmpty Text)

  The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["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

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

• status :: Maybe Text

  The status of the what-if 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 what-if forecast must be ACTIVE before you can access the forecast.

• timeSeriesReplacementsDataSource :: Maybe TimeSeriesReplacementsDataSource

  An array of S3Config, Schema, and Format elements that describe the replacement time series.

• timeSeriesTransformations :: Maybe [TimeSeriesTransformation]

  An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

• whatIfAnalysisArn :: Maybe Text

  The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

• whatIfForecastArn :: Maybe Text

  The Amazon Resource Name (ARN) of the what-if forecast.

• whatIfForecastName :: Maybe Text

  The name of the what-if forecast.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Associated Types

type Rep DescribeWhatIfForecastResponse :: Type -> Type

Methods

from :: DescribeWhatIfForecastResponse -> Rep DescribeWhatIfForecastResponse x

to :: Rep DescribeWhatIfForecastResponse x -> DescribeWhatIfForecastResponse

Read DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

readsPrec :: Int -> ReadS DescribeWhatIfForecastResponse

readList :: ReadS [DescribeWhatIfForecastResponse]

readPrec :: ReadPrec DescribeWhatIfForecastResponse

readListPrec :: ReadPrec [DescribeWhatIfForecastResponse]

Show DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

showsPrec :: Int -> DescribeWhatIfForecastResponse -> ShowS

show :: DescribeWhatIfForecastResponse -> String

showList :: [DescribeWhatIfForecastResponse] -> ShowS

NFData DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

rnf :: DescribeWhatIfForecastResponse -> ()

Eq DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

Methods

(==) :: DescribeWhatIfForecastResponse -> DescribeWhatIfForecastResponse -> Bool

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

type Rep DescribeWhatIfForecastResponse

Defined in Amazonka.Forecast.DescribeWhatIfForecast

type Rep DescribeWhatIfForecastResponse = D1 ('MetaData "DescribeWhatIfForecastResponse" "Amazonka.Forecast.DescribeWhatIfForecast" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeWhatIfForecastResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: 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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "timeSeriesReplacementsDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSeriesReplacementsDataSource)) :*: (S1 ('MetaSel ('Just "timeSeriesTransformations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TimeSeriesTransformation])) :*: S1 ('MetaSel ('Just "whatIfAnalysisArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "whatIfForecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "whatIfForecastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeWhatIfForecastResponse

Arguments

:: Int

$sel:httpStatus:DescribeWhatIfForecastResponse'

-> DescribeWhatIfForecastResponse

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

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_creationTime - When the what-if forecast was created.

$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfForecastResponse', describeWhatIfForecastResponse_estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if forecast, in minutes.

$sel:forecastTypes:DescribeWhatIfForecastResponse', describeWhatIfForecastResponse_forecastTypes - The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_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.

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_message - If an error occurred, an informational message about the error.

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_status - The status of the what-if 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 what-if forecast must be ACTIVE before you can access the forecast.

$sel:timeSeriesReplacementsDataSource:DescribeWhatIfForecastResponse', describeWhatIfForecastResponse_timeSeriesReplacementsDataSource - An array of S3Config, Schema, and Format elements that describe the replacement time series.

$sel:timeSeriesTransformations:DescribeWhatIfForecastResponse', describeWhatIfForecastResponse_timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

DescribeWhatIfForecast, describeWhatIfForecastResponse_whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.

DescribeWhatIfForecastResponse, describeWhatIfForecastResponse_whatIfForecastName - The name of the what-if forecast.

$sel:httpStatus:DescribeWhatIfForecastResponse', describeWhatIfForecastResponse_httpStatus - The response's http status code.

Response Lenses

describeWhatIfForecastResponse_creationTime :: Lens' DescribeWhatIfForecastResponse (Maybe UTCTime)

When the what-if forecast was created.

describeWhatIfForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastResponse (Maybe Integer)

The approximate time remaining to complete the what-if forecast, in minutes.

describeWhatIfForecastResponse_forecastTypes :: Lens' DescribeWhatIfForecastResponse (Maybe (NonEmpty Text))

The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

describeWhatIfForecastResponse_lastModificationTime :: Lens' DescribeWhatIfForecastResponse (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.

describeWhatIfForecastResponse_message :: Lens' DescribeWhatIfForecastResponse (Maybe Text)

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

describeWhatIfForecastResponse_status :: Lens' DescribeWhatIfForecastResponse (Maybe Text)

The status of the what-if 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 what-if forecast must be ACTIVE before you can access the forecast.

describeWhatIfForecastResponse_timeSeriesReplacementsDataSource :: Lens' DescribeWhatIfForecastResponse (Maybe TimeSeriesReplacementsDataSource)

An array of S3Config, Schema, and Format elements that describe the replacement time series.

describeWhatIfForecastResponse_timeSeriesTransformations :: Lens' DescribeWhatIfForecastResponse (Maybe [TimeSeriesTransformation])

An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

describeWhatIfForecastResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text)

The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

describeWhatIfForecastResponse_whatIfForecastArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text)

The Amazon Resource Name (ARN) of the what-if forecast.

describeWhatIfForecastResponse_whatIfForecastName :: Lens' DescribeWhatIfForecastResponse (Maybe Text)

The name of the what-if forecast.

describeWhatIfForecastResponse_httpStatus :: Lens' DescribeWhatIfForecastResponse Int

The response's http status code.