edge_agent_configurations

Creates, updates, deletes, gets or lists an edge_agent_configurations resource.

Overview

Name	edge_agent_configurations
Type	Resource
Id	aws.kinesisvideo.edge_agent_configurations

Fields

The following fields are returned by SELECT queries:

list_edge_agent_configurations

Name	Datatype	Description
creation_time	string (date-time)	The timestamp when the stream first created the edge config.
edge_config	object	A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.
failed_status_details	string	A description of the generated failure status.
last_updated_time	string (date-time)	The timestamp when the stream last updated the edge config.
stream_arn	string	The Amazon Resource Name (ARN) of the stream. (pattern: <code>arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+</code>)
stream_name	string	The name of the stream. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
sync_status	string	The current sync status of the stream's edge configuration. (SYNCING, ACKNOWLEDGED, IN_SYNC, SYNC_FAILED, DELETING, DELETE_FAILED, DELETING_ACKNOWLEDGED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_edge_agent_configurations	select	region		Returns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn.

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_edge_agent_configurations

Returns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn.

SELECT
creation_time,
edge_config,
failed_status_details,
last_updated_time,
stream_arn,
stream_name,
sync_status
FROM aws.kinesisvideo.edge_agent_configurations
WHERE region = '{{ region }}' -- required
;