monitors

Creates, updates, deletes, gets or lists a monitors resource.

Overview

Name	monitors
Type	Resource
Id	aws.forecast.monitors

Fields

The following fields are returned by SELECT queries:

describe_monitor

Name	Datatype	Description
baseline	object	Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
creation_time	string (date-time)	The timestamp for when the monitor resource was created.
estimated_evaluation_time_remaining_in_minutes	integer (int64)	The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
last_evaluation_state	string	The state of the monitor's latest evaluation.
last_evaluation_time	string (date-time)	The timestamp of the latest evaluation completed by the monitor.
last_modification_time	string (date-time)	The timestamp of the latest modification to the monitor.
message	string	An error message, if any, for the monitor.
monitor_arn	string	The Amazon Resource Name (ARN) of the monitor resource described. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
monitor_name	string	The name of the monitor. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the auto predictor being monitored. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
status	string	The status of the monitor resource.

list_monitors

Name	Datatype	Description
creation_time	string (date-time)	When the monitor resource was created.
last_modification_time	string (date-time)	The last time the monitor resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. STOPPED - When the resource stopped. ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.
monitor_arn	string	The Amazon Resource Name (ARN) of the monitor resource. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
monitor_name	string	The name of the monitor resource. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the predictor being monitored. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
status	string	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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_monitor	select	region		Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties: Baseline CreationTime LastEvaluationTime LastEvaluationState LastModificationTime Message Status
list_monitors	select	region		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 can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
create_monitor	insert	region, MonitorName, ResourceArn		Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
delete_monitor	delete	region		Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.

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

describe_monitor

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties: Baseline CreationTime LastEvaluationTime LastEvaluationState LastModificationTime Message Status

SELECT
baseline,
creation_time,
estimated_evaluation_time_remaining_in_minutes,
last_evaluation_state,
last_evaluation_time,
last_modification_time,
message,
monitor_arn,
monitor_name,
resource_arn,
status
FROM aws.forecast.monitors
WHERE region = '{{ region }}' -- required
;

list_monitors

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

SELECT
creation_time,
last_modification_time,
monitor_arn,
monitor_name,
resource_arn,
status
FROM aws.forecast.monitors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_monitor

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

INSERT INTO aws.forecast.monitors (
MonitorName,
ResourceArn,
Tags,
region
)
SELECT 
'{{ MonitorName }}' /* required */,
'{{ ResourceArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
monitor_arn
;

Manifest

# Description fields are for documentation purposes
- name: monitors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the monitors resource.
  - name: MonitorName
    value: "{{ MonitorName }}"
    description: |
      The name of the monitor resource.
  - name: ResourceArn
    value: "{{ ResourceArn }}"
    description: |
      The Amazon Resource Name (ARN) of the predictor to monitor.
  - name: Tags
    description: |
      A list of tags to apply to the monitor resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_monitor

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

DELETE FROM aws.forecast.monitors
WHERE region = '{{ region }}' --required
;