View a markdown version of this page

ListBucket (SOAP API) - Amazon Simple Storage Service
リクエスト成功時のレスポンスレスポンス本文アクセスコントロール

ListBucket (SOAP API)

注記

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

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

リストオペレーションの一般的な概要については、「オブジェクトキーのリスト化」を参照してください。

リクエスト

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

構文

<ListBucket xmlns="https://doc.s3.amazonaws.com/2006-03-01">
  <Bucket>quotes</Bucket>
  <Prefix>notes/</Prefix>
  <Delimiter>/</Delimiter>
  <MaxKeys>1000</MaxKeys>
  <AWSAccessKeyId>AKIAIOSFODNN7EXAMPLE</AWSAccessKeyId>
  <Timestamp>2006-03-01T12:00:00.183Z</Timestamp>
  <Signature>Iuyz3d3P0aTou39dzbqaEXAMPLE=</Signature>
</ListBucket>

パラメータ

名前 説明 必須
prefix

指定されたプレフィックスで始まるキーのみにレスポンスを制限します。プレフィックスを使用すると、ファイルシステムがフォルダを使用するのと同様の方法で、バケットを異なるキーセットに分割できます。

タイプ: 文字列

デフォルト: なし

 いいえ
marker

バケット内でリスト表示を開始する場所を示します。リストには、マーカーの後に辞書順で出現するキーのみが含まれます。これはページ分割に便利です。結果の次のページを取得するには、現在のページの最後のキーをマーカーとして使用します。

タイプ: 文字列

デフォルト: なし

 いいえ
max-keys

レスポンス本文に表示するキーの最大数。サーバーは、この数よりも少ないキーを返す場合がありますが、それ以上の数は返しません。

タイプ: 文字列

デフォルト: なし

 いいえ
delimiter

プレフィックスと区切り文字の最初の出現箇所の間に同じ文字列を含むキーを、CommonPrefixes コレクション内の単一の結果要素にロールアップします。ロールアップされたこれらのキーは、レスポンスの他の箇所では返されません。

タイプ: 文字列

デフォルト: なし

 いいえ

成功時のレスポンス

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

notes/todos.txt
notes/2005-05-23/customer_mtg_notes.txt
notes/2005-05-23/phone_notes.txt
notes/2005-05-28/sales_notes.txt

構文

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Name>backups</Name>
  <Prefix>notes/</Prefix>
  <MaxKeys>1000</MaxKeys>
  <Delimiter>/</Delimiter>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>notes/todos.txt</Key>
    <LastModified>2006-01-01T12:00:00.000Z</LastModified>
    <ETag>&quot;828ef3fdfa96f00ad9f27c383fc9ac7f&quot;</ETag>
    <Size>5126</Size>
    <StorageClass>STANDARD</StorageClass>
    <Owner>
      <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
      <DisplayName>webfile</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
  <CommonPrefixes>
    <Prefix>notes/2005-05-23/</Prefix>
  </CommonPrefixes>
  <CommonPrefixes>
    <Prefix>notes/2005-05-28/</Prefix>
  </CommonPrefixes>
  </ListBucketResult>

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

レスポンス要素

名前 説明
Contents

返された各オブジェクトに関するメタデータ。

型: XML メタデータ

祖先: ListBucketResult
CommonPrefixes

delimiter を指定した場合のみ、レスポンスに CommonPrefixes を含めることができます。これを行うと、CommonPrefixes には、Prefix と delimiter で指定された文字列の次の出現箇所との間のすべてのキー (存在する場合) が含まれます。実際には、CommonPrefixes は Prefix で指定されたディレクトリ内のサブディレクトリのように動作するキーを一覧表示します。例えば、prefix が notes/ で、delimiter がスラッシュ (/) の場合、notes/summer/july では、共通プレフィックスは notes/summer/ です。

タイプ: 文字列

祖先: ListBucketResult
Delimiter

プレフィックスと区切り文字の最初の出現箇所の間に同じ文字列を含むキーを、CommonPrefixes コレクション内の単一の結果要素にロールアップします。ロールアップされたこれらのキーは、レスポンスの他の箇所では返されません。

タイプ: 文字列

祖先: ListBucketResult
IsTruncated

すべての結果が返されたか (true) または返されなかったか (false) どうかを指定します。結果の数が MaxKeys で指定した数を超えた場合、すべての結果が返されないことがあります。

タイプ: 文字列

祖先: boolean
Marker

バケット内でリスト表示を開始する場所を示します。

タイプ: 文字列

祖先: ListBucketResult
MaxKeys

レスポンス本文で返されるキーの最大数。

タイプ: 文字列

祖先: ListBucketResult
Name

バケットの名前。

タイプ: 文字列

祖先: ListBucketResult
Prefix

指定されたプレフィックスで始まるキー。

タイプ: 文字列

祖先: ListBucketResult

レスポンス本文

リストレスポンスの詳細については、「キーレスポンスのリスト化」を参照してください。

アクセスコントロール

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