ListAgreements - AWS Transfer Family
Sintaxis de la solicitudParámetros 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.

ListAgreements

Devuelve una lista de los acuerdos del servidor que se identifica con el ServerId que usted proporciona. Si desea limitar los resultados a un número determinado, introduzca un valor para el parámetro MaxResults. Si ejecutó el comando anteriormente y recibió un valor para NextToken, puede proporcionarlo para seguir enumerando los acuerdos desde donde los dejó.

Sintaxis de la solicitud

{
   "MaxResults": number,
   "NextToken": "string",
   "ServerId": "string"
}

Parámetros de la 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 JSON formato.

MaxResults

El número máximo de acuerdos que devolver.

Tipo: entero

Rango válido: valor mínimo de 1. Valor máximo de 1000.

Obligatorio: no

NextToken

Cuando pueda obtener resultados adicionales de la llamada ListAgreements, se devolverá un parámetro NextToken en la salida. A continuación, puede pasar un comando posterior al parámetro NextToken para seguir enumerando los acuerdos adicionales.

Tipo: cadena

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

Obligatorio: no

ServerId

El identificador del servidor para el que desea obtener una lista de acuerdos.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: s-([0-9a-f]{17})

Obligatorio: sí

Sintaxis de la respuesta

{
   "Agreements": [ 
      { 
         "AgreementId": "string",
         "Arn": "string",
         "Description": "string",
         "LocalProfileId": "string",
         "PartnerProfileId": "string",
         "ServerId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Elementos de respuesta

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

El servicio devuelve los siguientes datos en JSON formato.

Agreements

Devuelve una matriz en la que cada elemento contiene los detalles de un acuerdo.

Tipo: matriz de objetos ListedAgreement

NextToken

Devuelve un token que puede usar para volver a llamar a ListAgreements y recibir resultados adicionales, si los hay.

Tipo: cadena

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

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServiceError

Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.

HTTPCódigo de estado: 500

InvalidNextTokenException

El parámetro NextToken que se pasó no es válido.

HTTPCódigo de estado: 400

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

HTTPCódigo de estado: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

HTTPCódigo de estado: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

HTTPCódigo de estado: 500

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: