| Column Name | Column Data Type |
|---|
what_if_forecast_arn Required Input Column
The Amazon Resource Name (ARN) of the what-if forecast. | 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
When the what-if forecast was created. | TIMESTAMP_S |
estimated_time_remaining_in_minutes
The approximate time remaining to complete the what-if forecast, in minutes. | BIGINT |
forecast_types
The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["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
If an error occurred, an informational message about the error. | VARCHAR |
status
The status of the what-if forecast. States include: -
ACTIVE -
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED -
CREATE_STOPPING, CREATE_STOPPED -
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED The Status of the what-if forecast must be ACTIVE before you can access the forecast. | VARCHAR |
time_series_replacements_data_source
An array of S3Config, Schema, and Format elements that describe the replacement time series. | STRUCT(
"s3_config" STRUCT(
"path" VARCHAR,
"role_arn" VARCHAR,
"kms_key_arn" VARCHAR
),
"schema" STRUCT(
"attributes" STRUCT(
"attribute_name" VARCHAR,
"attribute_type" VARCHAR
)[]
),
"format" VARCHAR,
"timestamp_format" VARCHAR
) |
Show child fields- time_series_replacements_data_source.format
The format of the replacement data, CSV or PARQUET. - time_series_replacements_data_source.s3_config
The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an 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. Show child fields- time_series_replacements_data_source.s3_config.kms_key_arn
The Amazon Resource Name (ARN) of an Key Management Service (KMS) key. - time_series_replacements_data_source.s3_config.path
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket. - time_series_replacements_data_source.s3_config.role_arn
The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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.
- time_series_replacements_data_source.schema
Defines the fields of a dataset. Show child fields- time_series_replacements_data_source.schema.attributes[]
Show child fields- time_series_replacements_data_source.schema.attributes[].attribute_name
The name of the dataset field. - time_series_replacements_data_source.schema.attributes[].attribute_type
The data type of the field. For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
- time_series_replacements_data_source.timestamp_format
The timestamp format of the replacement data.
|
time_series_transformations
An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series. | STRUCT(
"action" STRUCT(
"attribute_name" VARCHAR,
"operation" VARCHAR,
"value" DOUBLE
),
"time_series_conditions" STRUCT(
"attribute_name" VARCHAR,
"attribute_value" VARCHAR,
"condition" VARCHAR
)[]
)[] |
Show child fields- time_series_transformations[]
Show child fields- time_series_transformations[].action
An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis. Show child fields- time_series_transformations[].action.attribute_name
The related time series that you are modifying. This value is case insensitive. - time_series_transformations[].action.operation
The operation that is applied to the provided attribute. Operations include: -
ADD - adds Value to all rows of AttributeName. -
SUBTRACT - subtracts Value from all rows of AttributeName. -
MULTIPLY - multiplies all rows of AttributeName by Value. -
DIVIDE - divides all rows of AttributeName by Value. - time_series_transformations[].action.value
The value that is applied for the chosen Operation.
- time_series_transformations[].time_series_conditions[]
Show child fields- time_series_transformations[].time_series_conditions[].attribute_name
The item_id, dimension name, IM name, or timestamp that you are modifying. - time_series_transformations[].time_series_conditions[].attribute_value
The value that is applied for the chosen Condition. - time_series_transformations[].time_series_conditions[].condition
The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.
|
what_if_analysis_arn
The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast. | VARCHAR |
what_if_forecast_name
The name of the what-if forecast. | VARCHAR |