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 |
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
In addition to listing the properties provided in the
CreateWhatIfAnalysis
request, this operation lists the following
properties:
CreationTime
LastModificationTime
Message
- If an error occurred, information about the error.Status
Synopsis
- data DescribeWhatIfAnalysis = DescribeWhatIfAnalysis' {}
- newDescribeWhatIfAnalysis :: Text -> DescribeWhatIfAnalysis
- describeWhatIfAnalysis_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysis Text
- data DescribeWhatIfAnalysisResponse = DescribeWhatIfAnalysisResponse' {
- creationTime :: Maybe POSIX
- estimatedTimeRemainingInMinutes :: Maybe Integer
- forecastArn :: Maybe Text
- lastModificationTime :: Maybe POSIX
- message :: Maybe Text
- status :: Maybe Text
- timeSeriesSelector :: Maybe TimeSeriesSelector
- whatIfAnalysisArn :: Maybe Text
- whatIfAnalysisName :: Maybe Text
- httpStatus :: Int
- newDescribeWhatIfAnalysisResponse :: Int -> DescribeWhatIfAnalysisResponse
- describeWhatIfAnalysisResponse_creationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime)
- describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfAnalysisResponse (Maybe Integer)
- describeWhatIfAnalysisResponse_forecastArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_lastModificationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime)
- describeWhatIfAnalysisResponse_message :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_status :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_timeSeriesSelector :: Lens' DescribeWhatIfAnalysisResponse (Maybe TimeSeriesSelector)
- describeWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_whatIfAnalysisName :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_httpStatus :: Lens' DescribeWhatIfAnalysisResponse Int
Creating a Request
data DescribeWhatIfAnalysis Source #
See: newDescribeWhatIfAnalysis
smart constructor.
DescribeWhatIfAnalysis' | |
|
Instances
newDescribeWhatIfAnalysis Source #
Create a value of DescribeWhatIfAnalysis
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:
DescribeWhatIfAnalysis
, describeWhatIfAnalysis_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis that you are
interested in.
Request Lenses
describeWhatIfAnalysis_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysis Text Source #
The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.
Destructuring the Response
data DescribeWhatIfAnalysisResponse Source #
See: newDescribeWhatIfAnalysisResponse
smart constructor.
DescribeWhatIfAnalysisResponse' | |
|
Instances
newDescribeWhatIfAnalysisResponse Source #
Create a value of DescribeWhatIfAnalysisResponse
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:
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_creationTime
- When the what-if analysis was created.
$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes
- The approximate time remaining to complete the what-if analysis, in
minutes.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_forecastArn
- The Amazon Resource Name (ARN) of the what-if forecast.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_message
- If an error occurred, an informational message about the error.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_status
- The status of the what-if analysis. 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 analysis must be ACTIVE
before you can
access the analysis.
$sel:timeSeriesSelector:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_timeSeriesSelector
- Undocumented member.
DescribeWhatIfAnalysis
, describeWhatIfAnalysisResponse_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_whatIfAnalysisName
- The name of the what-if analysis.
$sel:httpStatus:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_httpStatus
- The response's http status code.
Response Lenses
describeWhatIfAnalysisResponse_creationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime) Source #
When the what-if analysis was created.
describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfAnalysisResponse (Maybe Integer) Source #
The approximate time remaining to complete the what-if analysis, in minutes.
describeWhatIfAnalysisResponse_forecastArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
describeWhatIfAnalysisResponse_lastModificationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeWhatIfAnalysisResponse_message :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeWhatIfAnalysisResponse_status :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The status of the what-if analysis. 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 analysis must be ACTIVE
before you can
access the analysis.
describeWhatIfAnalysisResponse_timeSeriesSelector :: Lens' DescribeWhatIfAnalysisResponse (Maybe TimeSeriesSelector) Source #
Undocumented member.
describeWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis.
describeWhatIfAnalysisResponse_whatIfAnalysisName :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The name of the what-if analysis.
describeWhatIfAnalysisResponse_httpStatus :: Lens' DescribeWhatIfAnalysisResponse Int Source #
The response's http status code.