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.
ListAgents
Devuelve una lista deAWS DataSync agentes que pertenecen a unaCuenta de AWS de lasRegión de AWS especificadas en la solicitud.
Con la paginación, puede reducir la cantidad de agentes devueltos en una respuesta. Si aparece una lista truncada de agentes en una respuesta, la respuesta contiene un marcador que puede especificar en su próxima solicitud para acceder a la siguiente página de agentes.
ListAgentses eventualmente consistente. Esto significa que el resultado de la ejecución de la operación puede no reflejar que acaba de crear o eliminar un agente. Por ejemplo, si crea un agente con CreateAgenty, a continuación, lo ejecuta inmediatamenteListAgents, es posible que ese agente no aparezca en la lista de inmediato. En situaciones como esta, siempre puede confirmar si se ha creado (o eliminado) un agente mediante el uso DescribeAgent.
Sintaxis de la solicitud
{
"MaxResults": number,
"NextToken": "string"
}Parámetros de solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- MaxResults
-
Especifica el número máximo deDataSync agentes para enumerar en una respuesta. De forma predeterminada, una respuesta muestra un máximo de 100 agentes.
Tipo: entero
Rango válido: valor mínimo de 0. Valor máximo de 100.
Obligatorio: no
- NextToken
-
Especifica una cadena opaca que indica la posición para comenzar la siguiente lista de resultados de la respuesta.
Tipo: String
Limitaciones de longitud: longitud máxima de 65535 caracteres.
Patrón:
[a-zA-Z0-9=_-]+Obligatorio: no
Sintaxis de la respuesta
{
"Agents": [
{
"AgentArn": "string",
"Name": "string",
"Status": "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.
- Agents
-
Una lista de susDataSync agentesCuenta de AWS en la queRegión de AWS se especifica en la solicitud. La lista se ordena según los nombres de recursos de Amazon (ARN) de los agentes de.
Tipo: Matriz de objetos AgentListEntry
- NextToken
-
La cadena opaca que indica la posición para comenzar la siguiente lista de resultados de la respuesta.
Tipo: String
Limitaciones de longitud: longitud máxima de 65535 caracteres.
Patrón:
[a-zA-Z0-9=_-]+
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- InternalException
-
Esta excepción se produce cuando se produce un error en elAWS DataSync servicio.
Código de estado HTTP: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con formato incorrecto.
Código de estado HTTP: 400
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:
