From 0704aa9ccf828a0a132c4d6355b60c70d7159217 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Mon, 23 May 2022 18:06:17 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/elasticache.json | 24 +- codegen/sdk-codegen/aws-models/forecast.json | 891 ++++++++++++++++-- .../sdk-codegen/aws-models/personalize.json | 21 +- 3 files changed, 863 insertions(+), 73 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/elasticache.json b/codegen/sdk-codegen/aws-models/elasticache.json index 0d34cdf7178..fee4e6ef348 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.json +++ b/codegen/sdk-codegen/aws-models/elasticache.json @@ -727,7 +727,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -1083,7 +1083,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "com.amazonaws.elasticache#CacheNodeIdsList": { @@ -2081,7 +2081,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -2203,6 +2203,12 @@ "traits": { "smithy.api#documentation": "

Specifies the destination, format and type of the logs.

" } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.\n \n You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

\n \n

\n Required:\n Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

" + } } }, "traits": { @@ -2639,7 +2645,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -4571,7 +4577,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -4650,7 +4656,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -8724,7 +8730,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "StartTime": { @@ -8884,7 +8890,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -9454,7 +9460,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { diff --git a/codegen/sdk-codegen/aws-models/forecast.json b/codegen/sdk-codegen/aws-models/forecast.json index 50182d1a4b6..249ea0abbeb 100644 --- a/codegen/sdk-codegen/aws-models/forecast.json +++ b/codegen/sdk-codegen/aws-models/forecast.json @@ -42,12 +42,12 @@ "Configuration": { "target": "com.amazonaws.forecast#Configuration", "traits": { - "smithy.api#documentation": "

\n Weather Index\n

\n

To enable the Weather Index, do not specify a value for\n Configuration.

\n

\n Holidays\n

\n

To enable Holidays, set CountryCode to one of the following two-letter country\n codes:

\n " + "smithy.api#documentation": "

\n Weather Index\n

\n

To enable the Weather Index, do not specify a value for\n Configuration.

\n

\n Holidays\n

\n\n

\n Holidays\n

\n

To enable Holidays, set CountryCode to one of the following two-letter\n country codes:

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and\n projected weather information into your model. The Weather Index supplements your\n datasets with over two years of historical weather data and up to 14 days of projected\n weather data. For more information, see Amazon Forecast\n Weather Index.

\n

\n Holidays\n

\n

Holidays is a built-in dataset that incorporates national holiday information into\n your model. It provides native support for the holiday calendars of 66 countries. To\n view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays\n Featurization.

" + "smithy.api#documentation": "

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and\n projected weather information into your model. The Weather Index supplements your\n datasets with over two years of historical weather data and up to 14 days of projected\n weather data. For more information, see Amazon Forecast\n Weather Index.

\n

\n Holidays\n

\n

Holidays is a built-in dataset that incorporates national holiday information into\n your model. It provides native support for the holiday calendars of 66 countries. To\n view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays\n Featurization.

" } }, "com.amazonaws.forecast#AdditionalDatasets": { @@ -105,6 +105,9 @@ { "target": "com.amazonaws.forecast#CreateForecastExportJob" }, + { + "target": "com.amazonaws.forecast#CreateMonitor" + }, { "target": "com.amazonaws.forecast#CreatePredictor" }, @@ -132,6 +135,9 @@ { "target": "com.amazonaws.forecast#DeleteForecastExportJob" }, + { + "target": "com.amazonaws.forecast#DeleteMonitor" + }, { "target": "com.amazonaws.forecast#DeletePredictor" }, @@ -165,6 +171,9 @@ { "target": "com.amazonaws.forecast#DescribeForecastExportJob" }, + { + "target": "com.amazonaws.forecast#DescribeMonitor" + }, { "target": "com.amazonaws.forecast#DescribePredictor" }, @@ -195,6 +204,12 @@ { "target": "com.amazonaws.forecast#ListForecasts" }, + { + "target": "com.amazonaws.forecast#ListMonitorEvaluations" + }, + { + "target": "com.amazonaws.forecast#ListMonitors" + }, { "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobs" }, @@ -204,6 +219,9 @@ { "target": "com.amazonaws.forecast#ListTagsForResource" }, + { + "target": "com.amazonaws.forecast#ResumeResource" + }, { "target": "com.amazonaws.forecast#StopResource" }, @@ -253,7 +271,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the method used to transform attributes.

\n

The following is an example using the RETAIL domain:

\n

\n {\n

\n

\n \"AttributeName\": \"demand\",\n

\n

\n \"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\":\n \"zero\"}\n

\n

\n }\n

" + "smithy.api#documentation": "

Provides information about the method used to transform attributes.

\n

The following is an example using the RETAIL domain:

\n

\n {\n

\n

\n \"AttributeName\": \"demand\",\n

\n

\n \"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\":\n \"zero\"}\n

\n

\n }\n

" } }, "com.amazonaws.forecast#AttributeConfigs": { @@ -310,6 +328,46 @@ ] } }, + "com.amazonaws.forecast#Baseline": { + "type": "structure", + "members": { + "PredictorBaseline": { + "target": "com.amazonaws.forecast#PredictorBaseline", + "traits": { + "smithy.api#documentation": "

The initial accuracy metrics for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you\n use your predictor and the metrics change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

" + } + }, + "com.amazonaws.forecast#BaselineMetric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Value": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "

The value for the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An individual metric that you can use for comparison as you evaluate your monitoring results.

" + } + }, + "com.amazonaws.forecast#BaselineMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#BaselineMetric" + } + }, "com.amazonaws.forecast#Boolean": { "type": "boolean", "traits": { @@ -432,7 +490,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Forecast predictor.

\n

Amazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.

\n

\n Creating new predictors\n

\n

The following parameters are required when creating a new predictor:

\n \n

When creating a new predictor, do not specify a value for\n ReferencePredictorArn.

\n

\n Upgrading and retraining predictors\n

\n

The following parameters are required when retraining or upgrading a predictor:

\n \n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.

" + "smithy.api#documentation": "

Creates an Amazon Forecast predictor.

\n

Amazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain\n existing predictors.

\n\n

\n Creating new predictors\n

\n\n

The following parameters are required when creating a new predictor:

\n \n

When creating a new predictor, do not specify a value for\n ReferencePredictorArn.

\n

\n Upgrading and retraining predictors\n

\n

The following parameters are required when retraining or upgrading a predictor:

\n \n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.

" } }, "com.amazonaws.forecast#CreateAutoPredictorRequest": { @@ -448,7 +506,7 @@ "ForecastHorizon": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.

" + "smithy.api#documentation": "

The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.

\n

The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the\n TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then\n the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the\n TARGET_TIME_SERIES dataset length.

\n

If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you\n cannot update the forecast horizon parameter. You can meet this requirement by providing\n longer time-series in the dataset.

" } }, "ForecastTypes": { @@ -501,6 +559,12 @@ "traits": { "smithy.api#documentation": "

Optional metadata to help you categorize and organize your predictors. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n " } + }, + "MonitorConfig": { + "target": "com.amazonaws.forecast#MonitorConfig", + "traits": { + "smithy.api#documentation": "

The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.

\n

Predictor monitoring allows you to see how your predictor's performance changes over time.\n For more information, see Predictor Monitoring.

" + } } } }, @@ -535,7 +599,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps\n Forecast understand how to consume the data for model training. This includes the\n following:

\n \n

After creating a dataset, you import your training data into it and add the dataset to a\n dataset group. You use the dataset group to create a predictor. For more information, see\n howitworks-datasets-groups.

\n

To get a list of all your datasets, use the ListDatasets\n operation.

\n

For example Forecast datasets, see the Amazon Forecast Sample GitHub\n repository.

\n \n

The Status of a dataset must be ACTIVE before you can import\n training data. Use the DescribeDataset operation to get the status.

\n " + "smithy.api#documentation": "

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps\n Forecast understand how to consume the data for model training. This includes the\n following:

\n \n

After creating a dataset, you import your training data into it and add the dataset to a\n dataset group. You use the dataset group to create a predictor. For more information, see\n Importing datasets.

\n

To get a list of all your datasets, use the ListDatasets operation.

\n

For example Forecast datasets, see the Amazon Forecast Sample GitHub\n repository.

\n \n

The Status of a dataset must be ACTIVE before you can import\n training data. Use the DescribeDataset operation to get\n the status.

\n " } }, "com.amazonaws.forecast#CreateDatasetGroup": { @@ -564,7 +628,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

\n

After creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see howitworks-datasets-groups.

\n

To get a list of all your datasets groups, use the ListDatasetGroups\n operation.

\n \n

The Status of a dataset group must be ACTIVE before you can\n use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

\n " + "smithy.api#documentation": "

Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

\n

After creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see Dataset groups.

\n

To get a list of all your datasets groups, use the ListDatasetGroups\n operation.

\n \n

The Status of a dataset group must be ACTIVE before you can\n use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

\n " } }, "com.amazonaws.forecast#CreateDatasetGroupRequest": { @@ -580,7 +644,7 @@ "Domain": { "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "

The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain parameter of the CreateDataset operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires that item_id,\n timestamp, and demand fields are present in your data. For more\n information, see howitworks-datasets-groups.

", + "smithy.api#documentation": "

The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain parameter of the CreateDataset\n operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires that item_id,\n timestamp, and demand fields are present in your data. For more\n information, see Dataset groups.

", "smithy.api#required": {} } }, @@ -635,7 +699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.

\n

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM)\n role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and\n processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

\n

The training data must be in CSV format. The delimiter must be a comma (,).

\n

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.

\n\n\n

Because dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.

\n\n\n

To get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.

" + "smithy.api#documentation": "

Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.

\n

You must specify a DataSource object that includes an\n AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy\n of your data and processes it in an internal AWS system. For more information, see Set up\n permissions.

\n

The training data must be in CSV format. The delimiter must be a comma (,).

\n

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.

\n\n\n

Because dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.

\n\n\n

To get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.

" } }, "com.amazonaws.forecast#CreateDatasetImportJobRequest": { @@ -658,7 +722,7 @@ "DataSource": { "target": "com.amazonaws.forecast#DataSource", "traits": { - "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig parameter of the CreateDataset operation.

", + "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig parameter of the CreateDataset\n operation.

", "smithy.api#required": {} } }, @@ -718,7 +782,7 @@ "Domain": { "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "

The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires item_id, timestamp,\n and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

", + "smithy.api#documentation": "

The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires item_id, timestamp,\n and demand fields to be present in your data. For more information, see Importing\n datasets.

", "smithy.api#required": {} } }, @@ -738,7 +802,7 @@ "Schema": { "target": "com.amazonaws.forecast#Schema", "traits": { - "smithy.api#documentation": "

The schema for the dataset. The schema attributes and their order must match the fields in\n your data. The dataset Domain and DatasetType that you choose\n determine the minimum required fields in your training data. For information about the\n required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

", + "smithy.api#documentation": "

The schema for the dataset. The schema attributes and their order must match the fields in\n your data. The dataset Domain and DatasetType that you choose\n determine the minimum required fields in your training data. For information about the\n required fields for a specific dataset domain and type, see Dataset Domains and Dataset\n Types.

", "smithy.api#required": {} } }, @@ -793,7 +857,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)

\n \n

Creates an Amazon Forecast Explainability.

\n

Explainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.

\n

To enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.

\n

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.

\n

\n CreateExplainability with a Predictor ARN\n

\n \n

You can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

Do not specify a value for the following parameters:

\n \n

\n CreateExplainability with a Forecast ARN\n

\n \n

You can specify a maximum of 50 time series and 500 time points.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:

\n \n

If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:

\n " + "smithy.api#documentation": "\n

Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)

