Cette documentation concerne AWS CLI uniquement la version 1. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.

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.

Utilisation des options de pagination dans l’AWS CLI

Cette rubrique décrit les différentes façons de paginer la sortie de l’AWS Command Line Interface (AWS CLI).

Pagination côté serveur

Pour la plupart des commandes qui peuvent renvoyer une longue liste d’éléments, l’AWS CLI ajoute plusieurs options côté serveur pour contrôler le nombre d’éléments inclus dans la sortie lorsque l’AWS CLI appelle une API de service pour remplir la liste. La pagination côté serveur dans l’AWS CLI est activée par l’API de service AWS. Par conséquent, ces options ne fonctionnent que si l’API de service les active.

Par défaut, l’AWS CLI utilise une taille de page déterminée par le service individuel et extrait tous les éléments disponibles. Par exemple, Amazon S3 a une taille de page par défaut de 1 000. Si vous exécutez le code aws s3api list-objects sur un compartiment S3 qui contient 3 500 objets, l’AWS CLI effectue quatre appels à Amazon S3, en gérant la logique de pagination spécifique à un service en arrière-plan et en envoyant tous les 3 500 objets dans la sortie finale.

Pour savoir si une commande spécifique possède une pagination côté serveur, consultez le guide de référence de l’AWS CLI.

Utilisation du paramètre --no-paginate

L’option --no-paginate désactive les jetons de pagination suivants côté client. Lorsque de l’utilisation d’une commande, par défaut, l’AWS CLI effectue automatiquement plusieurs appels pour renvoyer tous les résultats possibles afin de créer la pagination. Un appel par page. La désactivation de la pagination fait en sorte que l’AWS CLI n’appelle qu’une seule fois pour obtenir la première page des résultats de la commande.

Par exemple, si vous exécutez aws s3api list-objects sur un compartiment Amazon S3 qui contient 3 500 objets, l’AWS CLI n’effectue que le premier appel à Amazon S3, renvoyant uniquement les 1 000 premiers objets dans la sortie finale.

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --no-paginate
{
    "Contents": [
...

Utilisation du paramètre --page-size

Si vous constatez des problèmes lors de l’exécution de commandes de liste sur un grand nombre de ressources, la taille de page par défaut peut être trop élevée. Cela peut entraîner des appels vers des services AWS dépassant le délai maximum autorisé et générer une erreur « expirée ». Vous pouvez utiliser l’option --page-size pour spécifier que l’AWS CLI demande un plus petit nombre d’éléments de chaque appel au service AWS. L’AWS CLI extrait toujours la liste complète, mais elle effectue un plus grand nombre d’appels d’API de service en arrière-plan, et extraie un plus petit nombre d’éléments à chaque appel. Cela donne aux appels individuels une plus grande chance de réussite sans délai d’expiration. Modifier la taille de la page n’affecte pas la sortie ; cela affecte uniquement le nombre d’appels d’API qui doivent être effectués pour générer la sortie.

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --page-size 100
{
    "Contents": [
...

Utilisation du paramètre --max-items

Pour inclure moins d’éléments à la fois dans la sortie d’iAWS CLI, utilisez l’option --max-items. L’AWS CLI gère toujours la pagination avec le service comme décrite ci-dessus, mais imprime uniquement le nombre d’éléments à un instant que vous spécifiez.

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --max-items 100
{
    "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ==",
    "Contents": [
...

Utilisation du paramètre --starting-token

Si le nombre d’éléments en sortie (--max-items) est inférieur au nombre total d’éléments renvoyés par les appels d’API sous-jacents, la sortie inclut un code NextToken que vous pouvez transmettre dans une commande suivante pour récupérer le prochain ensemble d’éléments. L’exemple suivant montre comment utiliser la valeur NextToken renvoyée par l’exemple précédent et vous permet de récupérer la deuxième centaine d’éléments.

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --max-items 100 \
    --starting-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ==
{
    "Contents": [
...

Le service AWS spécifié peut renvoyer des éléments dans un ordre différent à chaque fois que vous appelez. Si vous spécifiez des valeurs différentes pour les codes --page-size et --max-items, vous pouvez obtenir des résultats inattendus avec des éléments manquants ou des doublons. Pour empêcher que cela ne se produise, utilisez le même nombre pour les codes --page-size et --max-items, afin de synchroniser la pagination de l’AWS CLI et celle du service sous-jacent. Vous pouvez également extraire la liste complète et exécuter les opérations de pagination nécessaires localement.