| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Forecast.CreatePredictorBacktestExportJob
Description
Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and 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.
The Status of the export job must be ACTIVE before you can access
the export in your Amazon S3 bucket. To get the status, use the
DescribePredictorBacktestExportJob operation.
Synopsis
- data CreatePredictorBacktestExportJob = CreatePredictorBacktestExportJob' {}
- newCreatePredictorBacktestExportJob :: Text -> Text -> DataDestination -> CreatePredictorBacktestExportJob
- createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag])
- createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination
- data CreatePredictorBacktestExportJobResponse = CreatePredictorBacktestExportJobResponse' {}
- newCreatePredictorBacktestExportJobResponse :: Int -> CreatePredictorBacktestExportJobResponse
- createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text)
- createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int
Creating a Request
data CreatePredictorBacktestExportJob Source #
See: newCreatePredictorBacktestExportJob smart constructor.
Constructors
| CreatePredictorBacktestExportJob' | |
Fields
| |
Instances
newCreatePredictorBacktestExportJob Source #
Arguments
| :: Text |
|
| -> Text | |
| -> DataDestination | |
| -> CreatePredictorBacktestExportJob |
Create a value of CreatePredictorBacktestExportJob 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:
$sel:tags:CreatePredictorBacktestExportJob', createPredictorBacktestExportJob_tags - Optional metadata to help you categorize and organize your backtests.
Each tag consists of a key and an optional value, both of which you
define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:orAWS:. Values can have this prefix. If a tag value hasawsas its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
$sel:predictorBacktestExportJobName:CreatePredictorBacktestExportJob', createPredictorBacktestExportJob_predictorBacktestExportJobName - The name for the backtest export job.
$sel:predictorArn:CreatePredictorBacktestExportJob', createPredictorBacktestExportJob_predictorArn - The Amazon Resource Name (ARN) of the predictor that you want to export.
$sel:destination:CreatePredictorBacktestExportJob', createPredictorBacktestExportJob_destination - Undocumented member.
Request Lenses
createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:orAWS:. Values can have this prefix. If a tag value hasawsas its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text Source #
The name for the backtest export job.
createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor that you want to export.
createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination Source #
Undocumented member.
Destructuring the Response
data CreatePredictorBacktestExportJobResponse Source #
See: newCreatePredictorBacktestExportJobResponse smart constructor.
Constructors
| CreatePredictorBacktestExportJobResponse' | |
Fields
| |
Instances
newCreatePredictorBacktestExportJobResponse Source #
Arguments
| :: Int | |
| -> CreatePredictorBacktestExportJobResponse |
Create a value of CreatePredictorBacktestExportJobResponse 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:
$sel:predictorBacktestExportJobArn:CreatePredictorBacktestExportJobResponse', createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn - The Amazon Resource Name (ARN) of the predictor backtest export job that
you want to export.
$sel:httpStatus:CreatePredictorBacktestExportJobResponse', createPredictorBacktestExportJobResponse_httpStatus - The response's http status code.
Response Lenses
createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.
createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int Source #
The response's http status code.