Skip to content

aws.kinesisvideo.list_edge_agent_configurations

Example SQL Queries

SELECT * FROM
aws.kinesisvideo.list_edge_agent_configurations
WHERE
"hub_device_arn" = 'VALUE';

Description

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

Table Definition

Column NameColumn Data Type
hub_device_arn Required Input Column

The "Internet of Things (IoT) Thing" Arn of the edge agent.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_time

The timestamp when the stream first created the edge config.

TIMESTAMP_S
edge_config

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.

STRUCT(
"hub_device_arn" VARCHAR,
"recorder_config" STRUCT(
"media_source_config" STRUCT(
"media_uri_secret_arn" VARCHAR,
"media_uri_type" VARCHAR
),
"schedule_config" STRUCT(
"schedule_expression" VARCHAR,
"duration_in_seconds" BIGINT
)
),
"uploader_config" STRUCT(
"schedule_config" STRUCT(
"schedule_expression" VARCHAR,
"duration_in_seconds" BIGINT
)
),
"deletion_config" STRUCT(
"edge_retention_in_hours" BIGINT,
"local_size_config" STRUCT(
"max_local_media_size_in_mb" BIGINT,
"strategy_on_full_size" VARCHAR
),
"delete_after_upload" BOOLEAN
)
)
Show child fields
edge_config.deletion_config

The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

Show child fields
edge_config.deletion_config.delete_after_upload

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

edge_config.deletion_config.edge_retention_in_hours

The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

edge_config.deletion_config.local_size_config

The value of the local size required in order to delete the edge configuration.

Show child fields
edge_config.deletion_config.local_size_config.max_local_media_size_in_mb

The overall maximum size of the media that you want to store for a stream on the Edge Agent.

edge_config.deletion_config.local_size_config.strategy_on_full_size

The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

edge_config.hub_device_arn

The "Internet of Things (IoT) Thing" Arn of the stream.

edge_config.recorder_config

The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

Show child fields
edge_config.recorder_config.media_source_config

The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

Show child fields
edge_config.recorder_config.media_source_config.media_uri_secret_arn

The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

edge_config.recorder_config.media_source_config.media_uri_type

The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

Preview only supports the RTSP_URI media source URI format .

edge_config.recorder_config.schedule_config

The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

Show child fields
edge_config.recorder_config.schedule_config.duration_in_seconds

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

edge_config.recorder_config.schedule_config.schedule_expression

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

edge_config.uploader_config

The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

Show child fields
edge_config.uploader_config.schedule_config

The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

Show child fields
edge_config.uploader_config.schedule_config.duration_in_seconds

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

edge_config.uploader_config.schedule_config.schedule_expression

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

failed_status_details

A description of the generated failure status.

VARCHAR
last_updated_time

The timestamp when the stream last updated the edge config.

TIMESTAMP_S
stream_arn

The Amazon Resource Name (ARN) of the stream.

VARCHAR
stream_name

The name of the stream.

VARCHAR
sync_status

The current sync status of the stream's edge configuration.

VARCHAR