\n \n

Creates an Amazon Forecast Explainability.

\n

Explainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.

\n

To enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.

\n

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.

\n

\n CreateExplainability with a Predictor ARN\n

\n \n

You can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

Do not specify a value for the following parameters:

\n \n

\n CreateExplainability with a Forecast ARN\n

\n \n

You can specify a maximum of 50 time series and 500 time points.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:

\n \n

If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:

\n " } }, "com.amazonaws.forecast#CreateExplainabilityExport": { @@ -900,19 +964,19 @@ "EnableVisualization": { "target": "com.amazonaws.forecast#Boolean", "traits": { - "smithy.api#documentation": "

Create an Expainability visualization that is viewable within the AWS console.

" + "smithy.api#documentation": "

Create an Explainability visualization that is viewable within the AWS console.

" } }, "StartDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:\n 2015-01-01T20:00:00)

" } }, "EndDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:\n 2015-01-01T20:00:00)

" } }, "Tags": { @@ -1055,7 +1119,7 @@ "ForecastTypes": { "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" + "smithy.api#documentation": "

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial).\n

\n

The default quantiles are the quantiles you specified during predictor creation.\n If you didn't specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"].\n

" } }, "Tags": { @@ -1077,6 +1141,71 @@ } } }, + "com.amazonaws.forecast#CreateMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#CreateMonitorRequest" + }, + "output": { + "target": "com.amazonaws.forecast#CreateMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time.\n For more information, see Predictor Monitoring.\n

" + } + }, + "com.amazonaws.forecast#CreateMonitorRequest": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the monitor resource.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor to monitor.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the monitor resource.

" + } + } + } + }, + "com.amazonaws.forecast#CreateMonitorResponse": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource.

" + } + } + } + }, "com.amazonaws.forecast#CreatePredictor": { "type": "operation", "input": { @@ -1368,12 +1497,12 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the ListDatasetGroups\n call.

" + "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the ListDatasetGroups\n call.

" } } }, "traits": { - "smithy.api#documentation": "

Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the\n DescribeDatasetGroup operation, and provide the\n DatasetGroupArn.

" + "smithy.api#documentation": "

Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To\n get the complete set of properties, call the DescribeDatasetGroup\n operation, and provide the DatasetGroupArn.

" } }, "com.amazonaws.forecast#DatasetGroups": { @@ -1429,7 +1558,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the\n DescribeDatasetImportJob operation, and provide the\n DatasetImportJobArn.

" + "smithy.api#documentation": "

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the\n DescribeDatasetImportJob operation, and provide the\n DatasetImportJobArn.

" } }, "com.amazonaws.forecast#DatasetImportJobs": { @@ -1474,12 +1603,12 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the ListDatasets call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" + "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the ListDatasets call.\n After a CreateDatasetImportJob operation has finished, LastModificationTime is\n when the import job completed or failed.

" } } }, "traits": { - "smithy.api#documentation": "

Provides a summary of the dataset properties used in the ListDatasets\n operation. To get the complete set of properties, call the DescribeDataset\n operation, and provide the DatasetArn.

" + "smithy.api#documentation": "

Provides a summary of the dataset properties used in the ListDatasets operation. To get the\n complete set of properties, call the DescribeDataset operation, and\n provide the DatasetArn.

" } }, "com.amazonaws.forecast#DatasetType": { @@ -1512,6 +1641,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteDatasetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1524,7 +1656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Forecast dataset that was created using the CreateDataset\n operation. You can only delete datasets that have a status of ACTIVE or\n CREATE_FAILED. To get the status use the DescribeDataset\n operation.

\n \n

Forecast does not automatically update any dataset groups that contain the deleted dataset.\n In order to update the dataset group, use the \n operation, omitting the deleted dataset's ARN.

\n ", + "smithy.api#documentation": "

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can\n only delete datasets that have a status of ACTIVE or CREATE_FAILED.\n To get the status use the DescribeDataset operation.

\n \n

Forecast does not automatically update any dataset groups that contain the deleted dataset.\n In order to update the dataset group, use the UpdateDatasetGroup operation,\n omitting the deleted dataset's ARN.

\n ", "smithy.api#idempotent": {} } }, @@ -1533,6 +1665,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteDatasetGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1545,7 +1680,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dataset group created using the CreateDatasetGroup operation.\n You can only delete dataset groups that have a status of ACTIVE,\n CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

\n

This operation deletes only the dataset group, not the datasets in the group.

", + "smithy.api#documentation": "

Deletes a dataset group created using the CreateDatasetGroup operation.\n You can only delete dataset groups that have a status of ACTIVE,\n CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

\n

This operation deletes only the dataset group, not the datasets in the group.

", "smithy.api#idempotent": {} } }, @@ -1566,6 +1701,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteDatasetImportJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1578,7 +1716,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dataset import job created using the CreateDatasetImportJob\n operation. You can delete only dataset import jobs that have a status of ACTIVE\n or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

", + "smithy.api#documentation": "

Deletes a dataset import job created using the CreateDatasetImportJob\n operation. You can delete only dataset import jobs that have a status of ACTIVE\n or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob\n operation.

", "smithy.api#idempotent": {} } }, @@ -1611,6 +1749,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteExplainabilityRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1632,6 +1773,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteExplainabilityExportRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1677,6 +1821,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteForecastRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1698,6 +1845,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteForecastExportJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1738,11 +1888,50 @@ } } }, + "com.amazonaws.forecast#DeleteMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DeleteMonitorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DeleteMonitorRequest": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource to delete.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.forecast#DeletePredictor": { "type": "operation", "input": { "target": "com.amazonaws.forecast#DeletePredictorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1764,6 +1953,9 @@ "input": { "target": "com.amazonaws.forecast#DeletePredictorBacktestExportJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1809,6 +2001,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteResourceTreeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1906,7 +2101,7 @@ "ForecastDimensions": { "target": "com.amazonaws.forecast#ForecastDimensions", "traits": { - "smithy.api#documentation": "

An array of dimension (field) names that specify the attributes used to group your time series.

" + "smithy.api#documentation": "

An array of dimension (field) names that specify the attributes used to group your\n time series.

" } }, "DatasetImportJobArns": { @@ -1939,7 +2134,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the predictor. States include:

\n " + "smithy.api#documentation": "

The status of the predictor. States include:

\n " } }, "Message": { @@ -1971,6 +2166,12 @@ "traits": { "smithy.api#documentation": "

Provides the status and ARN of the Predictor Explainability.

" } + }, + "MonitorInfo": { + "target": "com.amazonaws.forecast#MonitorInfo", + "traits": { + "smithy.api#documentation": "

A object with the Amazon Resource Name (ARN) and status of the monitor resource.

" + } } } }, @@ -1991,7 +2192,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes an Amazon Forecast dataset created using the CreateDataset\n operation.

\n

In addition to listing the parameters specified in the CreateDataset request,\n this operation includes the following dataset properties:

\n ", + "smithy.api#documentation": "

Describes an Amazon Forecast dataset created using the CreateDataset operation.

\n

In addition to listing the parameters specified in the CreateDataset request,\n this operation includes the following dataset properties:

\n ", "smithy.api#idempotent": {} } }, @@ -2012,7 +2213,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a dataset group created using the CreateDatasetGroup\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetGroup\n request, this operation includes the following properties:

\n ", + "smithy.api#documentation": "

Describes a dataset group created using the CreateDatasetGroup\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetGroup\n request, this operation includes the following properties:

