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

**注記**  
 SOAP API for Amazon S3 は新規顧客には利用できず、2025 年 8 月 31 日にサポート終了 (EOL) となります。REST API か AWS SDK を使用することをお勧めします。

 `ListBucket` オペレーションは、バケット内の一部の項目に関する情報を返します。

 リストオペレーションの一般的な概要については、「[オブジェクトキーのリスト化](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)」を参照してください。

## リクエスト
<a name="SOAPBucketGET_Request"></a>

この例では、プレフィックス「notes」を持つ「quotes」バケット内のキー最大 1,000 個まで一覧表示します。

### 構文
<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>
```

### パラメータ
<a name="SOAPBucketGET_RequestHeaders"></a>


|  名前  |  説明  |  必須  | 
| --- | --- | --- | 
|  prefix  | 指定されたプレフィックスで始まるキーのみにレスポンスを制限します。プレフィックスを使用すると、ファイルシステムがフォルダを使用するのと同様の方法で、バケットを異なるキーセットに分割できます。<br />タイプ: 文字列<br />デフォルト: なし |  いいえ  | 
|  marker  | バケット内でリスト表示を開始する場所を示します。リストには、マーカーの後に辞書順で出現するキーのみが含まれます。これはページ分割に便利です。結果の次のページを取得するには、現在のページの最後のキーをマーカーとして使用します。<br />タイプ: 文字列<br />デフォルト: なし |  いいえ  | 
|  max-keys  | レスポンス本文に表示するキーの最大数。サーバーは、この数よりも少ないキーを返す場合がありますが、それ以上の数は返しません。<br />タイプ: 文字列<br />デフォルト: なし |  いいえ  | 
|  delimiter  | プレフィックスと区切り文字の最初の出現箇所の間に同じ文字列を含むキーを、CommonPrefixes コレクション内の単一の結果要素にロールアップします。ロールアップされたこれらのキーは、レスポンスの他の箇所では返されません。<br />タイプ: 文字列<br />デフォルト: なし |  いいえ  | 

## 成功時のレスポンス
<a name="SOAPBucketGET_ResponseSuccess"></a>

このレスポンスは、バケットに次のキーが含まれていることを前提としています。

```
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
```

### 構文
<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>
```

ご覧のとおり、レスポンスの多くのフィールドはリクエストパラメータをエコーします。`IsTruncated`、`Contents`、および `CommonPrefixes` は、新しい情報を含めることができる唯一のレスポンス要素です。

### レスポンス要素
<a name="SOAPBucketGET_ResponseSuccess-response-elements"></a>


|  名前  |  説明  | 
| --- | --- | 
|  Contents  | 返された各オブジェクトに関するメタデータ。<br />型: XML メタデータ<br />祖先: ListBucketResult | 
|  CommonPrefixes  |  `delimiter` を指定した場合のみ、レスポンスに `CommonPrefixes` を含めることができます。これを行うと、`CommonPrefixes` には、`Prefix` と `delimiter` で指定された文字列の次の出現箇所との間のすべてのキー (存在する場合) が含まれます。実際には、`CommonPrefixes` は `Prefix` で指定されたディレクトリ内のサブディレクトリのように動作するキーを一覧表示します。例えば、`prefix` が `notes/` で、`delimiter` がスラッシュ (/) の場合、`notes/summer/july` では、共通プレフィックスは `notes/summer/` です。<br />タイプ: 文字列<br />祖先: ListBucketResult | 
|  Delimiter  | プレフィックスと区切り文字の最初の出現箇所の間に同じ文字列を含むキーを、CommonPrefixes コレクション内の単一の結果要素にロールアップします。ロールアップされたこれらのキーは、レスポンスの他の箇所では返されません。<br />タイプ: 文字列<br />祖先: ListBucketResult | 
|  IsTruncated  | すべての結果が返されたか (true) または返されなかったか (false) どうかを指定します。結果の数が `MaxKeys` で指定した数を超えた場合、すべての結果が返されないことがあります。<br />タイプ: 文字列<br />祖先: boolean | 
|  Marker  | バケット内でリスト表示を開始する場所を示します。<br />タイプ: 文字列<br />祖先: ListBucketResult | 
|  MaxKeys  | レスポンス本文で返されるキーの最大数。<br />タイプ: 文字列<br />祖先: ListBucketResult | 
|  Name  | バケットの名前。<br />タイプ: 文字列<br />祖先: ListBucketResult | 
|  Prefix  | 指定されたプレフィックスで始まるキー。<br />タイプ: 文字列<br />祖先: ListBucketResult | 

## レスポンス本文
<a name="SOAPListBucketResponseBody"></a>

 リストレスポンスの詳細については、「[キーレスポンスのリスト化](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)」を参照してください。

## アクセスコントロール
<a name="SOAPListBucketAccessControl"></a>

バケットのキーを一覧表示するには、そのバケットに対する `READ` アクセス権が付与されている必要があります。