@pgarbe/cdk-ecr-sync 0.5.27 → 0.5.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +5 -5
- package/.projenrc.ts +5 -0
- package/API.md +106 -50
- package/CHANGELOG.md +1 -1
- package/lib/ecr-sync.d.ts +1 -0
- package/lib/ecr-sync.d.ts.map +1 -0
- package/lib/ecr-sync.js +1 -1
- package/lib/image.d.ts +1 -0
- package/lib/image.d.ts.map +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/lambda/docker-adapter.d.ts +1 -0
- package/lib/lambda/docker-adapter.d.ts.map +1 -0
- package/lib/lambda/ecr-adapter.d.ts +1 -0
- package/lib/lambda/ecr-adapter.d.ts.map +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts.map +1 -0
- package/node_modules/aws-sdk/CHANGELOG.md +153 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +76 -70
- package/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json +129 -121
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +30 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +22 -11
- package/node_modules/aws-sdk/apis/braket-2019-09-01.min.json +30 -27
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +330 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +23 -27
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +10 -8
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +42 -28
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +19 -2
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -8
- package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +155 -127
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +162 -9
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +82 -75
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json +10 -5
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +67 -32
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +332 -205
- package/node_modules/aws-sdk/apis/drs-2020-02-26.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +988 -853
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +18 -0
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +3 -0
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +47 -35
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.examples.json +5 -0
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.min.json +860 -0
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +1 -0
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.min.json +316 -61
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +135 -116
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.min.json +13 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +1858 -495
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +92 -15
- package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +37 -18
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +74 -68
- package/node_modules/aws-sdk/apis/iotevents-data-2018-10-23.min.json +45 -0
- package/node_modules/aws-sdk/apis/iotsecuretunneling-2018-10-05.min.json +28 -0
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +20 -15
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +401 -80
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +443 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +153 -84
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +20 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json +64 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json +145 -8
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +199 -125
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +17 -12
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +1 -0
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +274 -12
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +84 -55
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +213 -120
- package/node_modules/aws-sdk/apis/metadata.json +11 -0
- package/node_modules/aws-sdk/apis/mq-2017-11-27.min.json +22 -7
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +139 -53
- package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.min.json +72 -3
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +56 -0
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +14 -8
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +35 -1
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +20 -7
- package/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +247 -111
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +125 -74
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +124 -124
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +749 -692
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +3 -3
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +20 -18
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +160 -139
- package/node_modules/aws-sdk/apis/ssm-contacts-2021-05-03.examples.json +1 -1
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +48 -37
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +8 -3
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +37 -11
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +37 -36
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.min.json +6 -0
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.paginators.json +8 -4
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +196 -130
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +107 -36
- package/node_modules/aws-sdk/clients/all.d.ts +3 -0
- package/node_modules/aws-sdk/clients/all.js +4 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +5 -5
- package/node_modules/aws-sdk/clients/apigateway.d.ts +327 -324
- package/node_modules/aws-sdk/clients/appflow.d.ts +17 -7
- package/node_modules/aws-sdk/clients/appmesh.d.ts +70 -51
- package/node_modules/aws-sdk/clients/apprunner.d.ts +2 -2
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +4 -4
- package/node_modules/aws-sdk/clients/backup.d.ts +25 -1
- package/node_modules/aws-sdk/clients/batch.d.ts +4 -4
- package/node_modules/aws-sdk/clients/braket.d.ts +7 -2
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.d.ts +348 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.js +18 -0
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +3 -3
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +62 -53
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +15 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +17 -17
- package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +4 -4
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +18 -5
- package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +197 -162
- package/node_modules/aws-sdk/clients/comprehend.d.ts +22 -22
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/connect.d.ts +200 -9
- package/node_modules/aws-sdk/clients/datasync.d.ts +48 -17
- package/node_modules/aws-sdk/clients/discovery.d.ts +63 -26
- package/node_modules/aws-sdk/clients/drs.d.ts +173 -6
- package/node_modules/aws-sdk/clients/ec2.d.ts +236 -56
- package/node_modules/aws-sdk/clients/eks.d.ts +13 -13
- package/node_modules/aws-sdk/clients/elasticache.d.ts +12 -8
- package/node_modules/aws-sdk/clients/emr.d.ts +24 -0
- package/node_modules/aws-sdk/clients/emrserverless.d.ts +890 -0
- package/node_modules/aws-sdk/clients/emrserverless.js +18 -0
- package/node_modules/aws-sdk/clients/eventbridge.js +1 -0
- package/node_modules/aws-sdk/clients/evidently.d.ts +8 -4
- package/node_modules/aws-sdk/clients/forecastservice.d.ts +391 -18
- package/node_modules/aws-sdk/clients/fsx.d.ts +28 -3
- package/node_modules/aws-sdk/clients/gamelift.d.ts +67 -67
- package/node_modules/aws-sdk/clients/gamesparks.d.ts +20 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +2082 -217
- package/node_modules/aws-sdk/clients/grafana.d.ts +72 -1
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +49 -18
- package/node_modules/aws-sdk/clients/guardduty.d.ts +6 -3
- package/node_modules/aws-sdk/clients/iot.d.ts +12 -9
- package/node_modules/aws-sdk/clients/ioteventsdata.d.ts +50 -0
- package/node_modules/aws-sdk/clients/iotsecuretunneling.d.ts +52 -18
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +23 -3
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +356 -25
- package/node_modules/aws-sdk/clients/ivschat.d.ts +523 -0
- package/node_modules/aws-sdk/clients/ivschat.js +18 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +99 -14
- package/node_modules/aws-sdk/clients/kinesisvideo.d.ts +177 -10
- package/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts +94 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +22 -22
- package/node_modules/aws-sdk/clients/lambda.d.ts +4 -4
- package/node_modules/aws-sdk/clients/lightsail.d.ts +162 -47
- package/node_modules/aws-sdk/clients/location.d.ts +20 -16
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +295 -9
- package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +58 -4
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +104 -8
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -4
- package/node_modules/aws-sdk/clients/mq.d.ts +16 -1
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +151 -21
- package/node_modules/aws-sdk/clients/networkmanager.d.ts +56 -10
- package/node_modules/aws-sdk/clients/organizations.d.ts +5 -5
- package/node_modules/aws-sdk/clients/outposts.d.ts +79 -22
- package/node_modules/aws-sdk/clients/personalize.d.ts +12 -8
- package/node_modules/aws-sdk/clients/pricing.d.ts +3 -3
- package/node_modules/aws-sdk/clients/quicksight.d.ts +37 -5
- package/node_modules/aws-sdk/clients/rds.d.ts +37 -1
- package/node_modules/aws-sdk/clients/rdsdataservice.d.ts +22 -7
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -12
- package/node_modules/aws-sdk/clients/rekognition.d.ts +209 -53
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +138 -58
- package/node_modules/aws-sdk/clients/s3.d.ts +8 -8
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +273 -194
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +9 -9
- package/node_modules/aws-sdk/clients/securityhub.d.ts +15 -6
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +4 -4
- package/node_modules/aws-sdk/clients/ssm.d.ts +29 -1
- package/node_modules/aws-sdk/clients/ssmcontacts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +19 -6
- package/node_modules/aws-sdk/clients/sts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/synthetics.d.ts +7 -3
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +479 -447
- package/node_modules/aws-sdk/clients/transfer.d.ts +7 -2
- package/node_modules/aws-sdk/clients/voiceid.d.ts +9 -1
- package/node_modules/aws-sdk/clients/wafv2.d.ts +104 -27
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +38 -4
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +702 -233
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +2644 -1816
- package/node_modules/aws-sdk/dist/aws-sdk.js +3131 -1600
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +90 -89
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +6 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/services/eventbridge.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3util.js +6 -1
- package/node_modules/aws-sdk/package.json +2 -2
- package/node_modules/jszip/.github/workflows/pr.yaml +5 -6
- package/node_modules/jszip/CHANGES.md +5 -0
- package/node_modules/jszip/README.markdown +1 -3
- package/node_modules/jszip/dist/jszip.js +194 -13
- package/node_modules/jszip/dist/jszip.min.js +4 -4
- package/node_modules/jszip/index.d.ts +1 -1
- package/node_modules/jszip/lib/index.js +1 -1
- package/node_modules/jszip/lib/license_header.js +2 -2
- package/node_modules/jszip/lib/utils.js +1 -1
- package/node_modules/jszip/package.json +2 -2
- package/node_modules/jszip/vendor/FileSaver.js +1 -1
- package/node_modules/setimmediate/LICENSE.txt +20 -0
- package/node_modules/setimmediate/package.json +30 -0
- package/node_modules/setimmediate/setImmediate.js +186 -0
- package/node_modules/uuid/CHANGELOG.md +132 -44
- package/node_modules/uuid/CONTRIBUTING.md +20 -0
- package/node_modules/uuid/LICENSE.md +1 -1
- package/node_modules/uuid/README.md +298 -152
- package/node_modules/uuid/dist/bin/uuid +2 -0
- package/node_modules/uuid/dist/bytesToUuid.js +26 -0
- package/node_modules/uuid/dist/esm-browser/bytesToUuid.js +18 -0
- package/node_modules/uuid/dist/esm-browser/index.js +4 -0
- package/node_modules/uuid/dist/esm-browser/md5.js +218 -0
- package/node_modules/uuid/dist/esm-browser/rng.js +15 -0
- package/node_modules/uuid/dist/esm-browser/sha1.js +91 -0
- package/node_modules/uuid/{v1.js → dist/esm-browser/v1.js} +34 -48
- package/node_modules/uuid/dist/esm-browser/v3.js +4 -0
- package/node_modules/uuid/dist/esm-browser/v35.js +56 -0
- package/node_modules/uuid/dist/esm-browser/v4.js +27 -0
- package/node_modules/uuid/dist/esm-browser/v5.js +4 -0
- package/node_modules/uuid/dist/esm-node/bytesToUuid.js +18 -0
- package/node_modules/uuid/dist/esm-node/index.js +4 -0
- package/node_modules/uuid/dist/esm-node/md5.js +13 -0
- package/node_modules/uuid/dist/esm-node/rng.js +4 -0
- package/node_modules/uuid/dist/esm-node/sha1.js +13 -0
- package/node_modules/uuid/dist/esm-node/v1.js +95 -0
- package/node_modules/uuid/dist/esm-node/v3.js +4 -0
- package/node_modules/uuid/{lib → dist/esm-node}/v35.js +21 -22
- package/node_modules/uuid/dist/esm-node/v4.js +27 -0
- package/node_modules/uuid/dist/esm-node/v5.js +4 -0
- package/node_modules/uuid/dist/index.js +39 -0
- package/node_modules/uuid/{lib → dist}/md5-browser.js +58 -50
- package/node_modules/uuid/dist/md5.js +23 -0
- package/node_modules/uuid/dist/rng-browser.js +21 -0
- package/node_modules/uuid/dist/rng.js +14 -0
- package/node_modules/uuid/dist/sha1-browser.js +95 -0
- package/node_modules/uuid/dist/sha1.js +23 -0
- package/node_modules/uuid/dist/umd/uuid.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv1.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv3.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv4.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv5.min.js +1 -0
- package/node_modules/uuid/dist/uuid-bin.js +67 -0
- package/node_modules/uuid/dist/v1.js +107 -0
- package/node_modules/uuid/dist/v3.js +16 -0
- package/node_modules/uuid/dist/v35.js +69 -0
- package/node_modules/uuid/dist/v4.js +40 -0
- package/node_modules/uuid/dist/v5.js +16 -0
- package/node_modules/uuid/package.json +92 -19
- package/node_modules/uuid/wrapper.mjs +5 -0
- package/package.json +17 -14
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/node_modules/set-immediate-shim/index.js +0 -7
- package/node_modules/set-immediate-shim/package.json +0 -34
- package/node_modules/set-immediate-shim/readme.md +0 -31
- package/node_modules/uuid/.eslintrc.json +0 -47
- package/node_modules/uuid/AUTHORS +0 -5
- package/node_modules/uuid/README_js.md +0 -280
- package/node_modules/uuid/bin/uuid +0 -65
- package/node_modules/uuid/index.js +0 -8
- package/node_modules/uuid/lib/bytesToUuid.js +0 -24
- package/node_modules/uuid/lib/md5.js +0 -25
- package/node_modules/uuid/lib/rng-browser.js +0 -34
- package/node_modules/uuid/lib/rng.js +0 -8
- package/node_modules/uuid/lib/sha1-browser.js +0 -89
- package/node_modules/uuid/lib/sha1.js +0 -25
- package/node_modules/uuid/v3.js +0 -4
- package/node_modules/uuid/v4.js +0 -29
- package/node_modules/uuid/v5.js +0 -3
|
@@ -12,35 +12,35 @@ declare class ForecastService extends Service {
|
|
|
12
12
|
constructor(options?: ForecastService.Types.ClientConfiguration)
|
|
13
13
|
config: Config & ForecastService.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor: PredictorName - A unique name for the predictor. DatasetGroupArn - The ARN of the dataset group used to train the predictor. ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc). ForecastHorizon - The number of time
|
|
15
|
+
* Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor: PredictorName - A unique name for the predictor. DatasetGroupArn - The ARN of the dataset group used to train the predictor. ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc). ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. When creating a new predictor, do not specify a value for ReferencePredictorArn. Upgrading and retraining predictors The following parameters are required when retraining or upgrading a predictor: PredictorName - A unique name for the predictor. ReferencePredictorArn - The ARN of the predictor to retrain or upgrade. When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName.
|
|
16
16
|
*/
|
|
17
17
|
createAutoPredictor(params: ForecastService.Types.CreateAutoPredictorRequest, callback?: (err: AWSError, data: ForecastService.Types.CreateAutoPredictorResponse) => void): Request<ForecastService.Types.CreateAutoPredictorResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor: PredictorName - A unique name for the predictor. DatasetGroupArn - The ARN of the dataset group used to train the predictor. ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc). ForecastHorizon - The number of time
|
|
19
|
+
* Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor: PredictorName - A unique name for the predictor. DatasetGroupArn - The ARN of the dataset group used to train the predictor. ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc). ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. When creating a new predictor, do not specify a value for ReferencePredictorArn. Upgrading and retraining predictors The following parameters are required when retraining or upgrading a predictor: PredictorName - A unique name for the predictor. ReferencePredictorArn - The ARN of the predictor to retrain or upgrade. When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName.
|
|
20
20
|
*/
|
|
21
21
|
createAutoPredictor(callback?: (err: AWSError, data: ForecastService.Types.CreateAutoPredictorResponse) => void): Request<ForecastService.Types.CreateAutoPredictorResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: DataFrequency - How frequently your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see
|
|
23
|
+
* Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: DataFrequency - How frequently your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets. To get a list of all your datasets, use the ListDatasets operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub repository. The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.
|
|
24
24
|
*/
|
|
25
25
|
createDataset(params: ForecastService.Types.CreateDatasetRequest, callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetResponse) => void): Request<ForecastService.Types.CreateDatasetResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: DataFrequency - How frequently your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see
|
|
27
|
+
* Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: DataFrequency - How frequently your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets. To get a list of all your datasets, use the ListDatasets operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub repository. The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.
|
|
28
28
|
*/
|
|
29
29
|
createDataset(callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetResponse) => void): Request<ForecastService.Types.CreateDatasetResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see
|
|
31
|
+
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
|
|
32
32
|
*/
|
|
33
33
|
createDatasetGroup(params: ForecastService.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetGroupResponse) => void): Request<ForecastService.Types.CreateDatasetGroupResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see
|
|
35
|
+
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
|
|
36
36
|
*/
|
|
37
37
|
createDatasetGroup(callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetGroupResponse) => void): Request<ForecastService.Types.CreateDatasetGroupResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see
|
|
39
|
+
* Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see Set up permissions. The training data must be in CSV format. The delimiter must be a comma (,). You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files. Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import. To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
|
|
40
40
|
*/
|
|
41
41
|
createDatasetImportJob(params: ForecastService.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetImportJobResponse) => void): Request<ForecastService.Types.CreateDatasetImportJobResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see
|
|
43
|
+
* Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see Set up permissions. The training data must be in CSV format. The delimiter must be a comma (,). You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files. Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import. To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
|
|
44
44
|
*/
|
|
45
45
|
createDatasetImportJob(callback?: (err: AWSError, data: ForecastService.Types.CreateDatasetImportJobResponse) => void): Request<ForecastService.Types.CreateDatasetImportJobResponse, AWSError>;
|
|
46
46
|
/**
|
|
@@ -75,6 +75,14 @@ declare class ForecastService extends Service {
|
|
|
75
75
|
* Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: <ForecastExportJobName>_<ExportTimestamp>_<PartNumber> where 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 forecast export jobs, use the ListForecastExportJobs 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 DescribeForecastExportJob operation.
|
|
76
76
|
*/
|
|
77
77
|
createForecastExportJob(callback?: (err: AWSError, data: ForecastService.Types.CreateForecastExportJobResponse) => void): Request<ForecastService.Types.CreateForecastExportJobResponse, AWSError>;
|
|
78
|
+
/**
|
|
79
|
+
* Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
|
|
80
|
+
*/
|
|
81
|
+
createMonitor(params: ForecastService.Types.CreateMonitorRequest, callback?: (err: AWSError, data: ForecastService.Types.CreateMonitorResponse) => void): Request<ForecastService.Types.CreateMonitorResponse, AWSError>;
|
|
82
|
+
/**
|
|
83
|
+
* Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
|
|
84
|
+
*/
|
|
85
|
+
createMonitor(callback?: (err: AWSError, data: ForecastService.Types.CreateMonitorResponse) => void): Request<ForecastService.Types.CreateMonitorResponse, AWSError>;
|
|
78
86
|
/**
|
|
79
87
|
* This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor. Creates an Amazon Forecast predictor. In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters. Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation. To see the evaluation metrics, use the GetAccuracyMetrics operation. You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig. For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups. By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes. AutoML If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult. When AutoML is enabled, the following properties are disallowed: AlgorithmArn HPOConfig PerformHPO TrainingParameters To get a list of all of your predictors, use the ListPredictors operation. Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.
|
|
80
88
|
*/
|
|
@@ -92,11 +100,11 @@ declare class ForecastService extends Service {
|
|
|
92
100
|
*/
|
|
93
101
|
createPredictorBacktestExportJob(callback?: (err: AWSError, data: ForecastService.Types.CreatePredictorBacktestExportJobResponse) => void): Request<ForecastService.Types.CreatePredictorBacktestExportJobResponse, AWSError>;
|
|
94
102
|
/**
|
|
95
|
-
* Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
|
|
103
|
+
* Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
|
|
96
104
|
*/
|
|
97
105
|
deleteDataset(params: ForecastService.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
98
106
|
/**
|
|
99
|
-
* Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
|
|
107
|
+
* Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
|
|
100
108
|
*/
|
|
101
109
|
deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
102
110
|
/**
|
|
@@ -147,6 +155,14 @@ declare class ForecastService extends Service {
|
|
|
147
155
|
* Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.
|
|
148
156
|
*/
|
|
149
157
|
deleteForecastExportJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
158
|
+
/**
|
|
159
|
+
* Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
|
|
160
|
+
*/
|
|
161
|
+
deleteMonitor(params: ForecastService.Types.DeleteMonitorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
162
|
+
/**
|
|
163
|
+
* Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
|
|
164
|
+
*/
|
|
165
|
+
deleteMonitor(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
150
166
|
/**
|
|
151
167
|
* Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.
|
|
152
168
|
*/
|
|
@@ -235,6 +251,14 @@ declare class ForecastService extends Service {
|
|
|
235
251
|
* Describes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message - If an error occurred, information about the error.
|
|
236
252
|
*/
|
|
237
253
|
describeForecastExportJob(callback?: (err: AWSError, data: ForecastService.Types.DescribeForecastExportJobResponse) => void): Request<ForecastService.Types.DescribeForecastExportJobResponse, AWSError>;
|
|
254
|
+
/**
|
|
255
|
+
* Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties: Baseline CreationTime LastEvaluationTime LastEvaluationState LastModificationTime Message Status
|
|
256
|
+
*/
|
|
257
|
+
describeMonitor(params: ForecastService.Types.DescribeMonitorRequest, callback?: (err: AWSError, data: ForecastService.Types.DescribeMonitorResponse) => void): Request<ForecastService.Types.DescribeMonitorResponse, AWSError>;
|
|
258
|
+
/**
|
|
259
|
+
* Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties: Baseline CreationTime LastEvaluationTime LastEvaluationState LastModificationTime Message Status
|
|
260
|
+
*/
|
|
261
|
+
describeMonitor(callback?: (err: AWSError, data: ForecastService.Types.DescribeMonitorResponse) => void): Request<ForecastService.Types.DescribeMonitorResponse, AWSError>;
|
|
238
262
|
/**
|
|
239
263
|
* This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor. Describes a predictor created using the CreatePredictor operation. In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties: DatasetImportJobArns - The dataset import jobs used to import training data. AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated. CreationTime LastModificationTime Status Message - If an error occurred, information about the error.
|
|
240
264
|
*/
|
|
@@ -315,6 +339,22 @@ declare class ForecastService extends Service {
|
|
|
315
339
|
* Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
|
|
316
340
|
*/
|
|
317
341
|
listForecasts(callback?: (err: AWSError, data: ForecastService.Types.ListForecastsResponse) => void): Request<ForecastService.Types.ListForecastsResponse, AWSError>;
|
|
342
|
+
/**
|
|
343
|
+
* Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
|
|
344
|
+
*/
|
|
345
|
+
listMonitorEvaluations(params: ForecastService.Types.ListMonitorEvaluationsRequest, callback?: (err: AWSError, data: ForecastService.Types.ListMonitorEvaluationsResponse) => void): Request<ForecastService.Types.ListMonitorEvaluationsResponse, AWSError>;
|
|
346
|
+
/**
|
|
347
|
+
* Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
|
|
348
|
+
*/
|
|
349
|
+
listMonitorEvaluations(callback?: (err: AWSError, data: ForecastService.Types.ListMonitorEvaluationsResponse) => void): Request<ForecastService.Types.ListMonitorEvaluationsResponse, AWSError>;
|
|
350
|
+
/**
|
|
351
|
+
* Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
|
|
352
|
+
*/
|
|
353
|
+
listMonitors(params: ForecastService.Types.ListMonitorsRequest, callback?: (err: AWSError, data: ForecastService.Types.ListMonitorsResponse) => void): Request<ForecastService.Types.ListMonitorsResponse, AWSError>;
|
|
354
|
+
/**
|
|
355
|
+
* Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
|
|
356
|
+
*/
|
|
357
|
+
listMonitors(callback?: (err: AWSError, data: ForecastService.Types.ListMonitorsResponse) => void): Request<ForecastService.Types.ListMonitorsResponse, AWSError>;
|
|
318
358
|
/**
|
|
319
359
|
* Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.
|
|
320
360
|
*/
|
|
@@ -339,6 +379,14 @@ declare class ForecastService extends Service {
|
|
|
339
379
|
* Lists the tags for an Amazon Forecast resource.
|
|
340
380
|
*/
|
|
341
381
|
listTagsForResource(callback?: (err: AWSError, data: ForecastService.Types.ListTagsForResourceResponse) => void): Request<ForecastService.Types.ListTagsForResourceResponse, AWSError>;
|
|
382
|
+
/**
|
|
383
|
+
* Resumes a stopped monitor resource.
|
|
384
|
+
*/
|
|
385
|
+
resumeResource(params: ForecastService.Types.ResumeResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
386
|
+
/**
|
|
387
|
+
* Resumes a stopped monitor resource.
|
|
388
|
+
*/
|
|
389
|
+
resumeResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
342
390
|
/**
|
|
343
391
|
* Stops a resource. The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped. This operation can be applied to the following resources (and their corresponding child resources): Dataset Import Job Predictor Job Forecast Job Forecast Export Job Predictor Backtest Export Job Explainability Job Explainability Export Job
|
|
344
392
|
*/
|
|
@@ -379,7 +427,7 @@ declare namespace ForecastService {
|
|
|
379
427
|
*/
|
|
380
428
|
Name: Name;
|
|
381
429
|
/**
|
|
382
|
-
* Weather Index To enable the Weather Index, do not specify a value for Configuration. Holidays To enable Holidays, set CountryCode to one of the following two-letter country codes: "AL" - ALBANIA "AR" - ARGENTINA "AT" - AUSTRIA "AU" - AUSTRALIA "BA" - BOSNIA HERZEGOVINA "BE" - BELGIUM "BG" - BULGARIA "BO" - BOLIVIA "BR" - BRAZIL "BY" - BELARUS "CA" - CANADA "CL" - CHILE "CO" - COLOMBIA "CR" - COSTA RICA "HR" - CROATIA "CZ" - CZECH REPUBLIC "DK" - DENMARK "EC" - ECUADOR "EE" - ESTONIA "ET" - ETHIOPIA "FI" - FINLAND "FR" - FRANCE "DE" - GERMANY "GR" - GREECE "HU" - HUNGARY "IS" - ICELAND "IN" - INDIA "IE" - IRELAND "IT" - ITALY "JP" - JAPAN "KZ" - KAZAKHSTAN "KR" - KOREA "LV" - LATVIA "LI" - LIECHTENSTEIN "LT" - LITHUANIA "LU" - LUXEMBOURG "MK" - MACEDONIA "MT" - MALTA "MX" - MEXICO "MD" - MOLDOVA "ME" - MONTENEGRO "NL" - NETHERLANDS "NZ" - NEW ZEALAND "NI" - NICARAGUA "NG" - NIGERIA "NO" - NORWAY "PA" - PANAMA "PY" - PARAGUAY "PE" - PERU "PL" - POLAND "PT" - PORTUGAL "RO" - ROMANIA "RU" - RUSSIA "RS" - SERBIA "SK" - SLOVAKIA "SI" - SLOVENIA "ZA" - SOUTH AFRICA "ES" - SPAIN "SE" - SWEDEN "CH" - SWITZERLAND "UA" - UKRAINE "AE" - UNITED ARAB EMIRATES "US" - UNITED STATES "UK" - UNITED KINGDOM "UY" - URUGUAY "VE" - VENEZUELA
|
|
430
|
+
* Weather Index To enable the Weather Index, do not specify a value for Configuration. Holidays Holidays To enable Holidays, set CountryCode to one of the following two-letter country codes: "AL" - ALBANIA "AR" - ARGENTINA "AT" - AUSTRIA "AU" - AUSTRALIA "BA" - BOSNIA HERZEGOVINA "BE" - BELGIUM "BG" - BULGARIA "BO" - BOLIVIA "BR" - BRAZIL "BY" - BELARUS "CA" - CANADA "CL" - CHILE "CO" - COLOMBIA "CR" - COSTA RICA "HR" - CROATIA "CZ" - CZECH REPUBLIC "DK" - DENMARK "EC" - ECUADOR "EE" - ESTONIA "ET" - ETHIOPIA "FI" - FINLAND "FR" - FRANCE "DE" - GERMANY "GR" - GREECE "HU" - HUNGARY "IS" - ICELAND "IN" - INDIA "IE" - IRELAND "IT" - ITALY "JP" - JAPAN "KZ" - KAZAKHSTAN "KR" - KOREA "LV" - LATVIA "LI" - LIECHTENSTEIN "LT" - LITHUANIA "LU" - LUXEMBOURG "MK" - MACEDONIA "MT" - MALTA "MX" - MEXICO "MD" - MOLDOVA "ME" - MONTENEGRO "NL" - NETHERLANDS "NZ" - NEW ZEALAND "NI" - NICARAGUA "NG" - NIGERIA "NO" - NORWAY "PA" - PANAMA "PY" - PARAGUAY "PE" - PERU "PL" - POLAND "PT" - PORTUGAL "RO" - ROMANIA "RU" - RUSSIA "RS" - SERBIA "SK" - SLOVAKIA "SI" - SLOVENIA "ZA" - SOUTH AFRICA "ES" - SPAIN "SE" - SWEDEN "CH" - SWITZERLAND "UA" - UKRAINE "AE" - UNITED ARAB EMIRATES "US" - UNITED STATES "UK" - UNITED KINGDOM "UY" - URUGUAY "VE" - VENEZUELA
|
|
383
431
|
*/
|
|
384
432
|
Configuration?: Configuration;
|
|
385
433
|
}
|
|
@@ -399,6 +447,23 @@ declare namespace ForecastService {
|
|
|
399
447
|
export type AttributeConfigs = AttributeConfig[];
|
|
400
448
|
export type AttributeType = "string"|"integer"|"float"|"timestamp"|"geolocation"|string;
|
|
401
449
|
export type AutoMLOverrideStrategy = "LatencyOptimized"|"AccuracyOptimized"|string;
|
|
450
|
+
export interface Baseline {
|
|
451
|
+
/**
|
|
452
|
+
* The initial accuracy metrics for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.
|
|
453
|
+
*/
|
|
454
|
+
PredictorBaseline?: PredictorBaseline;
|
|
455
|
+
}
|
|
456
|
+
export interface BaselineMetric {
|
|
457
|
+
/**
|
|
458
|
+
* The name of the metric.
|
|
459
|
+
*/
|
|
460
|
+
Name?: Name;
|
|
461
|
+
/**
|
|
462
|
+
* The value for the metric.
|
|
463
|
+
*/
|
|
464
|
+
Value?: Double;
|
|
465
|
+
}
|
|
466
|
+
export type BaselineMetrics = BaselineMetric[];
|
|
402
467
|
export type Boolean = boolean;
|
|
403
468
|
export interface CategoricalParameterRange {
|
|
404
469
|
/**
|
|
@@ -437,7 +502,7 @@ declare namespace ForecastService {
|
|
|
437
502
|
*/
|
|
438
503
|
PredictorName: Name;
|
|
439
504
|
/**
|
|
440
|
-
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
|
|
505
|
+
* The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you cannot update the forecast horizon parameter. You can meet this requirement by providing longer time-series in the dataset.
|
|
441
506
|
*/
|
|
442
507
|
ForecastHorizon?: Integer;
|
|
443
508
|
/**
|
|
@@ -473,6 +538,14 @@ declare namespace ForecastService {
|
|
|
473
538
|
* Optional metadata to help you categorize and organize your predictors. 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: or AWS:. Values can have this prefix. If a tag value has aws as 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 of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
|
|
474
539
|
*/
|
|
475
540
|
Tags?: Tags;
|
|
541
|
+
/**
|
|
542
|
+
* The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
|
|
543
|
+
*/
|
|
544
|
+
MonitorConfig?: MonitorConfig;
|
|
545
|
+
/**
|
|
546
|
+
* The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair. For more information on specifying a time boundary, see Specifying a Time Boundary. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
|
|
547
|
+
*/
|
|
548
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
476
549
|
}
|
|
477
550
|
export interface CreateAutoPredictorResponse {
|
|
478
551
|
/**
|
|
@@ -486,7 +559,7 @@ declare namespace ForecastService {
|
|
|
486
559
|
*/
|
|
487
560
|
DatasetGroupName: Name;
|
|
488
561
|
/**
|
|
489
|
-
* The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match. The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see
|
|
562
|
+
* The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match. The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.
|
|
490
563
|
*/
|
|
491
564
|
Domain: Domain;
|
|
492
565
|
/**
|
|
@@ -550,7 +623,7 @@ declare namespace ForecastService {
|
|
|
550
623
|
*/
|
|
551
624
|
DatasetName: Name;
|
|
552
625
|
/**
|
|
553
|
-
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see
|
|
626
|
+
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see Importing datasets.
|
|
554
627
|
*/
|
|
555
628
|
Domain: Domain;
|
|
556
629
|
/**
|
|
@@ -562,7 +635,7 @@ declare namespace ForecastService {
|
|
|
562
635
|
*/
|
|
563
636
|
DataFrequency?: Frequency;
|
|
564
637
|
/**
|
|
565
|
-
* The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see
|
|
638
|
+
* The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types.
|
|
566
639
|
*/
|
|
567
640
|
Schema: Schema;
|
|
568
641
|
/**
|
|
@@ -617,7 +690,7 @@ declare namespace ForecastService {
|
|
|
617
690
|
DataSource?: DataSource;
|
|
618
691
|
Schema?: Schema;
|
|
619
692
|
/**
|
|
620
|
-
* Create an
|
|
693
|
+
* Create an Explainability visualization that is viewable within the AWS console.
|
|
621
694
|
*/
|
|
622
695
|
EnableVisualization?: Boolean;
|
|
623
696
|
/**
|
|
@@ -673,7 +746,7 @@ declare namespace ForecastService {
|
|
|
673
746
|
*/
|
|
674
747
|
PredictorArn: Arn;
|
|
675
748
|
/**
|
|
676
|
-
* The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).
|
|
749
|
+
* The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
|
|
677
750
|
*/
|
|
678
751
|
ForecastTypes?: ForecastTypes;
|
|
679
752
|
/**
|
|
@@ -687,6 +760,26 @@ declare namespace ForecastService {
|
|
|
687
760
|
*/
|
|
688
761
|
ForecastArn?: Arn;
|
|
689
762
|
}
|
|
763
|
+
export interface CreateMonitorRequest {
|
|
764
|
+
/**
|
|
765
|
+
* The name of the monitor resource.
|
|
766
|
+
*/
|
|
767
|
+
MonitorName: Name;
|
|
768
|
+
/**
|
|
769
|
+
* The Amazon Resource Name (ARN) of the predictor to monitor.
|
|
770
|
+
*/
|
|
771
|
+
ResourceArn: Arn;
|
|
772
|
+
/**
|
|
773
|
+
* A list of tags to apply to the monitor resource.
|
|
774
|
+
*/
|
|
775
|
+
Tags?: Tags;
|
|
776
|
+
}
|
|
777
|
+
export interface CreateMonitorResponse {
|
|
778
|
+
/**
|
|
779
|
+
* The Amazon Resource Name (ARN) of the monitor resource.
|
|
780
|
+
*/
|
|
781
|
+
MonitorArn?: Arn;
|
|
782
|
+
}
|
|
690
783
|
export interface CreatePredictorBacktestExportJobRequest {
|
|
691
784
|
/**
|
|
692
785
|
* The name for the backtest export job.
|
|
@@ -880,6 +973,8 @@ declare namespace ForecastService {
|
|
|
880
973
|
}
|
|
881
974
|
export type DatasetType = "TARGET_TIME_SERIES"|"RELATED_TIME_SERIES"|"ITEM_METADATA"|string;
|
|
882
975
|
export type Datasets = DatasetSummary[];
|
|
976
|
+
export type DayOfMonth = number;
|
|
977
|
+
export type DayOfWeek = "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY"|string;
|
|
883
978
|
export interface DeleteDatasetGroupRequest {
|
|
884
979
|
/**
|
|
885
980
|
* The Amazon Resource Name (ARN) of the dataset group to delete.
|
|
@@ -922,6 +1017,12 @@ declare namespace ForecastService {
|
|
|
922
1017
|
*/
|
|
923
1018
|
ForecastArn: Arn;
|
|
924
1019
|
}
|
|
1020
|
+
export interface DeleteMonitorRequest {
|
|
1021
|
+
/**
|
|
1022
|
+
* The Amazon Resource Name (ARN) of the monitor resource to delete.
|
|
1023
|
+
*/
|
|
1024
|
+
MonitorArn: Arn;
|
|
1025
|
+
}
|
|
925
1026
|
export interface DeletePredictorBacktestExportJobRequest {
|
|
926
1027
|
/**
|
|
927
1028
|
* The Amazon Resource Name (ARN) of the predictor backtest export job to delete.
|
|
@@ -1012,6 +1113,14 @@ declare namespace ForecastService {
|
|
|
1012
1113
|
* Provides the status and ARN of the Predictor Explainability.
|
|
1013
1114
|
*/
|
|
1014
1115
|
ExplainabilityInfo?: ExplainabilityInfo;
|
|
1116
|
+
/**
|
|
1117
|
+
* A object with the Amazon Resource Name (ARN) and status of the monitor resource.
|
|
1118
|
+
*/
|
|
1119
|
+
MonitorInfo?: MonitorInfo;
|
|
1120
|
+
/**
|
|
1121
|
+
* The time boundary Forecast uses when aggregating data.
|
|
1122
|
+
*/
|
|
1123
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
1015
1124
|
}
|
|
1016
1125
|
export interface DescribeDatasetGroupRequest {
|
|
1017
1126
|
/**
|
|
@@ -1348,6 +1457,58 @@ declare namespace ForecastService {
|
|
|
1348
1457
|
*/
|
|
1349
1458
|
LastModificationTime?: Timestamp;
|
|
1350
1459
|
}
|
|
1460
|
+
export interface DescribeMonitorRequest {
|
|
1461
|
+
/**
|
|
1462
|
+
* The Amazon Resource Name (ARN) of the monitor resource to describe.
|
|
1463
|
+
*/
|
|
1464
|
+
MonitorArn: Arn;
|
|
1465
|
+
}
|
|
1466
|
+
export interface DescribeMonitorResponse {
|
|
1467
|
+
/**
|
|
1468
|
+
* The name of the monitor.
|
|
1469
|
+
*/
|
|
1470
|
+
MonitorName?: Name;
|
|
1471
|
+
/**
|
|
1472
|
+
* The Amazon Resource Name (ARN) of the monitor resource described.
|
|
1473
|
+
*/
|
|
1474
|
+
MonitorArn?: Arn;
|
|
1475
|
+
/**
|
|
1476
|
+
* The Amazon Resource Name (ARN) of the auto predictor being monitored.
|
|
1477
|
+
*/
|
|
1478
|
+
ResourceArn?: Arn;
|
|
1479
|
+
/**
|
|
1480
|
+
* The status of the monitor resource.
|
|
1481
|
+
*/
|
|
1482
|
+
Status?: Status;
|
|
1483
|
+
/**
|
|
1484
|
+
* The timestamp of the latest evaluation completed by the monitor.
|
|
1485
|
+
*/
|
|
1486
|
+
LastEvaluationTime?: Timestamp;
|
|
1487
|
+
/**
|
|
1488
|
+
* The state of the monitor's latest evaluation.
|
|
1489
|
+
*/
|
|
1490
|
+
LastEvaluationState?: EvaluationState;
|
|
1491
|
+
/**
|
|
1492
|
+
* Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
|
|
1493
|
+
*/
|
|
1494
|
+
Baseline?: Baseline;
|
|
1495
|
+
/**
|
|
1496
|
+
* An error message, if any, for the monitor.
|
|
1497
|
+
*/
|
|
1498
|
+
Message?: Message;
|
|
1499
|
+
/**
|
|
1500
|
+
* The timestamp for when the monitor resource was created.
|
|
1501
|
+
*/
|
|
1502
|
+
CreationTime?: Timestamp;
|
|
1503
|
+
/**
|
|
1504
|
+
* The timestamp of the latest modification to the monitor.
|
|
1505
|
+
*/
|
|
1506
|
+
LastModificationTime?: Timestamp;
|
|
1507
|
+
/**
|
|
1508
|
+
* The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
|
|
1509
|
+
*/
|
|
1510
|
+
EstimatedEvaluationTimeRemainingInMinutes?: Long;
|
|
1511
|
+
}
|
|
1351
1512
|
export interface DescribePredictorBacktestExportJobRequest {
|
|
1352
1513
|
/**
|
|
1353
1514
|
* The Amazon Resource Name (ARN) of the predictor backtest export job.
|
|
@@ -1489,6 +1650,7 @@ declare namespace ForecastService {
|
|
|
1489
1650
|
*/
|
|
1490
1651
|
OptimizationMetric?: OptimizationMetric;
|
|
1491
1652
|
}
|
|
1653
|
+
export type Detail = string;
|
|
1492
1654
|
export type Domain = "RETAIL"|"CUSTOM"|"INVENTORY_PLANNING"|"EC2_CAPACITY"|"WORK_FORCE"|"WEB_TRAFFIC"|"METRICS"|string;
|
|
1493
1655
|
export type Double = number;
|
|
1494
1656
|
export interface EncryptionConfig {
|
|
@@ -1545,6 +1707,7 @@ declare namespace ForecastService {
|
|
|
1545
1707
|
*/
|
|
1546
1708
|
TestWindows?: TestWindows;
|
|
1547
1709
|
}
|
|
1710
|
+
export type EvaluationState = string;
|
|
1548
1711
|
export type EvaluationType = "SUMMARY"|"COMPUTED"|string;
|
|
1549
1712
|
export type Explainabilities = ExplainabilitySummary[];
|
|
1550
1713
|
export interface ExplainabilityConfig {
|
|
@@ -1783,6 +1946,7 @@ declare namespace ForecastService {
|
|
|
1783
1946
|
*/
|
|
1784
1947
|
OptimizationMetric?: OptimizationMetric;
|
|
1785
1948
|
}
|
|
1949
|
+
export type Hour = number;
|
|
1786
1950
|
export interface HyperParameterTuningJobConfig {
|
|
1787
1951
|
/**
|
|
1788
1952
|
* Specifies the ranges of valid values for the hyperparameters.
|
|
@@ -1980,6 +2144,58 @@ declare namespace ForecastService {
|
|
|
1980
2144
|
*/
|
|
1981
2145
|
NextToken?: NextToken;
|
|
1982
2146
|
}
|
|
2147
|
+
export interface ListMonitorEvaluationsRequest {
|
|
2148
|
+
/**
|
|
2149
|
+
* If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
|
|
2150
|
+
*/
|
|
2151
|
+
NextToken?: NextToken;
|
|
2152
|
+
/**
|
|
2153
|
+
* The maximum number of monitoring results to return.
|
|
2154
|
+
*/
|
|
2155
|
+
MaxResults?: MaxResults;
|
|
2156
|
+
/**
|
|
2157
|
+
* The Amazon Resource Name (ARN) of the monitor resource to get results from.
|
|
2158
|
+
*/
|
|
2159
|
+
MonitorArn: Arn;
|
|
2160
|
+
/**
|
|
2161
|
+
* An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. Key - The name of the parameter to filter on. The only valid value is EvaluationState. Value - The value to match. Valid values are only SUCCESS or FAILURE. For example, to list only successful monitor evaluations, you would specify: "Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]
|
|
2162
|
+
*/
|
|
2163
|
+
Filters?: Filters;
|
|
2164
|
+
}
|
|
2165
|
+
export interface ListMonitorEvaluationsResponse {
|
|
2166
|
+
/**
|
|
2167
|
+
* If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
|
|
2168
|
+
*/
|
|
2169
|
+
NextToken?: NextToken;
|
|
2170
|
+
/**
|
|
2171
|
+
* The monitoring results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.
|
|
2172
|
+
*/
|
|
2173
|
+
PredictorMonitorEvaluations?: PredictorMonitorEvaluations;
|
|
2174
|
+
}
|
|
2175
|
+
export interface ListMonitorsRequest {
|
|
2176
|
+
/**
|
|
2177
|
+
* If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
|
|
2178
|
+
*/
|
|
2179
|
+
NextToken?: NextToken;
|
|
2180
|
+
/**
|
|
2181
|
+
* The maximum number of monitors to include in the response.
|
|
2182
|
+
*/
|
|
2183
|
+
MaxResults?: MaxResults;
|
|
2184
|
+
/**
|
|
2185
|
+
* An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. Key - The name of the parameter to filter on. The only valid value is Status. Value - The value to match. For example, to list all monitors who's status is ACTIVE, you would specify: "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
|
|
2186
|
+
*/
|
|
2187
|
+
Filters?: Filters;
|
|
2188
|
+
}
|
|
2189
|
+
export interface ListMonitorsResponse {
|
|
2190
|
+
/**
|
|
2191
|
+
* An array of objects that summarize each monitor's properties.
|
|
2192
|
+
*/
|
|
2193
|
+
Monitors?: Monitors;
|
|
2194
|
+
/**
|
|
2195
|
+
* If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
|
|
2196
|
+
*/
|
|
2197
|
+
NextToken?: NextToken;
|
|
2198
|
+
}
|
|
1983
2199
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
1984
2200
|
/**
|
|
1985
2201
|
* If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
|
|
@@ -2044,6 +2260,18 @@ declare namespace ForecastService {
|
|
|
2044
2260
|
export type Long = number;
|
|
2045
2261
|
export type MaxResults = number;
|
|
2046
2262
|
export type Message = string;
|
|
2263
|
+
export type MetricName = string;
|
|
2264
|
+
export interface MetricResult {
|
|
2265
|
+
/**
|
|
2266
|
+
* The name of the metric.
|
|
2267
|
+
*/
|
|
2268
|
+
MetricName?: MetricName;
|
|
2269
|
+
/**
|
|
2270
|
+
* The value for the metric.
|
|
2271
|
+
*/
|
|
2272
|
+
MetricValue?: Double;
|
|
2273
|
+
}
|
|
2274
|
+
export type MetricResults = MetricResult[];
|
|
2047
2275
|
export interface Metrics {
|
|
2048
2276
|
/**
|
|
2049
2277
|
* The root-mean-square error (RMSE).
|
|
@@ -2062,6 +2290,64 @@ declare namespace ForecastService {
|
|
|
2062
2290
|
*/
|
|
2063
2291
|
AverageWeightedQuantileLoss?: Double;
|
|
2064
2292
|
}
|
|
2293
|
+
export interface MonitorConfig {
|
|
2294
|
+
/**
|
|
2295
|
+
* The name of the monitor resource.
|
|
2296
|
+
*/
|
|
2297
|
+
MonitorName: Name;
|
|
2298
|
+
}
|
|
2299
|
+
export interface MonitorDataSource {
|
|
2300
|
+
/**
|
|
2301
|
+
* The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.
|
|
2302
|
+
*/
|
|
2303
|
+
DatasetImportJobArn?: Arn;
|
|
2304
|
+
/**
|
|
2305
|
+
* The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.
|
|
2306
|
+
*/
|
|
2307
|
+
ForecastArn?: Arn;
|
|
2308
|
+
/**
|
|
2309
|
+
* The Amazon Resource Name (ARN) of the predictor resource you are monitoring.
|
|
2310
|
+
*/
|
|
2311
|
+
PredictorArn?: Arn;
|
|
2312
|
+
}
|
|
2313
|
+
export interface MonitorInfo {
|
|
2314
|
+
/**
|
|
2315
|
+
* The Amazon Resource Name (ARN) of the monitor resource.
|
|
2316
|
+
*/
|
|
2317
|
+
MonitorArn?: Arn;
|
|
2318
|
+
/**
|
|
2319
|
+
* The status of the monitor. States include: ACTIVE ACTIVE_STOPPING, ACTIVE_STOPPED UPDATE_IN_PROGRESS CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
|
|
2320
|
+
*/
|
|
2321
|
+
Status?: Status;
|
|
2322
|
+
}
|
|
2323
|
+
export interface MonitorSummary {
|
|
2324
|
+
/**
|
|
2325
|
+
* The Amazon Resource Name (ARN) of the monitor resource.
|
|
2326
|
+
*/
|
|
2327
|
+
MonitorArn?: Arn;
|
|
2328
|
+
/**
|
|
2329
|
+
* The name of the monitor resource.
|
|
2330
|
+
*/
|
|
2331
|
+
MonitorName?: Name;
|
|
2332
|
+
/**
|
|
2333
|
+
* The Amazon Resource Name (ARN) of the predictor being monitored.
|
|
2334
|
+
*/
|
|
2335
|
+
ResourceArn?: Arn;
|
|
2336
|
+
/**
|
|
2337
|
+
* The status of the monitor. States include: ACTIVE ACTIVE_STOPPING, ACTIVE_STOPPED UPDATE_IN_PROGRESS CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
|
|
2338
|
+
*/
|
|
2339
|
+
Status?: Status;
|
|
2340
|
+
/**
|
|
2341
|
+
* When the monitor resource was created.
|
|
2342
|
+
*/
|
|
2343
|
+
CreationTime?: Timestamp;
|
|
2344
|
+
/**
|
|
2345
|
+
* The last time the monitor resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. STOPPED - When the resource stopped. ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.
|
|
2346
|
+
*/
|
|
2347
|
+
LastModificationTime?: Timestamp;
|
|
2348
|
+
}
|
|
2349
|
+
export type Monitors = MonitorSummary[];
|
|
2350
|
+
export type Month = "JANUARY"|"FEBRUARY"|"MARCH"|"APRIL"|"MAY"|"JUNE"|"JULY"|"AUGUST"|"SEPTEMBER"|"OCTOBER"|"NOVEMBER"|"DECEMBER"|string;
|
|
2065
2351
|
export type Name = string;
|
|
2066
2352
|
export type NextToken = string;
|
|
2067
2353
|
export type OptimizationMetric = "WAPE"|"RMSE"|"AverageWeightedQuantileLoss"|"MASE"|"MAPE"|string;
|
|
@@ -2109,7 +2395,23 @@ declare namespace ForecastService {
|
|
|
2109
2395
|
LastModificationTime?: Timestamp;
|
|
2110
2396
|
}
|
|
2111
2397
|
export type PredictorBacktestExportJobs = PredictorBacktestExportJobSummary[];
|
|
2398
|
+
export interface PredictorBaseline {
|
|
2399
|
+
/**
|
|
2400
|
+
* The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.
|
|
2401
|
+
*/
|
|
2402
|
+
BaselineMetrics?: BaselineMetrics;
|
|
2403
|
+
}
|
|
2112
2404
|
export type PredictorEvaluationResults = EvaluationResult[];
|
|
2405
|
+
export interface PredictorEvent {
|
|
2406
|
+
/**
|
|
2407
|
+
* The type of event. For example, Retrain. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the Datetime are from the previous predictor. Any new metrics are for the newly retrained predictor.
|
|
2408
|
+
*/
|
|
2409
|
+
Detail?: Detail;
|
|
2410
|
+
/**
|
|
2411
|
+
* The timestamp for when the event occurred.
|
|
2412
|
+
*/
|
|
2413
|
+
Datetime?: Timestamp;
|
|
2414
|
+
}
|
|
2113
2415
|
export interface PredictorExecution {
|
|
2114
2416
|
/**
|
|
2115
2417
|
* The ARN of the algorithm used to test the predictor.
|
|
@@ -2127,6 +2429,53 @@ declare namespace ForecastService {
|
|
|
2127
2429
|
PredictorExecutions?: PredictorExecutions;
|
|
2128
2430
|
}
|
|
2129
2431
|
export type PredictorExecutions = PredictorExecution[];
|
|
2432
|
+
export interface PredictorMonitorEvaluation {
|
|
2433
|
+
/**
|
|
2434
|
+
* The Amazon Resource Name (ARN) of the resource to monitor.
|
|
2435
|
+
*/
|
|
2436
|
+
ResourceArn?: Arn;
|
|
2437
|
+
/**
|
|
2438
|
+
* The Amazon Resource Name (ARN) of the monitor resource.
|
|
2439
|
+
*/
|
|
2440
|
+
MonitorArn?: Arn;
|
|
2441
|
+
/**
|
|
2442
|
+
* The timestamp that indicates when the monitor evaluation was started.
|
|
2443
|
+
*/
|
|
2444
|
+
EvaluationTime?: Timestamp;
|
|
2445
|
+
/**
|
|
2446
|
+
* The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
|
|
2447
|
+
*/
|
|
2448
|
+
EvaluationState?: EvaluationState;
|
|
2449
|
+
/**
|
|
2450
|
+
* The timestamp that indicates the start of the window that is used for monitor evaluation.
|
|
2451
|
+
*/
|
|
2452
|
+
WindowStartDatetime?: Timestamp;
|
|
2453
|
+
/**
|
|
2454
|
+
* The timestamp that indicates the end of the window that is used for monitor evaluation.
|
|
2455
|
+
*/
|
|
2456
|
+
WindowEndDatetime?: Timestamp;
|
|
2457
|
+
/**
|
|
2458
|
+
* Provides details about a predictor event, such as a retraining.
|
|
2459
|
+
*/
|
|
2460
|
+
PredictorEvent?: PredictorEvent;
|
|
2461
|
+
/**
|
|
2462
|
+
* The source of the data the monitor resource used during the evaluation.
|
|
2463
|
+
*/
|
|
2464
|
+
MonitorDataSource?: MonitorDataSource;
|
|
2465
|
+
/**
|
|
2466
|
+
* A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.
|
|
2467
|
+
*/
|
|
2468
|
+
MetricResults?: MetricResults;
|
|
2469
|
+
/**
|
|
2470
|
+
* The number of items considered during the evaluation.
|
|
2471
|
+
*/
|
|
2472
|
+
NumItemsEvaluated?: Long;
|
|
2473
|
+
/**
|
|
2474
|
+
* Information about any errors that may have occurred during the monitor evaluation.
|
|
2475
|
+
*/
|
|
2476
|
+
Message?: Message;
|
|
2477
|
+
}
|
|
2478
|
+
export type PredictorMonitorEvaluations = PredictorMonitorEvaluation[];
|
|
2130
2479
|
export interface PredictorSummary {
|
|
2131
2480
|
/**
|
|
2132
2481
|
* The ARN of the predictor.
|
|
@@ -2176,6 +2525,12 @@ declare namespace ForecastService {
|
|
|
2176
2525
|
*/
|
|
2177
2526
|
State?: State;
|
|
2178
2527
|
}
|
|
2528
|
+
export interface ResumeResourceRequest {
|
|
2529
|
+
/**
|
|
2530
|
+
* The Amazon Resource Name (ARN) of the monitor resource to resume.
|
|
2531
|
+
*/
|
|
2532
|
+
ResourceArn: Arn;
|
|
2533
|
+
}
|
|
2179
2534
|
export interface S3Config {
|
|
2180
2535
|
/**
|
|
2181
2536
|
* The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
|
|
@@ -2204,7 +2559,7 @@ declare namespace ForecastService {
|
|
|
2204
2559
|
*/
|
|
2205
2560
|
AttributeName?: Name;
|
|
2206
2561
|
/**
|
|
2207
|
-
* The data type of the field.
|
|
2562
|
+
* The data type of the field. For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
|
|
2208
2563
|
*/
|
|
2209
2564
|
AttributeType?: AttributeType;
|
|
2210
2565
|
}
|
|
@@ -2325,6 +2680,24 @@ declare namespace ForecastService {
|
|
|
2325
2680
|
Message?: ErrorMessage;
|
|
2326
2681
|
}
|
|
2327
2682
|
export type TestWindows = WindowSummary[];
|
|
2683
|
+
export interface TimeAlignmentBoundary {
|
|
2684
|
+
/**
|
|
2685
|
+
* The month to use for time alignment during aggregation. The month must be in uppercase.
|
|
2686
|
+
*/
|
|
2687
|
+
Month?: Month;
|
|
2688
|
+
/**
|
|
2689
|
+
* The day of the month to use for time alignment during aggregation.
|
|
2690
|
+
*/
|
|
2691
|
+
DayOfMonth?: DayOfMonth;
|
|
2692
|
+
/**
|
|
2693
|
+
* The day of week to use for time alignment during aggregation. The day must be in uppercase.
|
|
2694
|
+
*/
|
|
2695
|
+
DayOfWeek?: DayOfWeek;
|
|
2696
|
+
/**
|
|
2697
|
+
* The hour of day to use for time alignment during aggregation.
|
|
2698
|
+
*/
|
|
2699
|
+
Hour?: Hour;
|
|
2700
|
+
}
|
|
2328
2701
|
export type TimePointGranularity = "ALL"|"SPECIFIC"|string;
|
|
2329
2702
|
export type TimeSeriesGranularity = "ALL"|"SPECIFIC"|string;
|
|
2330
2703
|
export type TimeZone = string;
|