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.
ListTagsForResource
Enumera todas las etiquetas asociadas con el nombre de recurso de Amazon (ARN) que especifique. El recurso puede ser un usuario, un servidor o un rol.
Sintaxis de la solicitud
{
"Arn": "string",
"MaxResults": number,
"NextToken": "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 formato JSON.
- Arn
-
Solicita las etiquetas asociadas con un nombre de recurso de Amazon (ARN) concreto. Un ARN es un identificador de un AWS recurso específico, como un servidor, un usuario o un rol.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
Patrón:
arn:\S+Obligatorio: sí
- MaxResults
-
Especifica el número de etiquetas que se devolverán como respuesta a la solicitud
ListTagsForResource.Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 1000.
Obligatorio: no
- NextToken
-
Al solicitar resultados adicionales de la operación
ListTagsForResource, se devuelve un parámetroNextTokenen la entrada. A continuación, puede pasar un comando posterior al parámetroNextTokenpara seguir enumerando etiquetas adicionales.Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.
Obligatorio: no
Sintaxis de la respuesta
{
"Arn": "string",
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- Arn
-
El ARN que especificó para enumerar las etiquetas.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
Patrón:
arn:\S+ - NextToken
-
Cuando pueda obtener resultados adicionales de la llamada
ListTagsForResource, se devolverá un parámetroNextTokenen la salida. A continuación, puede pasar un comando posterior al parámetroNextTokenpara seguir enumerando etiquetas adicionales.Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.
- Tags
-
Pares clave-valor que se asignan a un recurso, normalmente con el fin de agrupar y buscar elementos. Las etiquetas son metadatos que usted puede definir.
Tipo: Matriz de Tag objetos
Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 50 artículos.
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.
Código de estado HTTP: 500
- InvalidNextTokenException
-
El parámetro
NextTokenque se pasó no es válido.Código de estado HTTP: 400
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.
Código de estado HTTP: 500
Ejemplos
Ejemplo
En el ejemplo siguiente, se enumeran las etiquetas del recurso con el ARN que especificó.
Solicitud de muestra
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef"
}Ejemplo
Este ejemplo ilustra un uso de ListTagsForResource.
Respuesta de ejemplo
{
"Tags": [
{
"Key": "Name",
"Value": "MyServer"
}
]
}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:
