what_if_analyses
Creates, updates, deletes, gets or lists a what_if_analyses resource.
Overview
| Name | what_if_analyses |
| Type | Resource |
| Id | aws.forecast.what_if_analyses |
Fields
The following fields are returned by SELECT queries:
- list_what_if_analyses
| Name | Datatype | Description |
|---|---|---|
creation_time | string (date-time) | When the what-if analysis was created. |
forecast_arn | string | The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>) |
last_modification_time | string (date-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. |
message | string | If an error occurred, an informational message about the error. |
status | string | The status of the what-if analysis. 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 analysis must be ACTIVE before you can access the analysis. |
what_if_analysis_arn | string | The Amazon Resource Name (ARN) of the what-if analysis. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>) |
what_if_analysis_name | string | The name of the what-if analysis. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_what_if_analyses | select | region | Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_what_if_analyses
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.
SELECT
creation_time,
forecast_arn,
last_modification_time,
message,
status,
what_if_analysis_arn,
what_if_analysis_name
FROM aws.forecast.what_if_analyses
WHERE region = '{{ region }}' -- required
;