| 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.CreateWhatIfForecastExport
Description
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
The Status of the forecast export job must be ACTIVE before you can
access the forecast in your Amazon S3 bucket. To get the status, use the
DescribeWhatIfForecastExport operation.
Synopsis
- data CreateWhatIfForecastExport = CreateWhatIfForecastExport' {}
- newCreateWhatIfForecastExport :: Text -> NonEmpty Text -> DataDestination -> CreateWhatIfForecastExport
- createWhatIfForecastExport_format :: Lens' CreateWhatIfForecastExport (Maybe Text)
- createWhatIfForecastExport_tags :: Lens' CreateWhatIfForecastExport (Maybe [Tag])
- createWhatIfForecastExport_whatIfForecastExportName :: Lens' CreateWhatIfForecastExport Text
- createWhatIfForecastExport_whatIfForecastArns :: Lens' CreateWhatIfForecastExport (NonEmpty Text)
- createWhatIfForecastExport_destination :: Lens' CreateWhatIfForecastExport DataDestination
- data CreateWhatIfForecastExportResponse = CreateWhatIfForecastExportResponse' {}
- newCreateWhatIfForecastExportResponse :: Int -> CreateWhatIfForecastExportResponse
- createWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' CreateWhatIfForecastExportResponse (Maybe Text)
- createWhatIfForecastExportResponse_httpStatus :: Lens' CreateWhatIfForecastExportResponse Int
Creating a Request
data CreateWhatIfForecastExport Source #
See: newCreateWhatIfForecastExport smart constructor.
Constructors
| CreateWhatIfForecastExport' | |
Fields
| |
Instances
newCreateWhatIfForecastExport Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> DataDestination | |
| -> CreateWhatIfForecastExport |
Create a value of CreateWhatIfForecastExport 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:
CreateWhatIfForecastExport, createWhatIfForecastExport_format - The format of the exported data, CSV or PARQUET.
$sel:tags:CreateWhatIfForecastExport', createWhatIfForecastExport_tags - A list of
tags
to apply to the what if forecast.
CreateWhatIfForecastExport, createWhatIfForecastExport_whatIfForecastExportName - The name of the what-if forecast to export.
CreateWhatIfForecastExport, createWhatIfForecastExport_whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExport, createWhatIfForecastExport_destination - The location where you want to save the forecast and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
Request Lenses
createWhatIfForecastExport_format :: Lens' CreateWhatIfForecastExport (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
createWhatIfForecastExport_tags :: Lens' CreateWhatIfForecastExport (Maybe [Tag]) Source #
A list of tags to apply to the what if forecast.
createWhatIfForecastExport_whatIfForecastExportName :: Lens' CreateWhatIfForecastExport Text Source #
The name of the what-if forecast to export.
createWhatIfForecastExport_whatIfForecastArns :: Lens' CreateWhatIfForecastExport (NonEmpty Text) Source #
The list of what-if forecast Amazon Resource Names (ARNs) to export.
createWhatIfForecastExport_destination :: Lens' CreateWhatIfForecastExport DataDestination Source #
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
Destructuring the Response
data CreateWhatIfForecastExportResponse Source #
See: newCreateWhatIfForecastExportResponse smart constructor.
Constructors
| CreateWhatIfForecastExportResponse' | |
Fields
| |
Instances
newCreateWhatIfForecastExportResponse Source #
Arguments
| :: Int | |
| -> CreateWhatIfForecastExportResponse |
Create a value of CreateWhatIfForecastExportResponse 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:
CreateWhatIfForecastExportResponse, createWhatIfForecastExportResponse_whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast.
$sel:httpStatus:CreateWhatIfForecastExportResponse', createWhatIfForecastExportResponse_httpStatus - The response's http status code.
Response Lenses
createWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' CreateWhatIfForecastExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
createWhatIfForecastExportResponse_httpStatus :: Lens' CreateWhatIfForecastExportResponse Int Source #
The response's http status code.