\n ", "smithy.api#idempotent": {} } }, @@ -2058,7 +2259,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the dataset group. States include:

\n \n

The UPDATE states apply when you call the UpdateDatasetGroup operation.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor.

\n " + "smithy.api#documentation": "

The status of the dataset group. States include:

\n \n

The UPDATE states apply when you call the UpdateDatasetGroup\n operation.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor.

\n " } }, "CreationTime": { @@ -2070,7 +2271,7 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the\n DescribeDatasetGroup call.

" + "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the\n DescribeDatasetGroup call.

" } } } @@ -2092,7 +2293,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a dataset import job created using the CreateDatasetImportJob\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetImportJob\n request, this operation includes the following properties:

\n ", + "smithy.api#documentation": "

Describes a dataset import job created using the CreateDatasetImportJob\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetImportJob\n request, this operation includes the following properties:

\n ", "smithy.api#idempotent": {} } }, @@ -2263,7 +2464,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the dataset. States include:

\n \n

The UPDATE states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset\n import job. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS.

\n \n

The Status of the dataset must be ACTIVE before you can import\n training data.

\n " + "smithy.api#documentation": "

The status of the dataset. States include:

\n \n

The UPDATE states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset import job.\n For example, when the import job status is CREATE_IN_PROGRESS, the status of the\n dataset is UPDATE_IN_PROGRESS.

\n \n

The Status of the dataset must be ACTIVE before you can import\n training data.

\n " } }, "CreationTime": { @@ -2275,7 +2476,7 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the DescribeDataset\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" + "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the DescribeDataset\n call. After a CreateDatasetImportJob\n operation has finished, LastModificationTime is when the import job completed or\n failed.

" } } } @@ -2367,7 +2568,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the Explainability export. States include:

\n " + "smithy.api#documentation": "

The status of the Explainability export. States include:

\n " } }, "CreationTime": { @@ -2462,7 +2663,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the Explainability resource. States include:

\n " + "smithy.api#documentation": "

The status of the Explainability resource. States include:

\n " } }, "CreationTime": { @@ -2663,6 +2864,110 @@ } } }, + "com.amazonaws.forecast#DescribeMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribeMonitorRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribeMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DescribeMonitorRequest": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource to describe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DescribeMonitorResponse": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the monitor.

" + } + }, + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource described.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the auto predictor being monitored.

" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the monitor resource.

" + } + }, + "LastEvaluationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the latest evaluation completed by the monitor.

" + } + }, + "LastEvaluationState": { + "target": "com.amazonaws.forecast#EvaluationState", + "traits": { + "smithy.api#documentation": "

The state of the monitor's latest evaluation.

" + } + }, + "Baseline": { + "target": "com.amazonaws.forecast#Baseline", + "traits": { + "smithy.api#documentation": "

Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

" + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

An error message, if any, for the monitor.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the monitor resource was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the latest modification to the monitor.

" + } + }, + "EstimatedEvaluationTimeRemainingInMinutes": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "

The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

" + } + } + } + }, "com.amazonaws.forecast#DescribePredictor": { "type": "operation", "input": { @@ -2928,6 +3233,15 @@ } } }, + "com.amazonaws.forecast#Detail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.forecast#Domain": { "type": "string", "traits": { @@ -3078,6 +3392,15 @@ "smithy.api#documentation": "

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

" } }, + "com.amazonaws.forecast#EvaluationState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.forecast#EvaluationType": { "type": "string", "traits": { @@ -3118,7 +3441,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ExplainabilityConfig data type defines the number of time series and time points\n included in CreateExplainability.

\n

If you provide a predictor ARN for ResourceArn, you must set both\n TimePointGranularity and TimeSeriesGranularity to “ALL”.\n When creating Predictor Explainability, Amazon Forecast considers all time series and\n time points.

\n

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and\n TimeSeriesGranularity to either “ALL” or “Specific”.

" + "smithy.api#documentation": "

The ExplainabilityConfig data type defines the number of time series and time points\n included in CreateExplainability.

\n

If you provide a predictor ARN for ResourceArn, you must set both\n TimePointGranularity and TimeSeriesGranularity to “ALL”.\n When creating Predictor Explainability, Amazon Forecast considers all time series and\n time points.

\n

If you provide a forecast ARN for ResourceArn, you can set\n TimePointGranularity and TimeSeriesGranularity to either\n “ALL” or “Specific”.

" } }, "com.amazonaws.forecast#ExplainabilityExportSummary": { @@ -3142,7 +3465,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the Explainability export. States include:

\n " + "smithy.api#documentation": "

The status of the Explainability export. States include:

\n " } }, "Message": { @@ -3186,7 +3509,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the Explainability. States include:

\n " + "smithy.api#documentation": "

The status of the Explainability. States include:

\n " } } }, @@ -3224,7 +3547,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the Explainability. States include:

\n " + "smithy.api#documentation": "

