(PHP Extension) DynamoDB - DescribeTable

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

For more information, see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

$rest = new CkRest();

// Implements the following CURL command:

// curl -X POST https://dynamodb.us-west-2.amazonaws.com/ \
//   -H "Accept-Encoding: identity" \
//   -H "Content-Type: application/x-amz-json-1.0" \
//   -H "Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>" \
//   -H "X-Amz-Date: <Date>" \
//   -H "X-Amz-Target: DynamoDB_20120810.DescribeTable" \
//   -d '{
//     "TableName":"Thread"
// }'

// Use the following online tool to generate REST code from a CURL command
// Convert a cURL Command to REST Source Code

$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');
// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('dynamodb');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://dynamodb.us-west-2.amazonaws.com/
$bTls = true;
$port = 443;
$bAutoReconnect = true;
// Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
$success = $rest->Connect('dynamodb.us-west-2.amazonaws.com',$port,$bTls,$bAutoReconnect);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

// Note: The above code does not need to be repeatedly called for each REST request.
// The rest object can be setup once, and then many requests can be sent.  Chilkat will automatically
// reconnect within a FullRequest* method as needed.  It is only the very first connection that is explicitly
// made via the Connect method.

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "TableName": "Thread"
// }

$json = new CkJsonObject();
$json->UpdateString('TableName','Thread');

$rest->AddHeader('Content-Type','application/x-amz-json-1.0');
$rest->AddHeader('X-Amz-Target','DynamoDB_20120810.DescribeTable');
$rest->AddHeader('Accept-Encoding','identity');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('POST','/',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Status Code = ' . $respStatusCode . "\n";
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jsonResponse = new CkJsonObject();
$jsonResponse->LoadSb($sbResponseBody);

$jsonResponse->put_EmitCompact(false);
print $jsonResponse->emit() . "\n";

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "Table": {
//     "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
//     "AttributeDefinitions": [
//       {
//         "AttributeName": "ForumName",
//         "AttributeType": "S"
//       },
//       {
//         "AttributeName": "LastPostDateTime",
//         "AttributeType": "S"
//       },
//       {
//         "AttributeName": "Subject",
//         "AttributeType": "S"
//       }
//     ],
//     "CreationDateTime": 1.363729002358E9,
//     "ItemCount": 0,
//     "KeySchema": [
//       {
//         "AttributeName": "ForumName",
//         "KeyType": "HASH"
//       },
//       {
//         "AttributeName": "Subject",
//         "KeyType": "RANGE"
//       }
//     ],
//     "LocalSecondaryIndexes": [
//       {
//         "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread/index/LastPostIndex",
//         "IndexName": "LastPostIndex",
//         "IndexSizeBytes": 0,
//         "ItemCount": 0,
//         "KeySchema": [
//           {
//             "AttributeName": "ForumName",
//             "KeyType": "HASH"
//           },
//           {
//             "AttributeName": "LastPostDateTime",
//             "KeyType": "RANGE"
//           }
//         ],
//         "Projection": {
//           "ProjectionType": "KEYS_ONLY"
//         }
//       }
//     ],
//     "ProvisionedThroughput": {
//       "NumberOfDecreasesToday": 0,
//       "ReadCapacityUnits": 5,
//       "WriteCapacityUnits": 5
//     },
//     "TableName": "Thread",
//     "TableSizeBytes": 0,
//     "TableStatus": "ACTIVE"
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$TableTableArn = $jsonResponse->stringOf('Table.TableArn');
$TableCreationDateTime = $jsonResponse->stringOf('Table.CreationDateTime');
$TableItemCount = $jsonResponse->IntOf('Table.ItemCount');
$TableProvisionedThroughputNumberOfDecreasesToday = $jsonResponse->IntOf('Table.ProvisionedThroughput.NumberOfDecreasesToday');
$TableProvisionedThroughputReadCapacityUnits = $jsonResponse->IntOf('Table.ProvisionedThroughput.ReadCapacityUnits');
$TableProvisionedThroughputWriteCapacityUnits = $jsonResponse->IntOf('Table.ProvisionedThroughput.WriteCapacityUnits');
$TableTableName = $jsonResponse->stringOf('Table.TableName');
$TableTableSizeBytes = $jsonResponse->IntOf('Table.TableSizeBytes');
$TableTableStatus = $jsonResponse->stringOf('Table.TableStatus');
$i = 0;
$count_i = $jsonResponse->SizeOfArray('Table.AttributeDefinitions');
while ($i < $count_i) {
    $jsonResponse->put_I($i);
    $AttributeName = $jsonResponse->stringOf('Table.AttributeDefinitions[i].AttributeName');
    $AttributeType = $jsonResponse->stringOf('Table.AttributeDefinitions[i].AttributeType');
    $i = $i + 1;
}

$i = 0;
$count_i = $jsonResponse->SizeOfArray('Table.KeySchema');
while ($i < $count_i) {
    $jsonResponse->put_I($i);
    $AttributeName = $jsonResponse->stringOf('Table.KeySchema[i].AttributeName');
    $KeyType = $jsonResponse->stringOf('Table.KeySchema[i].KeyType');
    $i = $i + 1;
}

$i = 0;
$count_i = $jsonResponse->SizeOfArray('Table.LocalSecondaryIndexes');
while ($i < $count_i) {
    $jsonResponse->put_I($i);
    $IndexArn = $jsonResponse->stringOf('Table.LocalSecondaryIndexes[i].IndexArn');
    $IndexName = $jsonResponse->stringOf('Table.LocalSecondaryIndexes[i].IndexName');
    $IndexSizeBytes = $jsonResponse->IntOf('Table.LocalSecondaryIndexes[i].IndexSizeBytes');
    $ItemCount = $jsonResponse->IntOf('Table.LocalSecondaryIndexes[i].ItemCount');
    $ProjectionProjectionType = $jsonResponse->stringOf('Table.LocalSecondaryIndexes[i].Projection.ProjectionType');
    $j = 0;
    $count_j = $jsonResponse->SizeOfArray('Table.LocalSecondaryIndexes[i].KeySchema');
    while ($j < $count_j) {
        $jsonResponse->put_J($j);
        $AttributeName = $jsonResponse->stringOf('Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName');
        $KeyType = $jsonResponse->stringOf('Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>