telemetry_evaluation_status

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

Overview

Name	telemetry_evaluation_status
Type	Resource
Id	aws.observabilityadmin.telemetry_evaluation_status

Fields

The following fields are returned by SELECT queries:

get_telemetry_evaluation_status

Name	Datatype	Description
failure_reason	string	Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
home_region	string	The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation. The home region is the single management point for all multi-region operations on this account. This field is only present when multi-region telemetry evaluation is active.
region_statuses	array	A list of per-region telemetry evaluation statuses. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.
status	string	The onboarding status of the telemetry config feature. (NOT_STARTED, STARTING, FAILED_START, RUNNING, STOPPING, FAILED_STOP, STOPPED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_telemetry_evaluation_status	select	region		Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

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

get_telemetry_evaluation_status

Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

SELECT
failure_reason,
home_region,
region_statuses,
status
FROM aws.observabilityadmin.telemetry_evaluation_status
WHERE region = '{{ region }}' -- required
;