DescribeTables - Amazon DynamoDB
説明リクエストレスポンス特殊なエラー例関連アクション

DescribeTables

重要

このセクションでは、API バージョン 2011-12-05 について言及しています。これは非推奨なので、新しいアプリケーションに使用しないでください。

現在の低レベルの API に関するドキュメントについては、Amazon DynamoDB API リファレンスを参照してください。

説明

テーブルに関する情報 (テーブルの現在のステータス、プライマリキーのスキーマ、テーブルが作成された日時など) を返します。DescribeTable の結果は結果整合性です。テーブル作成のプロセスで DescribeTable を使用するタイミングが早すぎる場合、DynamoDB は ResourceNotFoundException を返します。テーブル更新のプロセスで DescribeTable を使用するタイミングが早すぎる場合、新しい値がすぐに使用できないことがあります。

リクエスト

構文

// This header is abbreviated. 
// For a sample of a complete header, see DynamoDB 低レベル API.
POST / HTTP/1.1 
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0

{"TableName":"Table1"}
名前 説明 必須
TableName

説明するテーブルの名前。

型: 文字列

はい

レスポンス

構文

HTTP/1.1 200 
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
Content-Length: 543


{"Table":
    {"CreationDateTime":1.309988345372E9,
    ItemCount:1,
    "KeySchema":
        {"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"},
        "RangeKeyElement":{"AttributeName":"AttributeName2","AttributeType":"N"}},
    "ProvisionedThroughput":{"LastIncreaseDateTime": Date, "LastDecreaseDateTime": Date, "ReadCapacityUnits":10,"WriteCapacityUnits":10},
    "TableName":"Table1",
    "TableSizeBytes":1,
    "TableStatus":"ACTIVE"
    }
}
名前 説明
Table

記述されているテーブルのコンテナ。

型: 文字列
CreationDateTime テーブルの作成日 (UNIX エポック時間)。
ItemCount

指定されたテーブルに含まれる項目の数。DynamoDB は、この値を約 6 時間ごとに更新します。最近の変更は、この値に反映されないことがあります。

型: 数値
KeySchema テーブルのプライマリキー (シンプルまたは複合) 構造。HashKeyElement の名前と値のペアは必須です。RangeKeyElement の名前と値のペアはオプションです (複合プライマリキーにのみ必要)。ハッシュキーの最大サイズは 2048 バイトです。範囲キーの最大サイズは 1024 バイトです。両方の制限は別々に強制されます (ハッシュと範囲の合計で 2048 + 1024 キーを組み合わせることができます)。プライマリキーの詳細については、「プライマリキー」を参照してください。
ProvisionedThroughput 指定されたテーブルのスループット。LastIncreaseDateTime (該当する場合)、LastDecreaseDateTime (該当する場合)、ReadCapacityUnits、および WriteCapacityUnits で構成されます。テーブルのスループットが増減したことがない場合、DynamoDB はこれらの要素の値を返しません。「DynamoDB プロビジョンドキャパシティモード」を参照してください。

型: 配列

TableName

リクエストされたテーブルの名前。

型: 文字列
TableSizeBytes

指定されたテーブルの合計サイズ (バイト単位)。DynamoDB は、この値を約 6 時間ごとに更新します。最近の変更は、この値に反映されないことがあります。

型: 数値
TableStatus テーブルの現在の状態 (CREATING、ACTIVE、DELETING、または UPDATING)。テーブルが ACTIVE の状態になったらデータを追加できます。

特殊なエラー

このオペレーションに固有のエラーはありません。

例

次の例は、「comp-table」という名前のテーブルに対する DescribeTable オペレーションを使用した HTTP POST リクエストとレスポンスを示しています。テーブルには複合プライマリキーがあります。

リクエスト例

// This header is abbreviated. 
// For a sample of a complete header, see DynamoDB 低レベル API.
POST / HTTP/1.1 
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0

{"TableName":"users"}

レスポンス例

HTTP/1.1 200 
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 543

{"Table":
    {"CreationDateTime":1.309988345372E9,
    "ItemCount":23,
    "KeySchema":
        {"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
        "RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
    "ProvisionedThroughput":{"LastIncreaseDateTime": 1.309988345384E9, "ReadCapacityUnits":10,"WriteCapacityUnits":10},
    "TableName":"users",
    "TableSizeBytes":949,
    "TableStatus":"ACTIVE"
    }
}