5.0.0 • Published 5 years ago

@datafire/amazonaws_forecast v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_forecast

Client library for Amazon Forecast Service

Installation and Usage

npm install --save @datafire/amazonaws_forecast
let amazonaws_forecast = require('@datafire/amazonaws_forecast').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Provides APIs for creating and managing Amazon Forecast resources.

Actions

CreateDataset

amazonaws_forecast.CreateDataset({
  "DatasetName": null,
  "Domain": null,
  "DatasetType": null,
  "Schema": null
}, context)

Input

  • input object
    • DataFrequency
    • DatasetName required
    • DatasetType required
    • Domain required
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • Schema required
    • Tags

Output

CreateDatasetGroup

amazonaws_forecast.CreateDatasetGroup({
  "DatasetGroupName": null,
  "Domain": null
}, context)

Input

  • input object
    • DatasetArns
    • DatasetGroupName required
    • Domain required
    • Tags

Output

CreateDatasetImportJob

amazonaws_forecast.CreateDatasetImportJob({
  "DatasetImportJobName": null,
  "DatasetArn": null,
  "DataSource": null
}, context)

Input

  • input object
    • DataSource required
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • DatasetArn required
    • DatasetImportJobName required
    • GeolocationFormat
    • Tags
    • TimeZone
    • TimestampFormat
    • UseGeolocationForTimeZone

Output

CreateForecast

amazonaws_forecast.CreateForecast({
  "ForecastName": null,
  "PredictorArn": null
}, context)

Input

  • input object
    • ForecastName required
    • ForecastTypes
    • PredictorArn required
    • Tags

Output

CreateForecastExportJob

amazonaws_forecast.CreateForecastExportJob({
  "ForecastExportJobName": null,
  "ForecastArn": null,
  "Destination": null
}, context)

Input

  • input object
    • Destination required
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • ForecastArn required
    • ForecastExportJobName required
    • Tags

Output

CreatePredictor

amazonaws_forecast.CreatePredictor({
  "PredictorName": null,
  "ForecastHorizon": null,
  "InputDataConfig": null,
  "FeaturizationConfig": null
}, context)

Input

  • input object
    • AlgorithmArn
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • EvaluationParameters
      • BackTestWindowOffset
      • NumberOfBacktestWindows
    • FeaturizationConfig required
      • Featurizations
      • ForecastDimensions
      • ForecastFrequency required
    • ForecastHorizon required
    • ForecastTypes
    • HPOConfig
    • InputDataConfig required
    • PerformAutoML
    • PerformHPO
    • PredictorName required
    • Tags
    • TrainingParameters

Output

CreatePredictorBacktestExportJob

amazonaws_forecast.CreatePredictorBacktestExportJob({
  "PredictorBacktestExportJobName": null,
  "PredictorArn": null,
  "Destination": {
    "S3Config": null
  }
}, context)

Input

  • input object
    • Destination required DataDestination
    • PredictorArn required
    • PredictorBacktestExportJobName required
    • Tags

Output

DeleteDataset

amazonaws_forecast.DeleteDataset({
  "DatasetArn": null
}, context)

Input

  • input object
    • DatasetArn required

Output

Output schema unknown

DeleteDatasetGroup

amazonaws_forecast.DeleteDatasetGroup({
  "DatasetGroupArn": null
}, context)

Input

  • input object
    • DatasetGroupArn required

Output

Output schema unknown

DeleteDatasetImportJob

amazonaws_forecast.DeleteDatasetImportJob({
  "DatasetImportJobArn": null
}, context)

Input

  • input object
    • DatasetImportJobArn required

Output

Output schema unknown

DeleteForecast

amazonaws_forecast.DeleteForecast({
  "ForecastArn": null
}, context)

Input

  • input object
    • ForecastArn required

Output

Output schema unknown

DeleteForecastExportJob

amazonaws_forecast.DeleteForecastExportJob({
  "ForecastExportJobArn": null
}, context)

Input

  • input object
    • ForecastExportJobArn required

Output

Output schema unknown

DeletePredictor

amazonaws_forecast.DeletePredictor({
  "PredictorArn": null
}, context)

Input

  • input object
    • PredictorArn required

Output

Output schema unknown

DeletePredictorBacktestExportJob

amazonaws_forecast.DeletePredictorBacktestExportJob({
  "PredictorBacktestExportJobArn": null
}, context)

Input

  • input object
    • PredictorBacktestExportJobArn required

Output

Output schema unknown

DescribeDataset

amazonaws_forecast.DescribeDataset({
  "DatasetArn": null
}, context)

Input

  • input object
    • DatasetArn required

Output

DescribeDatasetGroup

amazonaws_forecast.DescribeDatasetGroup({
  "DatasetGroupArn": null
}, context)

Input

  • input object
    • DatasetGroupArn required

Output

DescribeDatasetImportJob

amazonaws_forecast.DescribeDatasetImportJob({
  "DatasetImportJobArn": null
}, context)

Input

  • input object
    • DatasetImportJobArn required

Output

DescribeForecast

amazonaws_forecast.DescribeForecast({
  "ForecastArn": null
}, context)

Input

  • input object
    • ForecastArn required

Output

DescribeForecastExportJob

amazonaws_forecast.DescribeForecastExportJob({
  "ForecastExportJobArn": null
}, context)

Input

  • input object
    • ForecastExportJobArn required

Output

DescribePredictor

amazonaws_forecast.DescribePredictor({
  "PredictorArn": null
}, context)

Input

  • input object
    • PredictorArn required

Output

DescribePredictorBacktestExportJob

amazonaws_forecast.DescribePredictorBacktestExportJob({
  "PredictorBacktestExportJobArn": null
}, context)

Input

  • input object
    • PredictorBacktestExportJobArn required

Output

GetAccuracyMetrics

amazonaws_forecast.GetAccuracyMetrics({
  "PredictorArn": null
}, context)

Input

  • input object
    • PredictorArn required

Output

ListDatasetGroups