The status of the Explainability. States include:

\n " } }, "Message": { @@ -3822,7 +4145,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of dataset groups created using the CreateDatasetGroup\n operation. For each dataset group, this operation returns a summary of its properties,\n including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by\n using the dataset group ARN with the DescribeDatasetGroup operation.

", + "smithy.api#documentation": "

Returns a list of dataset groups created using the CreateDatasetGroup operation.\n For each dataset group, this operation returns a summary of its properties, including its\n Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n dataset group ARN with the DescribeDatasetGroup\n operation.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3883,7 +4206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the\n complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter\n objects.

", + "smithy.api#documentation": "

Returns a list of dataset import jobs created using the CreateDatasetImportJob\n operation. For each import job, this operation returns a summary of its properties, including\n its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n ARN with the DescribeDatasetImportJob\n operation. You can filter the list by providing an array of Filter objects.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3911,7 +4234,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "

An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:

\n

\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]\n

" + "smithy.api#documentation": "

An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:

\n

\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]\n

" } } } @@ -3947,7 +4270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of datasets created using the CreateDataset operation.\n For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is\n returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

", + "smithy.api#documentation": "

Returns a list of datasets created using the CreateDataset operation. For each\n dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned.\n To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4009,7 +4332,13 @@ ], "traits": { "smithy.api#documentation": "

Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for\n each Explainability. You can filter the list using an array of Filter\n objects.

\n

To retrieve the complete set of properties for a particular Explainability resource,\n use the ARN with the DescribeExplainability operation.

", - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Explainabilities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.forecast#ListExplainabilitiesRequest": { @@ -4070,12 +4399,18 @@ ], "traits": { "smithy.api#documentation": "

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary\n for each Explainability export. You can filter the list using an array of Filter objects.

\n

To retrieve the complete set of properties for a particular Explainability export, use\n the ARN with the DescribeExplainability operation.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.forecast#ListExplainabilityExportsRequest": { - "type": "structure", - "members": { + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExplainabilityExports", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.forecast#ListExplainabilityExportsRequest": { + "type": "structure", + "members": { "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { @@ -4247,6 +4582,150 @@ } } }, + "com.amazonaws.forecast#ListMonitorEvaluations": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListMonitorEvaluationsRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListMonitorEvaluationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the monitoring evaluation results and predictor events collected by\n the monitor resource during different windows of time.

\n

For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PredictorMonitorEvaluations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.forecast#ListMonitorEvaluationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of monitoring results to return.

" + } + }, + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource to get results from.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list only successful monitor evaluations, you would specify:

\n

\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"EvaluationState\", \"Value\": \"SUCCESS\" } ]\n

" + } + } + } + }, + "com.amazonaws.forecast#ListMonitorEvaluationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request. Tokens expire after 24 hours.

" + } + }, + "PredictorMonitorEvaluations": { + "target": "com.amazonaws.forecast#PredictorMonitorEvaluations", + "traits": { + "smithy.api#documentation": "

The monitoring results and predictor events collected by the monitor resource during different windows of time.

\n

For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.

" + } + } + } + }, + "com.amazonaws.forecast#ListMonitors": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListMonitorsRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListMonitorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

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\n can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Monitors", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.forecast#ListMonitorsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of monitors to include in the response.

" + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all monitors who's status is ACTIVE, you would specify:

\n

\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]\n

" + } + } + } + }, + "com.amazonaws.forecast#ListMonitorsResponse": { + "type": "structure", + "members": { + "Monitors": { + "target": "com.amazonaws.forecast#Monitors", + "traits": { + "smithy.api#documentation": "

An array of objects that summarize each monitor's properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" + } + } + } + }, "com.amazonaws.forecast#ListPredictorBacktestExportJobs": { "type": "operation", "input": { @@ -4453,6 +4932,41 @@ "com.amazonaws.forecast#Message": { "type": "string" }, + "com.amazonaws.forecast#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.forecast#MetricResult": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.forecast#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "MetricValue": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "

The value for the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.

\n

For more information about metrics generated by Forecast see Evaluating Predictor Accuracy\n

" + } + }, + "com.amazonaws.forecast#MetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#MetricResult" + } + }, "com.amazonaws.forecast#Metrics": { "type": "structure", "members": { @@ -4488,6 +5002,117 @@ "smithy.api#documentation": "

Provides metrics that are used to evaluate the performance of a predictor. This object is\n part of the WindowSummary object.

" } }, + "com.amazonaws.forecast#MonitorConfig": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the monitor resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details for the predictor monitor.

" + } + }, + "com.amazonaws.forecast#MonitorDataSource": { + "type": "structure", + "members": { + "DatasetImportJobArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.

" + } + }, + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.

" + } + }, + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor resource you are monitoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the data the monitor used during the evaluation.

" + } + }, + "com.amazonaws.forecast#MonitorInfo": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource.

" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the monitor. States include:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the monitor resource.

" + } + }, + "com.amazonaws.forecast#MonitorSummary": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource.

" + } + }, + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the monitor resource.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor being monitored.

" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the monitor. States include:

\n " + } + }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

When the monitor resource was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the monitor resource was modified. The timestamp depends on the status of the\n job:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties,\n call the DescribeMonitor operation, and provide the listed\n MonitorArn.

" + } + }, + "com.amazonaws.forecast#Monitors": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#MonitorSummary" + } + }, "com.amazonaws.forecast#Name": { "type": "string", "traits": { @@ -4634,12 +5259,46 @@ "target": "com.amazonaws.forecast#PredictorBacktestExportJobSummary" } }, + "com.amazonaws.forecast#PredictorBaseline": { + "type": "structure", + "members": { + "BaselineMetrics": { + "target": "com.amazonaws.forecast#BaselineMetrics", + "traits": { + "smithy.api#documentation": "

The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you\n use your predictor and the metrics change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

" + } + }, "com.amazonaws.forecast#PredictorEvaluationResults": { "type": "list", "member": { "target": "com.amazonaws.forecast#EvaluationResult" } }, + "com.amazonaws.forecast#PredictorEvent": { + "type": "structure", + "members": { + "Detail": { + "target": "com.amazonaws.forecast#Detail", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "Datetime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the event occurred.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a predictor event, such as a retraining.

" + } + }, "com.amazonaws.forecast#PredictorExecution": { "type": "structure", "members": { @@ -4686,6 +5345,80 @@ } } }, + "com.amazonaws.forecast#PredictorMonitorEvaluation": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn" + }, + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn" + }, + "EvaluationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the monitor evaluation was started.

" + } + }, + "EvaluationState": { + "target": "com.amazonaws.forecast#EvaluationState", + "traits": { + "smithy.api#documentation": "

The status of the monitor evaluation. The state can be SUCCESS or FAILURE.

" + } + }, + "WindowStartDatetime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates the start of the window that is used for monitor evaluation.

" + } + }, + "WindowEndDatetime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates the end of the window that is used for monitor evaluation.

" + } + }, + "PredictorEvent": { + "target": "com.amazonaws.forecast#PredictorEvent", + "traits": { + "smithy.api#documentation": "

Provides details about a predictor event, such as a retraining.

" + } + }, + "MonitorDataSource": { + "target": "com.amazonaws.forecast#MonitorDataSource", + "traits": { + "smithy.api#documentation": "

The source of the data the monitor resource used during the evaluation.

" + } + }, + "MetricResults": { + "target": "com.amazonaws.forecast#MetricResults", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "NumItemsEvaluated": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "

The number of items considered during the evaluation.

" + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

Information about any errors that may have occurred during the monitor evaluation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the results of a monitor evaluation.

" + } + }, + "com.amazonaws.forecast#PredictorMonitorEvaluations": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#PredictorMonitorEvaluation" + } + }, "com.amazonaws.forecast#PredictorSummary": { "type": "structure", "members": { @@ -4813,6 +5546,45 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.forecast#ResumeResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ResumeResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Resumes a stopped monitor resource.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#ResumeResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the monitor resource to resume.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.forecast#S3Config": { "type": "structure", "members": { @@ -4900,12 +5672,12 @@ "AttributeType": { "target": "com.amazonaws.forecast#AttributeType", "traits": { - "smithy.api#documentation": "

The data type of the field.

" + "smithy.api#documentation": "

The data type of the field.

\n

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

" } } }, "traits": { - "smithy.api#documentation": "

An attribute of a schema, which defines a dataset field. A schema attribute is required\n for every field in a dataset. The Schema object contains an array of\n SchemaAttribute objects.

" + "smithy.api#documentation": "

An attribute of a schema, which defines a dataset field. A schema attribute is required\n for every field in a dataset. The Schema object contains an array of\n SchemaAttribute objects.

" } }, "com.amazonaws.forecast#SchemaAttributes": { @@ -4947,19 +5719,19 @@ "CountDistinct": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of distinct values in the field. If the response value is -1, refer to\n CountDistinctLong.

" + "smithy.api#documentation": "

The number of distinct values in the field. If the response value is -1, refer to\n CountDistinctLong.

" } }, "CountNull": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of null values in the field. If the response value is -1, refer to\n CountNullLong.

" + "smithy.api#documentation": "

The number of null values in the field. If the response value is -1, refer to\n CountNullLong.

" } }, "CountNan": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of NAN (not a number) values in the field. If the response value is -1, refer to\n CountNanLong.

" + "smithy.api#documentation": "

The number of NAN (not a number) values in the field. If the response value is -1, refer\n to CountNanLong.

" } }, "Min": { @@ -5012,7 +5784,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides statistics for each data field imported into to an Amazon Forecast dataset with\n the CreateDatasetImportJob operation.

" + "smithy.api#documentation": "

Provides statistics for each data field imported into to an Amazon Forecast dataset with\n the CreateDatasetImportJob operation.

" } }, "com.amazonaws.forecast#Status": { @@ -5029,6 +5801,9 @@ "input": { "target": "com.amazonaws.forecast#StopResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -5405,7 +6180,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replaces the datasets in a dataset group with the specified datasets.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor. Use the DescribeDatasetGroup\n operation to get the status.

\n ", + "smithy.api#documentation": "

Replaces the datasets in a dataset group with the specified datasets.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor. Use the DescribeDatasetGroup\n operation to get the status.

\n ", "smithy.api#idempotent": {} } }, diff --git a/codegen/sdk-codegen/aws-models/personalize.json b/codegen/sdk-codegen/aws-models/personalize.json index d83c69b6779..7e2e23f7cc6 100644 --- a/codegen/sdk-codegen/aws-models/personalize.json +++ b/codegen/sdk-codegen/aws-models/personalize.json @@ -1837,6 +1837,9 @@ { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" }, @@ -1845,7 +1848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n

\n \n

\n Minimum recommendation requests per second\n

\n \n

When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second\n (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by\n Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation.\n Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive\n your requests per hour and the price of your recommender usage.\n

\n

\n If your requests per second increases beyond\n minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minRecommendationRequestsPerSecond.\n There's a short time delay while the capacity is increased that might cause loss of\n requests.

\n

\n Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)\n or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.\n \n We recommend starting with the default minRecommendationRequestsPerSecond, track\n your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond\n as necessary.\n

\n \n

\n Status\n

\n

A recommender can be in one of the following states:

\n \n

To get the recommender status, call DescribeRecommender.

\n \n

Wait until the status of the recommender\n is ACTIVE before asking the recommender for recommendations.

\n \n

\n Related APIs\n

\n ", + "smithy.api#documentation": "

Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n

\n \n

\n Minimum recommendation requests per second\n

\n \n

When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second\n (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by\n Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation.\n Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive\n your requests per hour and the price of your recommender usage.\n

\n

\n If your requests per second increases beyond\n minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minRecommendationRequestsPerSecond.\n There's a short time delay while the capacity is increased that might cause loss of\n requests.

\n

\n Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)\n or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.\n \n We recommend starting with the default minRecommendationRequestsPerSecond, track\n your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond\n as necessary.\n

\n \n

\n Status\n

\n

A recommender can be in one of the following states:

\n \n

To get the recommender status, call DescribeRecommender.

\n \n

Wait until the status of the recommender\n is ACTIVE before asking the recommender for recommendations.

\n \n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, @@ -3704,7 +3707,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the given recommender, including its status.

\n

A recommender can be in one of the following states:

\n \n

When the status is CREATE FAILED, the response includes the\n failureReason key, which describes why.

\n

For more information on recommenders, see CreateRecommender.

", + "smithy.api#documentation": "

Describes the given recommender, including its status.

\n

A recommender can be in one of the following states:

\n \n

When the status is CREATE FAILED, the response includes the\n failureReason key, which describes why.

\n

The modelMetrics key is null when\n the recommender is being created or deleted.

\n

For more information on recommenders, see CreateRecommender.

", "smithy.api#idempotent": {} } }, @@ -4269,7 +4272,7 @@ "metrics": { "target": "com.amazonaws.personalize#Metrics", "traits": { - "smithy.api#documentation": "

The metrics for the solution version.

" + "smithy.api#documentation": "

The metrics for the solution version. For more information, see\n \n Evaluating a solution version with metrics\n .

" } } } @@ -5835,7 +5838,7 @@ "status": { "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The status of the recommender.

\n

A recommender can be in one of the following states:

\n " + "smithy.api#documentation": "

The status of the recommender.

\n

A recommender can be in one of the following states:

\n " } }, "failureReason": { @@ -5849,6 +5852,12 @@ "traits": { "smithy.api#documentation": "

Provides a summary of the latest updates to the recommender.

" } + }, + "modelMetrics": { + "target": "com.amazonaws.personalize#Metrics", + "traits": { + "smithy.api#documentation": "

Provides evaluation metrics that help you determine the performance\n of a recommender. For more information, see\n \n Evaluating a recommender.

" + } } }, "traits": { @@ -5911,7 +5920,7 @@ "status": { "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The status of the recommender. A recommender can be in one of the following states:

\n " + "smithy.api#documentation": "

The status of the recommender. A recommender can be in one of the following states:

\n " } }, "creationDateTime": { @@ -5955,7 +5964,7 @@ "status": { "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The status of the recommender update.

\n

A recommender can be in one of the following states:

\n " + "smithy.api#documentation": "

The status of the recommender update.

\n

A recommender can be in one of the following states:

\n " } }, "failureReason": {