| Column Name | Column Data Type |
|---|
predictor_arn Required Input Column
The Amazon Resource Name (ARN) of the predictor | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
creation_time
The timestamp of the CreateAutoPredictor request. | TIMESTAMP_S |
data_config
The data configuration for your dataset group and any additional datasets. | STRUCT(
"dataset_group_arn" VARCHAR,
"attribute_configs" STRUCT(
"attribute_name" VARCHAR,
"transformations" MAP(VARCHAR, VARCHAR)
)[],
"additional_datasets" STRUCT(
"name" VARCHAR,
"configuration" MAP(VARCHAR, VARCHAR[])
)[]
) |
Show child fields- data_config.additional_datasets[]
Show child fields- data_config.additional_datasets[].configuration
Weather Index To enable the Weather Index, do not specify a value for Configuration. Holidays Holidays To enable Holidays, set CountryCode to one of the following two-letter country codes: - data_config.additional_datasets[].name
The name of the additional dataset. Valid names: "holiday" and "weather".
- data_config.attribute_configs[]
Show child fields- data_config.attribute_configs[].attribute_name
The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the target time series and the related time series datasets. For example, for the RETAIL domain, the target is demand. - data_config.attribute_configs[].transformations
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters. The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Default values are bolded. -
aggregation: sum, avg, first, min, max -
frontfill: none -
middlefill: zero, nan (not a number), value, median, mean, min, max -
backfill: zero, nan, value, median, mean, min, max The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults): -
middlefill: zero, value, median, mean, min, max -
backfill: zero, value, median, mean, min, max -
futurefill: zero, value, median, mean, min, max To set a filling method to a specific value, set the fill parameter to value and define the value in a corresponding _value parameter. For example, to set backfilling to a value of 2, include the following: "backfill": "value" and "backfill_value":"2".
- data_config.dataset_group_arn
The ARN of the dataset group used to train the predictor.
|
dataset_import_job_arns
An array of the ARNs of the dataset import jobs used to import training data for the predictor. | VARCHAR[] |
Show child fields- dataset_import_job_arns[]
|
encryption_config
An Key Management Service (KMS) key and an 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. | STRUCT(
"role_arn" VARCHAR,
"kms_key_arn" VARCHAR
) |
Show child fields- encryption_config.kms_key_arn
The Amazon Resource Name (ARN) of the KMS key. - encryption_config.role_arn
The ARN of the IAM role that Amazon Forecast can assume to access the KMS key. Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.
|
estimated_time_remaining_in_minutes
The estimated time remaining in minutes for the predictor training job to complete. | BIGINT |
explainability_info
Provides the status and ARN of the Predictor Explainability. | STRUCT(
"explainability_arn" VARCHAR,
"status" VARCHAR
) |
Show child fields- explainability_info.explainability_arn
The Amazon Resource Name (ARN) of the Explainability. - explainability_info.status
The status of the Explainability. States include: -
ACTIVE -
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED -
CREATE_STOPPING, CREATE_STOPPED -
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
|
forecast_dimensions
An array of dimension (field) names that specify the attributes used to group your time series. | VARCHAR[] |
Show child fields- forecast_dimensions[]
|
forecast_frequency
The frequency of predictions in a forecast. Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes. | VARCHAR |
forecast_horizon
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. | BIGINT |
forecast_types
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]. | VARCHAR[] |
Show child fields- forecast_types[]
|
last_modification_time
The last time the resource was modified. The timestamp depends on the status of the job: -
CREATE_PENDING - The CreationTime. -
CREATE_IN_PROGRESS - The current timestamp. -
CREATE_STOPPING - The current timestamp. -
CREATE_STOPPED - When the job stopped. -
ACTIVE or CREATE_FAILED - When the job finished or failed. | TIMESTAMP_S |
message
In the event of an error, a message detailing the cause of the error. | VARCHAR |
monitor_info
A object with the Amazon Resource Name (ARN) and status of the monitor resource. | STRUCT(
"monitor_arn" VARCHAR,
"status" VARCHAR
) |
Show child fields- monitor_info.monitor_arn
The Amazon Resource Name (ARN) of the monitor resource. - monitor_info.status
The status of the monitor. States include: -
ACTIVE -
ACTIVE_STOPPING, ACTIVE_STOPPED -
UPDATE_IN_PROGRESS -
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED -
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
|
optimization_metric
The accuracy metric used to optimize the predictor. | VARCHAR |
predictor_name
The name of the predictor. | VARCHAR |
reference_predictor_summary
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors. | STRUCT(
"arn" VARCHAR,
"state" VARCHAR
) |
Show child fields- reference_predictor_summary.arn
The ARN of the reference predictor. - reference_predictor_summary.state
Whether the reference predictor is Active or Deleted.
|
status
The status of the predictor. States include: -
ACTIVE -
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED -
CREATE_STOPPING, CREATE_STOPPED -
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED | VARCHAR |
time_alignment_boundary
The time boundary Forecast uses when aggregating data. | STRUCT(
"month" VARCHAR,
"day_of_month" BIGINT,
"day_of_week" VARCHAR,
"hour" BIGINT
) |
Show child fields- time_alignment_boundary.day_of_month
The day of the month to use for time alignment during aggregation. - time_alignment_boundary.day_of_week
The day of week to use for time alignment during aggregation. The day must be in uppercase. - time_alignment_boundary.hour
The hour of day to use for time alignment during aggregation. - time_alignment_boundary.month
The month to use for time alignment during aggregation. The month must be in uppercase.
|