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 forecast export created using the CreateWhatIfForecastExport operation.
In addition to listing the properties provided in the
CreateWhatIfForecastExport
request, this operation lists the following
properties:
CreationTime
LastModificationTime
Message
- If an error occurred, information about the error.Status
Synopsis
- data DescribeWhatIfForecastExport = DescribeWhatIfForecastExport' {}
- newDescribeWhatIfForecastExport :: Text -> DescribeWhatIfForecastExport
- describeWhatIfForecastExport_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExport Text
- data DescribeWhatIfForecastExportResponse = DescribeWhatIfForecastExportResponse' {
- creationTime :: Maybe POSIX
- destination :: Maybe DataDestination
- estimatedTimeRemainingInMinutes :: Maybe Integer
- format :: Maybe Text
- lastModificationTime :: Maybe POSIX
- message :: Maybe Text
- status :: Maybe Text
- whatIfForecastArns :: Maybe [Text]
- whatIfForecastExportArn :: Maybe Text
- whatIfForecastExportName :: Maybe Text
- httpStatus :: Int
- newDescribeWhatIfForecastExportResponse :: Int -> DescribeWhatIfForecastExportResponse
- describeWhatIfForecastExportResponse_creationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)
- describeWhatIfForecastExportResponse_destination :: Lens' DescribeWhatIfForecastExportResponse (Maybe DataDestination)
- describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastExportResponse (Maybe Integer)
- describeWhatIfForecastExportResponse_format :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_lastModificationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)
- describeWhatIfForecastExportResponse_message :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_status :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_whatIfForecastArns :: Lens' DescribeWhatIfForecastExportResponse (Maybe [Text])
- describeWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_whatIfForecastExportName :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_httpStatus :: Lens' DescribeWhatIfForecastExportResponse Int
Creating a Request
data DescribeWhatIfForecastExport Source #
See: newDescribeWhatIfForecastExport
smart constructor.
DescribeWhatIfForecastExport' | |
|
Instances
newDescribeWhatIfForecastExport Source #
Create a value of DescribeWhatIfForecastExport
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:
DescribeWhatIfForecastExport
, describeWhatIfForecastExport_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export that you
are interested in.
Request Lenses
describeWhatIfForecastExport_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExport Text Source #
The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.
Destructuring the Response
data DescribeWhatIfForecastExportResponse Source #
See: newDescribeWhatIfForecastExportResponse
smart constructor.
DescribeWhatIfForecastExportResponse' | |
|
Instances
newDescribeWhatIfForecastExportResponse Source #
Create a value of DescribeWhatIfForecastExportResponse
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:
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_creationTime
- When the what-if forecast export was created.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_destination
- Undocumented member.
$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfForecastExportResponse'
, describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes
- The approximate time remaining to complete the what-if forecast export,
in minutes.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_format
- The format of the exported data, CSV or PARQUET.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_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.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_message
- If an error occurred, an informational message about the error.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_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 export must be ACTIVE
before you
can access the forecast export.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_whatIfForecastArns
- An array of Amazon Resource Names (ARNs) that represent all of the
what-if forecasts exported in this resource.
DescribeWhatIfForecastExport
, describeWhatIfForecastExportResponse_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_whatIfForecastExportName
- The name of the what-if forecast export.
$sel:httpStatus:DescribeWhatIfForecastExportResponse'
, describeWhatIfForecastExportResponse_httpStatus
- The response's http status code.
Response Lenses
describeWhatIfForecastExportResponse_creationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime) Source #
When the what-if forecast export was created.
describeWhatIfForecastExportResponse_destination :: Lens' DescribeWhatIfForecastExportResponse (Maybe DataDestination) Source #
Undocumented member.
describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastExportResponse (Maybe Integer) Source #
The approximate time remaining to complete the what-if forecast export, in minutes.
describeWhatIfForecastExportResponse_format :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
describeWhatIfForecastExportResponse_lastModificationTime :: Lens' DescribeWhatIfForecastExportResponse (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.
describeWhatIfForecastExportResponse_message :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeWhatIfForecastExportResponse_status :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
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 export must be ACTIVE
before you
can access the forecast export.
describeWhatIfForecastExportResponse_whatIfForecastArns :: Lens' DescribeWhatIfForecastExportResponse (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
describeWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast export.
describeWhatIfForecastExportResponse_whatIfForecastExportName :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The name of the what-if forecast export.
describeWhatIfForecastExportResponse_httpStatus :: Lens' DescribeWhatIfForecastExportResponse Int Source #
The response's http status code.