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.

# ListBucket (API SOAP)
<a name="SOAPListBucket"></a>

**Note**  
 Les SOAP API pour Amazon S3 ne sont pas disponibles pour les nouveaux clients. Leur fin de vie est prévue le 31 août 2025. Nous vous recommandons d'utiliser l'API REST ou les AWS SDK. 

 L'`ListBucket`opération renvoie des informations sur certains éléments du compartiment. 

 Pour une présentation générale du fonctionnement de la liste, consultez la section Clés des objets de [ liste](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html).

## Requêtes
<a name="SOAPBucketGET_Request"></a>

Cet exemple répertorie jusqu'à 1 000 clés dans le compartiment « guillemets » qui ont le préfixe « notes ».

### Syntaxe
<a name="SOAPBucketGET_RequestSyntax"></a>

```
1. <ListBucket xmlns="https://doc.s3.amazonaws.com/2006-03-01">
2.   <Bucket>quotes</Bucket>
3.   <Prefix>notes/</Prefix>
4.   <Delimiter>/</Delimiter>
5.   <MaxKeys>1000</MaxKeys>
6.   <AWSAccessKeyId>AKIAIOSFODNN7EXAMPLE</AWSAccessKeyId>
7.   <Timestamp>2006-03-01T12:00:00.183Z</Timestamp>
8.   <Signature>Iuyz3d3P0aTou39dzbqaEXAMPLE=</Signature>
9. </ListBucket>
```

### Paramètres
<a name="SOAPBucketGET_RequestHeaders"></a>


|  Nom  |  Description  |  Obligatoire  | 
| --- | --- | --- | 
|  prefix  | Limite la réponse aux touches commençant par le préfixe indiqué. Vous pouvez utiliser des préfixes pour séparer un compartiment en différents ensembles de clés de la même manière qu'un système de fichiers utilise les dossiers.<br />Type : Chaîne<br />Par défaut : aucun |  Non  | 
|  marker  | Indique où commencer la mise en vente dans le compartiment. La liste inclura uniquement les clés qui apparaissent lexicographiquement après le marqueur. C'est pratique pour la pagination : pour obtenir la page de résultats suivante, utilisez la dernière touche de la page en cours comme marqueur.<br />Type : Chaîne<br />Par défaut : aucun |  Non  | 
|  max-keys  | Le nombre maximum de touches que vous souhaitez voir apparaître dans le corps de la réponse. Le serveur peut renvoyer un nombre inférieur à ce nombre de clés, mais il n'en renverra pas plus.<br />Type : Chaîne<br />Par défaut : aucun |  Non  | 
|  delimiter  | Fait en sorte que les clés contenant la même chaîne entre le préfixe et la première occurrence du délimiteur soient regroupées en un seul élément de résultat de la CommonPrefixes collection. Ces clés enroulées ne sont pas renvoyées ailleurs dans la réponse.<br />Type : Chaîne<br />Par défaut : aucun |  Non  | 

## Réponse réussie
<a name="SOAPBucketGET_ResponseSuccess"></a>

Cette réponse suppose que le compartiment contient les clés suivantes :

```
1. notes/todos.txt
2. notes/2005-05-23/customer_mtg_notes.txt
3. notes/2005-05-23/phone_notes.txt
4. notes/2005-05-28/sales_notes.txt
```

### Syntaxe
<a name="SOAPBucketGET_ResponseSuccess-syntax"></a>

```
 1. <?xml version="1.0" encoding="UTF-8"?>
 2. <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
 3.   <Name>backups</Name>
 4.   <Prefix>notes/</Prefix>
 5.   <MaxKeys>1000</MaxKeys>
 6.   <Delimiter>/</Delimiter>
 7.   <IsTruncated>false</IsTruncated>
 8.   <Contents>
 9.     <Key>notes/todos.txt</Key>
10.     <LastModified>2006-01-01T12:00:00.000Z</LastModified>
11.     <ETag>&quot;828ef3fdfa96f00ad9f27c383fc9ac7f&quot;</ETag>
12.     <Size>5126</Size>
13.     <StorageClass>STANDARD</StorageClass>
14.     <Owner>
15.       <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
16.       <DisplayName>webfile</DisplayName>
17.     </Owner>
18.     <StorageClass>STANDARD</StorageClass>
19.   </Contents>
20.   <CommonPrefixes>
21.     <Prefix>notes/2005-05-23/</Prefix>
22.   </CommonPrefixes>
23.   <CommonPrefixes>
24.     <Prefix>notes/2005-05-28/</Prefix>
25.   </CommonPrefixes>
26.   </ListBucketResult>
```

Comme vous pouvez le constater, de nombreux champs de la réponse font écho aux paramètres de la demande. `IsTruncated``Contents`, et `CommonPrefixes` sont les seuls éléments de réponse qui peuvent contenir de nouvelles informations.

### Éléments de réponse
<a name="SOAPBucketGET_ResponseSuccess-response-elements"></a>


|  Nom  |  Description  | 
| --- | --- | 
|  Contents  | Métadonnées relatives à chaque objet renvoyé.<br />Type : métadonnées XML<br />Ancêtre : ListBucketResult | 
|  CommonPrefixes  |  Une réponse ne peut contenir `CommonPrefixes` que si vous spécifiez un`delimiter`. Lorsque vous le faites, `CommonPrefixes` contient toutes les clés (le cas échéant) comprises entre `Prefix` la prochaine occurrence de la chaîne spécifiée par`delimiter`. En fait, `CommonPrefixes` répertorie les clés qui agissent comme des sous-répertoires dans le répertoire spécifié par`Prefix`. Par exemple, si `prefix` est `notes/` et `delimiter` est une barre oblique (/), dans`notes/summer/july`, le préfixe commun est. `notes/summer/` <br />Type : Chaîne<br />Ancêtre : ListBucketResult | 
|  Delimiter  | Fait en sorte que les clés contenant la même chaîne entre le préfixe et la première occurrence du délimiteur soient regroupées en un seul élément de résultat de la CommonPrefixes collection. Ces clés enroulées ne sont pas renvoyées ailleurs dans la réponse.<br />Type : Chaîne<br />Ancêtre : ListBucketResult | 
|  IsTruncated  | Spécifie si (vrai) ou non (faux) tous les résultats ont été renvoyés. Tous les résultats peuvent ne pas être renvoyés si le nombre de résultats dépasse celui spécifié par`MaxKeys`.<br />Type : Chaîne<br />Ancêtre : booléen | 
|  Marker  | Indique où commencer la mise en vente dans le compartiment.<br />Type : Chaîne<br />Ancêtre : ListBucketResult | 
|  MaxKeys  | Le nombre maximum de clés renvoyées dans le corps de la réponse.<br />Type : Chaîne<br />Ancêtre : ListBucketResult | 
|  Name  | Nom du seau.<br />Type : Chaîne<br />Ancêtre : ListBucketResult | 
|  Prefix  | Clés commençant par le préfixe indiqué.<br />Type : Chaîne<br />Ancêtre : ListBucketResult | 

## Corps de la réponse
<a name="SOAPListBucketResponseBody"></a>

 Pour plus d'informations sur la réponse de la liste, voir [ Listing Keys Response](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html). 

## Contrôle d’accès
<a name="SOAPListBucketAccessControl"></a>

Pour répertorier les clés d'un compartiment, vous devez avoir obtenu l'autorisation d'`READ`y accéder.