React Native

DynamoDB - DescribeTable

See more Amazon DynamoDB Examples

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. React Native

import { AuthAws, JsonObject, Rest, StringBuilder } from '@chilkat/react-native'

async function chilkatExample() {
  const rest = new Rest();

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

  const authAws = new AuthAws();
  authAws.accessKey = 'AWS_ACCESS_KEY';
  authAws.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.region = 'us-west-2';
  authAws.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/
  const bTls = true;
  const port = 443;
  const bAutoReconnect = true;
  // Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
  try {
    await rest.connectAsync('dynamodb.us-west-2.amazonaws.com', port, bTls, bAutoReconnect);
  } catch {
    console.log(`ConnectFailReason: ${rest.connectFailReason}`);
    console.log(rest.lastErrorText);
    return;
  }

  // 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"
  // }

  const json = new JsonObject();
  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');

  const sbRequestBody = new StringBuilder();
  json.emitSb(sbRequestBody);
  const sbResponseBody = new StringBuilder();
  try {
    await rest.fullRequestSbAsync('POST', '/', sbRequestBody, sbResponseBody);
  } catch {
    console.log(rest.lastErrorText);
    return;
  }

  const respStatusCode = rest.responseStatusCode;
  console.log(`response status code = ${respStatusCode}`);
  if (respStatusCode >= 400) {
    console.log(`Response Status Code = ${respStatusCode}`);
    console.log('Response Header:');
    console.log(rest.responseHeader);
    console.log('Response Body:');
    console.log(sbResponseBody.getAsString());
    return;
  }

  const jsonResponse = new JsonObject();
  jsonResponse.loadSb(sbResponseBody);

  jsonResponse.emitCompact = false;
  console.log(jsonResponse.emit());

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

  let attributeName = '';
  let attributeType = '';
  let keyType = '';
  let indexArn = '';
  let indexName = '';
  let indexSizeBytes = 0;
  let itemCount = 0;
  let projectionProjectionType = '';
  let j = 0;
  let countJ = 0;

  const tableTableArn = jsonResponse.stringOf('Table.TableArn');
  const tableCreationDateTime = jsonResponse.stringOf('Table.CreationDateTime');
  const tableItemCount = jsonResponse.intOf('Table.ItemCount');
  const tableProvisionedThroughputNumberOfDecreasesToday = jsonResponse.intOf('Table.ProvisionedThroughput.NumberOfDecreasesToday');
  const tableProvisionedThroughputReadCapacityUnits = jsonResponse.intOf('Table.ProvisionedThroughput.ReadCapacityUnits');
  const tableProvisionedThroughputWriteCapacityUnits = jsonResponse.intOf('Table.ProvisionedThroughput.WriteCapacityUnits');
  const tableTableName = jsonResponse.stringOf('Table.TableName');
  const tableTableSizeBytes = jsonResponse.intOf('Table.TableSizeBytes');
  const tableTableStatus = jsonResponse.stringOf('Table.TableStatus');
  let i = 0;
  let countI = jsonResponse.sizeOfArray('Table.AttributeDefinitions');
  while (i < countI) {
    jsonResponse.i = i;
    attributeName = jsonResponse.stringOf('Table.AttributeDefinitions[i].AttributeName');
    attributeType = jsonResponse.stringOf('Table.AttributeDefinitions[i].AttributeType');
    i++;
  }

  i = 0;
  countI = jsonResponse.sizeOfArray('Table.KeySchema');
  while (i < countI) {
    jsonResponse.i = i;
    attributeName = jsonResponse.stringOf('Table.KeySchema[i].AttributeName');
    keyType = jsonResponse.stringOf('Table.KeySchema[i].KeyType');
    i++;
  }

  i = 0;
  countI = jsonResponse.sizeOfArray('Table.LocalSecondaryIndexes');
  while (i < countI) {
    jsonResponse.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;
    countJ = jsonResponse.sizeOfArray('Table.LocalSecondaryIndexes[i].KeySchema');
    while (j < countJ) {
      jsonResponse.j = j;
      attributeName = jsonResponse.stringOf('Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName');
      keyType = jsonResponse.stringOf('Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType');
      j++;
    }

    i++;
  }
}