KinesisVideo / Client / describe_edge_configuration

describe_edge_configuration#

KinesisVideo.Client.describe_edge_configuration(**kwargs)#

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent’s recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.

See also: AWS API Documentation

Request Syntax

response = client.describe_edge_configuration(
    StreamName='string',
    StreamARN='string'
)
Parameters:

  • StreamName (string) – The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

  • StreamARN (string) – The Amazon Resource Name (ARN) of the stream. Specify either the StreamName``or the ``StreamARN.

Return type:

dict

Returns:

Response Syntax

{
    'StreamName': 'string',
    'StreamARN': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'SyncStatus': 'SYNCING'|'ACKNOWLEDGED'|'IN_SYNC'|'SYNC_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETING_ACKNOWLEDGED',
    'FailedStatusDetails': 'string',
    'EdgeConfig': {
        'HubDeviceArn': 'string',
        'RecorderConfig': {
            'MediaSourceConfig': {
                'MediaUriSecretArn': 'string',
                'MediaUriType': 'RTSP_URI'|'FILE_URI'
            },
            'ScheduleConfig': {
                'ScheduleExpression': 'string',
                'DurationInSeconds': 123
            }
        },
        'UploaderConfig': {
            'ScheduleConfig': {
                'ScheduleExpression': 'string',
                'DurationInSeconds': 123
            }
        },
        'DeletionConfig': {
            'EdgeRetentionInHours': 123,
            'LocalSizeConfig': {
                'MaxLocalMediaSizeInMB': 123,
                'StrategyOnFullSize': 'DELETE_OLDEST_MEDIA'|'DENY_NEW_MEDIA'
            },
            'DeleteAfterUpload': True|False
        }
    },
    'EdgeAgentStatus': {
        'LastRecorderStatus': {
            'JobStatusDetails': 'string',
            'LastCollectedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'RecorderStatus': 'SUCCESS'|'USER_ERROR'|'SYSTEM_ERROR'
        },
        'LastUploaderStatus': {
            'JobStatusDetails': 'string',
            'LastCollectedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'UploaderStatus': 'SUCCESS'|'USER_ERROR'|'SYSTEM_ERROR'
        }
    }
}

Response Structure

  • (dict) –

    • StreamName (string) –

      The name of the stream from which the edge configuration was updated.

    • StreamARN (string) –

      The Amazon Resource Name (ARN) of the stream.

    • CreationTime (datetime) –

      The timestamp at which a stream’s edge configuration was first created.

    • LastUpdatedTime (datetime) –

      The timestamp at which a stream’s edge configuration was last updated.

    • SyncStatus (string) –

      The latest status of the edge configuration update.

    • FailedStatusDetails (string) –

      A description of the generated failure status.

    • EdgeConfig (dict) –

      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.

      • HubDeviceArn (string) –

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

      • RecorderConfig (dict) –

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

        • MediaSourceConfig (dict) –

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

          • MediaUriSecretArn (string) –

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

          • MediaUriType (string) –

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

            Note

            Preview only supports the RTSP_URI media source URI format .

        • ScheduleConfig (dict) –

          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.

          • ScheduleExpression (string) –

            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.

          • DurationInSeconds (integer) –

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

      • UploaderConfig (dict) –

        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.

        • ScheduleConfig (dict) –

          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).

          • ScheduleExpression (string) –

            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.

          • DurationInSeconds (integer) –

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

      • DeletionConfig (dict) –

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

        • EdgeRetentionInHours (integer) –

          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.

        • LocalSizeConfig (dict) –

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

          • MaxLocalMediaSizeInMB (integer) –

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

          • StrategyOnFullSize (string) –

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

        • DeleteAfterUpload (boolean) –

          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.

    • EdgeAgentStatus (dict) –

      An object that contains the latest status details for an edge agent’s recorder and uploader jobs. Use this information to determine the current health of an edge agent.

      • LastRecorderStatus (dict) –

        The latest status of a stream’s edge recording job.

        • JobStatusDetails (string) –

          A description of a recorder job’s latest status.

        • LastCollectedTime (datetime) –

          The timestamp at which the recorder job was last executed and media stored to local disk.

        • LastUpdatedTime (datetime) –

          The timestamp at which the recorder status was last updated.

        • RecorderStatus (string) –

          The status of the latest recorder job.

      • LastUploaderStatus (dict) –

        The latest status of a stream’s edge to cloud uploader job.

        • JobStatusDetails (string) –

          A description of an uploader job’s latest status.

        • LastCollectedTime (datetime) –

          The timestamp at which the uploader job was last executed and media collected to the cloud.

        • LastUpdatedTime (datetime) –

          The timestamp at which the uploader status was last updated.

        • UploaderStatus (string) –

          The status of the latest uploader job.

Exceptions