amazonaws_forecast.ListDatasetGroups({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListDatasetImportJobs

amazonaws_forecast.ListDatasetImportJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • MaxResults
    • NextToken

Output

ListDatasets

amazonaws_forecast.ListDatasets({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListForecastExportJobs

amazonaws_forecast.ListForecastExportJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • MaxResults
    • NextToken

Output

ListForecasts

amazonaws_forecast.ListForecasts({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • MaxResults
    • NextToken

Output

ListPredictorBacktestExportJobs

amazonaws_forecast.ListPredictorBacktestExportJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • MaxResults
    • NextToken

Output

ListPredictors

amazonaws_forecast.ListPredictors({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • MaxResults
    • NextToken

Output

ListTagsForResource

amazonaws_forecast.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

TagResource

amazonaws_forecast.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_forecast.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateDatasetGroup

amazonaws_forecast.UpdateDatasetGroup({
  "DatasetGroupArn": null,
  "DatasetArns": null
}, context)

Input

  • input object
    • DatasetArns required
    • DatasetGroupArn required

Output

Definitions

Arn

  • Arn string

ArnList

  • ArnList array

AttributeType

  • AttributeType string (values: string, integer, float, timestamp, geolocation)

Boolean

  • Boolean boolean

CategoricalParameterRange

  • CategoricalParameterRange object: Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
    • Name required
    • Values required

CategoricalParameterRanges

ContinuousParameterRange

  • ContinuousParameterRange object: Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
    • MaxValue required
    • MinValue required
    • Name required
    • ScalingType

ContinuousParameterRanges

CreateDatasetGroupRequest

  • CreateDatasetGroupRequest object
    • DatasetArns
    • DatasetGroupName required
    • Domain required
    • Tags

CreateDatasetGroupResponse

  • CreateDatasetGroupResponse object
    • DatasetGroupArn

CreateDatasetImportJobRequest

  • CreateDatasetImportJobRequest object
    • DataSource required
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • DatasetArn required
    • DatasetImportJobName required
    • GeolocationFormat
    • Tags
    • TimeZone
    • TimestampFormat
    • UseGeolocationForTimeZone

CreateDatasetImportJobResponse

  • CreateDatasetImportJobResponse object
    • DatasetImportJobArn

CreateDatasetRequest

  • CreateDatasetRequest object
    • DataFrequency
    • DatasetName required
    • DatasetType required
    • Domain required
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • Schema required
    • Tags

CreateDatasetResponse

  • CreateDatasetResponse object
    • DatasetArn

CreateForecastExportJobRequest

  • CreateForecastExportJobRequest object
    • Destination required
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • ForecastArn required
    • ForecastExportJobName required
    • Tags

CreateForecastExportJobResponse

  • CreateForecastExportJobResponse object
    • ForecastExportJobArn

CreateForecastRequest

  • CreateForecastRequest object
    • ForecastName required
    • ForecastTypes
    • PredictorArn required
    • Tags

CreateForecastResponse

  • CreateForecastResponse object
    • ForecastArn

CreatePredictorBacktestExportJobRequest

  • CreatePredictorBacktestExportJobRequest object
    • Destination required DataDestination
    • PredictorArn required
    • PredictorBacktestExportJobName required
    • Tags

CreatePredictorBacktestExportJobResponse

  • CreatePredictorBacktestExportJobResponse object
    • PredictorBacktestExportJobArn

CreatePredictorRequest

  • CreatePredictorRequest object
    • AlgorithmArn
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • EvaluationParameters
      • BackTestWindowOffset
      • NumberOfBacktestWindows
    • FeaturizationConfig required
      • Featurizations
      • ForecastDimensions
      • ForecastFrequency required
    • ForecastHorizon required
    • ForecastTypes
    • HPOConfig
    • InputDataConfig required
    • PerformAutoML
    • PerformHPO
    • PredictorName required
    • Tags
    • TrainingParameters

CreatePredictorResponse

  • CreatePredictorResponse object
    • PredictorArn

DataDestination

  • DataDestination object: The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
    • S3Config required
      • KMSKeyArn
      • Path required
      • RoleArn required

DataSource

  • DataSource object: The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob request.
    • S3Config required
      • KMSKeyArn
      • Path required
      • RoleArn required

DatasetGroupSummary

  • DatasetGroupSummary object: Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the DatasetGroupArn.
    • CreationTime
    • DatasetGroupArn
    • DatasetGroupName
    • LastModificationTime

DatasetGroups

DatasetImportJobSummary

  • DatasetImportJobSummary object: Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the DatasetImportJobArn.
    • CreationTime
    • DataSource
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • DatasetImportJobArn
    • DatasetImportJobName
    • LastModificationTime
    • Message
    • Status

DatasetImportJobs

DatasetSummary

  • DatasetSummary object: Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the DatasetArn.
    • CreationTime
    • DatasetArn
    • DatasetName
    • DatasetType
    • Domain
    • LastModificationTime

DatasetType

  • DatasetType string (values: TARGET_TIME_SERIES, RELATED_TIME_SERIES, ITEM_METADATA)

Datasets

DeleteDatasetGroupRequest

  • DeleteDatasetGroupRequest object
    • DatasetGroupArn required

DeleteDatasetImportJobRequest

  • DeleteDatasetImportJobRequest object
    • DatasetImportJobArn required

DeleteDatasetRequest

  • DeleteDatasetRequest object
    • DatasetArn required

DeleteForecastExportJobRequest

  • DeleteForecastExportJobRequest object
    • ForecastExportJobArn required

DeleteForecastRequest

  • DeleteForecastRequest object
    • ForecastArn required

DeletePredictorBacktestExportJobRequest

  • DeletePredictorBacktestExportJobRequest object
    • PredictorBacktestExportJobArn required

DeletePredictorRequest

  • DeletePredictorRequest object
    • PredictorArn required

DescribeDatasetGroupRequest

  • DescribeDatasetGroupRequest object
    • DatasetGroupArn required

DescribeDatasetGroupResponse

  • DescribeDatasetGroupResponse object
    • CreationTime
    • DatasetArns
    • DatasetGroupArn
    • DatasetGroupName
    • Domain
    • LastModificationTime
    • Status

DescribeDatasetImportJobRequest

  • DescribeDatasetImportJobRequest object
    • DatasetImportJobArn required

DescribeDatasetImportJobResponse

  • DescribeDatasetImportJobResponse object
    • CreationTime
    • DataSize
    • DataSource
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • DatasetArn
    • DatasetImportJobArn
    • DatasetImportJobName
    • FieldStatistics
    • GeolocationFormat
    • LastModificationTime
    • Message
    • Status
    • TimeZone
    • TimestampFormat
    • UseGeolocationForTimeZone

DescribeDatasetRequest

  • DescribeDatasetRequest object
    • DatasetArn required

DescribeDatasetResponse

  • DescribeDatasetResponse object
    • CreationTime
    • DataFrequency
    • DatasetArn
    • DatasetName
    • DatasetType
    • Domain
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • LastModificationTime
    • Schema
    • Status

DescribeForecastExportJobRequest

  • DescribeForecastExportJobRequest object
    • ForecastExportJobArn required

DescribeForecastExportJobResponse

  • DescribeForecastExportJobResponse object
    • CreationTime
    • Destination
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • ForecastArn
    • ForecastExportJobArn
    • ForecastExportJobName
    • LastModificationTime
    • Message
    • Status

DescribeForecastRequest

  • DescribeForecastRequest object
    • ForecastArn required

DescribeForecastResponse

  • DescribeForecastResponse object
    • CreationTime
    • DatasetGroupArn
    • ForecastArn
    • ForecastName
    • ForecastTypes
    • LastModificationTime
    • Message
    • PredictorArn
    • Status

DescribePredictorBacktestExportJobRequest

  • DescribePredictorBacktestExportJobRequest object
    • PredictorBacktestExportJobArn required

DescribePredictorBacktestExportJobResponse

  • DescribePredictorBacktestExportJobResponse object
    • CreationTime
    • Destination DataDestination
    • LastModificationTime
    • Message
    • PredictorArn
    • PredictorBacktestExportJobArn
    • PredictorBacktestExportJobName
    • Status

DescribePredictorRequest

  • DescribePredictorRequest object
    • PredictorArn required

DescribePredictorResponse

  • DescribePredictorResponse object
    • AlgorithmArn
    • AutoMLAlgorithmArns
    • CreationTime
    • DatasetImportJobArns
    • EncryptionConfig
      • KMSKeyArn required
      • RoleArn required
    • EvaluationParameters
      • BackTestWindowOffset
      • NumberOfBacktestWindows
    • FeaturizationConfig
      • Featurizations
      • ForecastDimensions
      • ForecastFrequency required
    • ForecastHorizon
    • ForecastTypes
    • HPOConfig
    • InputDataConfig
    • LastModificationTime
    • Message
    • PerformAutoML
    • PerformHPO
    • PredictorArn
    • PredictorExecutionDetails
    • PredictorName
    • Status
    • TrainingParameters

Domain

  • Domain string (values: RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS)

Double

  • Double number

EncryptionConfig

  • EncryptionConfig object: An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
    • KMSKeyArn required
    • RoleArn required

ErrorMessage

  • ErrorMessage string

ErrorMetric

  • ErrorMetric object: Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.
    • ForecastType
    • RMSE
    • WAPE

ErrorMetrics

EvaluationParameters

  • EvaluationParameters object: Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the CreatePredictor request.
    • BackTestWindowOffset
    • NumberOfBacktestWindows

EvaluationResult

  • EvaluationResult object: The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

EvaluationType

  • EvaluationType string (values: SUMMARY, COMPUTED)

Featurization

FeaturizationConfig

  • FeaturizationConfig object: In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization. You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig object in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training. You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.
    • Featurizations
    • ForecastDimensions
    • ForecastFrequency required

FeaturizationMethod

  • FeaturizationMethod object: Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object. The following is an example of how you specify a FeaturizationMethod object. { "FeaturizationMethodName": "filling", "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"} }
    • FeaturizationMethodName required
    • FeaturizationMethodParameters

FeaturizationMethodName

  • FeaturizationMethodName string (values: filling)

FeaturizationMethodParameters

  • FeaturizationMethodParameters object

FeaturizationPipeline

Featurizations

FieldStatistics

  • FieldStatistics object

Filter

  • Filter object: Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.
    • Condition required
    • Key required
    • Value required

FilterConditionString

  • FilterConditionString string (values: IS, IS_NOT)

Filters

ForecastDimensions

  • ForecastDimensions array

ForecastExportJobSummary

  • ForecastExportJobSummary object: Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.
    • CreationTime
    • Destination
      • S3Config required
        • KMSKeyArn
        • Path required
        • RoleArn required
    • ForecastExportJobArn
    • ForecastExportJobName
    • LastModificationTime
    • Message
    • Status

ForecastExportJobs

ForecastSummary

  • ForecastSummary object: Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.
    • CreationTime
    • DatasetGroupArn
    • ForecastArn
    • ForecastName
    • LastModificationTime
    • Message
    • PredictorArn
    • Status

ForecastType

  • ForecastType string

ForecastTypes

Forecasts

Frequency

  • Frequency string

GeolocationFormat

  • GeolocationFormat string

GetAccuracyMetricsRequest

  • GetAccuracyMetricsRequest object
    • PredictorArn required

GetAccuracyMetricsResponse

  • GetAccuracyMetricsResponse object

HyperParameterTuningJobConfig

  • HyperParameterTuningJobConfig object: Configuration information for a hyperparameter tuning job. You specify this object in the CreatePredictor request. A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters. In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.

InputDataConfig

  • InputDataConfig object: The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.

Integer

  • Integer integer

IntegerParameterRange

  • IntegerParameterRange object: Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
    • MaxValue required
    • MinValue required
    • Name required
    • ScalingType

IntegerParameterRanges

InvalidInputException

InvalidNextTokenException

KMSKeyArn

  • KMSKeyArn string

LimitExceededException

ListDatasetGroupsRequest

  • ListDatasetGroupsRequest object
    • MaxResults
    • NextToken

ListDatasetGroupsResponse

ListDatasetImportJobsRequest

  • ListDatasetImportJobsRequest object
    • Filters
    • MaxResults
    • NextToken

ListDatasetImportJobsResponse

ListDatasetsRequest

  • ListDatasetsRequest object
    • MaxResults
    • NextToken

ListDatasetsResponse

ListForecastExportJobsRequest

  • ListForecastExportJobsRequest object
    • Filters
    • MaxResults
    • NextToken

ListForecastExportJobsResponse

ListForecastsRequest

  • ListForecastsRequest object
    • Filters
    • MaxResults
    • NextToken

ListForecastsResponse

ListPredictorBacktestExportJobsRequest

  • ListPredictorBacktestExportJobsRequest object
    • Filters
    • MaxResults
    • NextToken

ListPredictorBacktestExportJobsResponse

ListPredictorsRequest

  • ListPredictorsRequest object
    • Filters
    • MaxResults
    • NextToken

ListPredictorsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object

MaxResults

  • MaxResults integer

Message

  • Message string

Metrics

  • Metrics object: Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

Name

  • Name string

NextToken

  • NextToken string

ParameterKey

  • ParameterKey string

ParameterRanges

  • ParameterRanges object: Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the HyperParameterTuningJobConfig object.

ParameterValue

  • ParameterValue string

PredictorBacktestExportJobSummary

  • PredictorBacktestExportJobSummary object: Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call the DescribePredictorBacktestExportJob operation, and provide the listed PredictorBacktestExportJobArn.
    • CreationTime
    • Destination DataDestination
    • LastModificationTime
    • Message
    • PredictorBacktestExportJobArn
    • PredictorBacktestExportJobName
    • Status

PredictorBacktestExportJobs

PredictorEvaluationResults

PredictorExecution

  • PredictorExecution object: The algorithm used to perform a backtest and the status of those tests.

PredictorExecutionDetails

  • PredictorExecutionDetails object: Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.

PredictorExecutions

PredictorSummary

  • PredictorSummary object: Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.
    • CreationTime
    • DatasetGroupArn
    • LastModificationTime
    • Message
    • PredictorArn
    • PredictorName
    • Status

Predictors

ResourceAlreadyExistsException

ResourceInUseException

ResourceNotFoundException

S3Config

  • S3Config object: The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.
    • KMSKeyArn
    • Path required
    • RoleArn required

S3Path

  • S3Path string

ScalingType

  • ScalingType string (values: Auto, Linear, Logarithmic, ReverseLogarithmic)

Schema

  • Schema object: Defines the fields of a dataset. You specify this object in the CreateDataset request.

SchemaAttribute

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

SchemaAttributes

Statistics

  • Statistics object: Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob operation.
    • Avg
    • Count
    • CountDistinct
    • CountNan
    • CountNull
    • Max
    • Min
    • Stddev

Status

  • Status string

String

  • String string

SupplementaryFeature

  • SupplementaryFeature object: Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations. Weather Index The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index. Holidays Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.
    • Name required
    • Value required

SupplementaryFeatures

Tag

  • Tag object: The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256 Unicode characters in UTF-8. If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then 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.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeys

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Tags

  • Tags array

TestWindowDetails

TestWindowSummary

  • TestWindowSummary object: The status, start time, and end time of a backtest, as well as a failure reason if applicable.
    • Message
    • Status
    • TestWindowEnd
    • TestWindowStart

TestWindows

TimeZone

  • TimeZone string

Timestamp

  • Timestamp string

TimestampFormat

  • TimestampFormat string

TrainingParameters

  • TrainingParameters object

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateDatasetGroupRequest

  • UpdateDatasetGroupRequest object
    • DatasetArns required
    • DatasetGroupArn required

UpdateDatasetGroupResponse

  • UpdateDatasetGroupResponse object

UseGeolocationForTimeZone

  • UseGeolocationForTimeZone boolean

Value

  • Value string

Values

WeightedQuantileLoss

  • WeightedQuantileLoss object: The weighted loss value for a quantile. This object is part of the Metrics object.
    • LossValue
    • Quantile

WeightedQuantileLosses

WindowSummary

  • WindowSummary object: The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object. The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago