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.
ListEdgeAgentConfigurations
Devuelve una matriz de configuraciones de borde asociadas al agente de Edge especificado.
En la solicitud, debe especificar el agente perimetralHubDeviceArn.
nota
Esta API no está disponible en la región de AWS África (Ciudad del Cabo), af-south-1.
Sintaxis de la solicitud
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json
{
"HubDeviceArn": "string",
"MaxResults": number,
"NextToken": "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.
- HubDeviceArn
-
El arn del «Internet de las cosas (IoT)» del agente perimetral.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+Obligatorio: sí
- MaxResults
-
El número máximo de configuraciones perimetrales que se devolverán en la respuesta. El valor predeterminado es 5.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 10.
Obligatorio: no
- NextToken
-
Si especifica este parámetro, cuando el resultado de una
ListEdgeAgentConfigurationsoperación se trunca, la llamada devuelve el valor deNextTokenla respuesta. Para obtener otro lote de configuraciones perimetrales, proporciona este token en tu próxima solicitud.Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es 512.
Patrón:
[a-zA-Z0-9+/=]*Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"EdgeConfigs": [
{
"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"
}
],
"NextToken": "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.
- EdgeConfigs
-
Una descripción de la configuración perimetral de un solo flujo.
Tipo: matriz de objetos ListEdgeAgentConfigurationsEdgeConfig
- NextToken
-
Si la respuesta está truncada, la llamada devuelve este elemento con un token determinado. Para obtener el siguiente lote de configuraciones perimetrales, usa este token en tu próxima solicitud.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es 512.
Patrón:
[a-zA-Z0-9+/=]*
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- 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
- NotAuthorizedException
-
La persona que llama no está autorizada a realizar esta operación.
Código de estado HTTP: 401
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, consulta lo siguiente:
