ListTagsForResource - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListTagsForResource

Répertorie toutes les balises associées à l'Amazon Resource Name (ARN) que vous spécifiez. La ressource peut être un utilisateur, un serveur ou un rôle.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

Arn

Demande les balises associées à un Amazon Resource Name (ARN) spécifique. Un ARN est un identifiant pour une AWS ressource spécifique, telle qu'un serveur, un utilisateur ou un rôle.

Type : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Modèle : arn:\S+

Obligatoire : oui

MaxResults

Spécifie le nombre de balises à renvoyer en réponse à la ListTagsForResource demande.

Type : entier

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

Obligatoire : non

NextToken

Lorsque vous demandez des résultats supplémentaires à l'ListTagsForResourceopération, un NextToken paramètre est renvoyé dans l'entrée. Vous pouvez ensuite passer une commande suivante au NextToken paramètre pour continuer à répertorier les balises supplémentaires.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

Obligatoire : non

Syntaxe de la réponse

{
   "Arn": "string",
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

Arn

L'ARN que vous avez spécifié pour répertorier les balises.

Type : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Modèle : arn:\S+

NextToken

Lorsque vous pouvez obtenir des résultats supplémentaires à partir de l'ListTagsForResourceappel, un NextToken paramètre est renvoyé dans la sortie. Vous pouvez ensuite passer une commande suivante au NextToken paramètre pour continuer à répertorier les balises supplémentaires.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.

Tags

Paires clé-valeur attribuées à une ressource, généralement dans le but de regrouper et de rechercher des éléments. Les balises sont des métadonnées que vous définissez.

Type : tableau d’objets Tag

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalServiceError

Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.

Code d’état HTTP : 500

InvalidNextTokenException

Le NextToken paramètre transmis n'est pas valide.

Code d’état HTTP : 400

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

Exemples

Exemple

L'exemple suivant répertorie les balises de la ressource avec l'ARN que vous avez spécifié.

Exemple de demande


{
   "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef"
}

Exemple

Cet exemple illustre une utilisation de ListTagsForResource.

Exemple de réponse


{
   "Tags": [ 
      { 
         "Key": "Name",
         "Value": "MyServer"
      }
   ]
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :