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.
DescribeEdgeConfiguration
Describe la configuración perimetral de una transmisión que se estableció mediante la StartEdgeConfigurationUpdate API y el estado más reciente de las tareas de grabación y carga del agente perimetral. Utilice esta API para obtener el estado de la configuración y determinar si está sincronizada con el agente perimetral. Utilice esta API para evaluar el estado del agente perimetral.
nota
Esta API no está disponible en la región de AWS África (Ciudad del Cabo), af-south-1.
Sintaxis de la solicitud
POST /describeEdgeConfiguration HTTP/1.1
Content-type: application/json
{
"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.
- StreamARN
-
El nombre de recurso de Amazon (ARN) del flujo de . Especifique el o el
StreamName.StreamARNTipo: 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
StreamNameo 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,
"EdgeAgentStatus": {
"LastRecorderStatus": {
"JobStatusDetails": "string",
"LastCollectedTime": number,
"LastUpdatedTime": number,
"RecorderStatus": "string"
},
"LastUploaderStatus": {
"JobStatusDetails": "string",
"LastCollectedTime": number,
"LastUpdatedTime": number,
"UploaderStatus": "string"
}
},
"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
- EdgeAgentStatus
-
Objeto que contiene los detalles de estado más recientes de las tareas de grabación y carga de un agente perimetral. Utilice esta información para determinar el estado actual de un agente perimetral.
Tipo: objeto EdgeAgentStatus
- 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 más reciente de la actualización de la configuración de borde.
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
- ResourceNotFoundException
-
Amazon Kinesis Video Streams no encuentra la transmisión que ha especificado.
Código de estado HTTP: 404
- StreamEdgeConfigurationNotFoundException
-
La excepción se representa cuando Amazon Kinesis Video Stream no encuentra la configuración perimetral de una transmisión que haya 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:
