query_status

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

Overview

Name	query_status
Type	Resource
Id	aws.internetmonitor.query_status

Fields

The following fields are returned by SELECT queries:

get_query_status

Name	Datatype	Description
status	string	The current status for a query. (QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_query_status	select	monitor_name, query_id, region		Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results. QUEUED: The query is scheduled to run. RUNNING: The query is in progress but not complete. SUCCEEDED: The query completed sucessfully. FAILED: The query failed due to an error. CANCELED: The query was canceled.

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
monitor_name	string	The name of the monitor.
query_id	string	The ID of the query that you want to return the status for. A QueryId is an internally-generated dentifier for a specific query.
region	string	AWS region (default: us-east-1)

SELECT examples

get_query_status

Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results. QUEUED: The query is scheduled to run. RUNNING: The query is in progress but not complete. SUCCEEDED: The query completed sucessfully. FAILED: The query failed due to an error. CANCELED: The query was canceled.

SELECT
status
FROM aws.internetmonitor.query_status
WHERE monitor_name = '{{ monitor_name }}' -- required
AND query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
;