AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Kinesis Video Streams StartEdgeConfigurationUpdate API operation.

Syntax

Start-KVEdgeConfigurationUpdate
-StreamARN <String>
-DeletionConfig_DeleteAfterUpload <Boolean>
-EdgeConfig_RecorderConfig_ScheduleConfig_DurationInSeconds <Int32>
-EdgeConfig_UploaderConfig_ScheduleConfig_DurationInSeconds <Int32>
-DeletionConfig_EdgeRetentionInHour <Int32>
-EdgeConfig_HubDeviceArn <String>
-LocalSizeConfig_MaxLocalMediaSizeInMB <Int32>
-MediaSourceConfig_MediaUriSecretArn <String>
-MediaSourceConfig_MediaUriType <MediaUriType>
-EdgeConfig_RecorderConfig_ScheduleConfig_ScheduleExpression <String>
-EdgeConfig_UploaderConfig_ScheduleConfig_ScheduleExpression <String>
-LocalSizeConfig_StrategyOnFullSize <StrategyOnFullSize>
-StreamName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKinesisVideoConfig>

Description

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent. If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state. To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

Parameters

-ClientConfig <AmazonKinesisVideoConfig>
Amazon.PowerShell.Cmdlets.KV.AmazonKinesisVideoClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionConfig_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_DeletionConfig_DeleteAfterUpload
-DeletionConfig_EdgeRetentionInHour <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_DeletionConfig_EdgeRetentionInHours
-EdgeConfig_HubDeviceArn <String>
The "Internet of Things (IoT) Thing" Arn of the stream.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EdgeConfig_RecorderConfig_ScheduleConfig_DurationInSeconds <Int32>
The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EdgeConfig_RecorderConfig_ScheduleConfig_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EdgeConfig_UploaderConfig_ScheduleConfig_DurationInSeconds <Int32>
The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EdgeConfig_UploaderConfig_ScheduleConfig_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocalSizeConfig_MaxLocalMediaSizeInMB <Int32>
The overall maximum size of the media that you want to store for a stream on the Edge Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_DeletionConfig_LocalSizeConfig_MaxLocalMediaSizeInMB
-LocalSizeConfig_StrategyOnFullSize <StrategyOnFullSize>
The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_DeletionConfig_LocalSizeConfig_StrategyOnFullSize
-MediaSourceConfig_MediaUriSecretArn <String>
The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_RecorderConfig_MediaSourceConfig_MediaUriSecretArn
-MediaSourceConfig_MediaUriType <MediaUriType>
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 .
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdgeConfig_RecorderConfig_MediaSourceConfig_MediaUriType
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamARN <String>
The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-StreamName <String>
The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse
This cmdlet returns an Amazon.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse object containing multiple properties.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z