StartEdgeConfigurationUpdate - Amazon Kinesis Video Streams
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

StartEdgeConfigurationUpdate

Una API asincrónica que actualiza la configuración perimetral existente de una transmisión. Kinesis Video Stream sincronizará la configuración perimetral de la transmisión con el componente Edge Agent IoT Greengrass que se ejecuta en un dispositivo IoT Hub, configurado en sus instalaciones. El tiempo de sincronización puede variar y depende de la conectividad del dispositivo Hub. ElSyncStatusse actualizará cuando se confirme la configuración de Edge y se sincronizará con el Edge Agent.

Si se invoca esta API por primera vez, se creará una nueva configuración de borde para la transmisión y el estado de sincronización se establecerá enSYNCING. Tendrá que esperar a que el estado de sincronización alcance un estado terminal, como:IN_SYNC, oSYNC_FAILED, antes de volver a utilizar esta API. Si invoca esta API durante el proceso de sincronización, unResourceInUseExceptionserá arrojado. Se volverá a intentar conectar la configuración perimetral de la transmisión y el Edge Agent durante 15 minutos. Transcurridos 15 minutos, el estado pasará aSYNC_FAILEDestado.

Para mover una configuración de borde de un dispositivo a otro, utiliceDeleteEdgeConfigurationpara eliminar la configuración de borde actual. A continuación, puede invocarStartEdgeConfigurationUpdatecon un ARN de Hub Device actualizado.

nota

Esta API no está disponible enAWSRegión de África (Ciudad del Cabo), af-sur-1.

Sintaxis de la solicitud

POST /startEdgeConfigurationUpdate HTTP/1.1
Content-type: application/json

{
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "StreamARN": "string",
   "StreamName": "string"
}

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

EdgeConfig

Los detalles de configuración de borde necesarios para invocar el proceso de actualización.

Tipo: objeto EdgeConfig

Obligatorio: sí

StreamARN

El nombre de recurso de Amazon (ARN) del flujo de . Especifique uno de losStreamNameo elStreamARN.

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.

Patrón: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Obligatorio: no

StreamName

El nombre de la transmisión cuya configuración de borde desea actualizar. Especifique uno de losStreamNameo elStreamARN.

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.

Patrón: [a-zA-Z0-9_.-]+

Obligatorio: no

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "FailedStatusDetails": "string",
   "LastUpdatedTime": number,
   "StreamARN": "string",
   "StreamName": "string",
   "SyncStatus": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CreationTime

La marca de tiempo en la que se creó por primera vez la configuración de borde de una transmisión.

Tipo: Timestamp

EdgeConfig

Una descripción de la configuración perimetral de la transmisión que se utilizará para sincronizar con el componente Edge Agent IoT Greengrass. El componente Edge Agent se ejecutará en una configuración de dispositivo IoT Hub en sus instalaciones.

Tipo: objeto EdgeConfig

FailedStatusDetails

Descripción del estado de error generado.

Tipo: String

LastUpdatedTime

La marca de tiempo en la que se actualizó por última vez la configuración de borde de una transmisión.

Tipo: Timestamp

StreamARN

El nombre de recurso de Amazon (ARN) del flujo de .

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.

Patrón: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

El nombre del flujo desde el que se actualizó la configuración de borde.

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.

Patrón: [a-zA-Z0-9_.-]+

SyncStatus

El estado de sincronización actual de la configuración perimetral de la transmisión. Al invocar esta API, el estado de sincronización se establecerá enSYNCINGestado. Utilice elDescribeEdgeConfigurationAPI para obtener el estado más reciente de la configuración perimetral.

Tipo: String

Valores válidos: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene los permisos necesarios para realizar esta operación.

Código de estado HTTP: 401

ClientLimitExceededException

Kinesis Video Streams ha limitado la solicitud porque ha superado el límite de llamadas de cliente permitidas. Intenta hacer la llamada más tarde.

Código de estado HTTP: 400

InvalidArgumentException

El valor de este parámetro de entrada no es válido.

Código de estado HTTP: 400

NoDataRetentionException

La retención de datos de Stream en horas es igual a cero.

Código de estado HTTP: 400

ResourceInUseException

Cuando la entradaStreamARNoChannelARNenCLOUD_STORAGE_MODEya está mapeado a un recurso de Kinesis Video Stream diferente, o si la entrada proporcionadaStreamARNoChannelARNno está en estado Activo, pruebe una de las siguientes opciones:

  1. ElDescribeMediaStorageConfigurationAPI para determinar a qué se asigna el canal determinado de la transmisión.

  2. ElDescribeMappedResourceConfigurationAPI para determinar el canal al que está mapeado el flujo dado.

  3. ElDescribeStreamoDescribeSignalingChannelAPI para determinar el estado del recurso.

Código de estado HTTP: 400

ResourceNotFoundException

Amazon Kinesis Video Streams no encuentra la transmisión que especificó.

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: