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 asíncrona que actualiza la configuración perimetral existente de una transmisión. El 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. Se SyncStatus actualizará a medida que se reconozca la configuración perimetral y se sincronizará con el agente perimetral.

Si se invoca esta API por primera vez, se creará una nueva configuración perimetral para la transmisión y el estado de la sincronización se establecerá en. SYNCING Tendrás que esperar a que el estado de sincronización alcance un estado terminal como:IN_SYNC, oSYNC_FAILED, antes de volver a usar esta API. Si invocas esta API durante el proceso de sincronización, ResourceInUseException aparecerá una. La conectividad de la configuración perimetral de la transmisión y el agente perimetral se volverá a intentar durante 15 minutos. Transcurridos 15 minutos, el estado pasará al SYNC_FAILED estado.

Para mover una configuración perimetral de un dispositivo a otro, utilice DeleteEdgeConfiguration para eliminar la configuración perimetral actual. A continuación, puede invocar StartEdgeConfigurationUpdate con un ARN de dispositivo hub actualizado.

nota

Esta API no está disponible en la región de AWS África (Ciudad del Cabo), af-south-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 perimetral 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 el StreamName o 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 del flujo cuya configuración de borde desea actualizar. Especifique el StreamName o 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 un flujo.

Tipo: marca temporal

EdgeConfig

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

Tipo: objeto EdgeConfig

FailedStatusDetails

Una descripción del estado de fallo generado.

Tipo: cadena

LastUpdatedTime

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

Tipo: marca temporal

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á en ese SYNCING estado. Usa la DescribeEdgeConfiguration API para obtener el estado más reciente de la configuración perimetral.

Tipo: cadena

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

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores 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 clientes permitidas. Intente realizar 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

Si la entrada StreamARN o ChannelARN entrada ya CLOUD_STORAGE_MODE está mapeada a otro recurso de Kinesis Video Stream, o si la StreamARN entrada ChannelARN proporcionada no está en estado Activo, pruebe una de las siguientes opciones:

  1. La DescribeMediaStorageConfiguration API para determinar a qué está asignado el canal de transmisión en cuestión.

  2. La DescribeMappedResourceConfiguration API para determinar el canal al que está mapeada la transmisión determinada.

  3. La DescribeStream o DescribeSignalingChannel API para determinar el estado del recurso.

Código de estado HTTP: 400

ResourceNotFoundException

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

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente: