(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoRest.h>
#import <CkoAuthAws.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

CkoRest *rest = [[CkoRest alloc] init];
BOOL success;

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

CkoAuthAws *authAws = [[CkoAuthAws alloc] init];
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/
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
// 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: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@%d",@"ConnectFailReason: ",[rest.ConnectFailReason intValue]);
    NSLog(@"%@",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"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"TableName" value: @"Thread"];

[rest AddHeader: @"Content-Type" value: @"application/x-amz-json-1.0"];
[rest AddHeader: @"X-Amz-Target" value: @"DynamoDB_20120810.DescribeTable"];
[rest AddHeader: @"Accept-Encoding" value: @"identity"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

int respStatusCode = [rest.ResponseStatusCode intValue];
NSLog(@"%@%d",@"response status code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",rest.ResponseHeader);
    NSLog(@"%@",@"Response Body:");
    NSLog(@"%@",[sbResponseBody GetAsString]);
    return;
}

CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
[jsonResponse LoadSb: sbResponseBody];

jsonResponse.EmitCompact = NO;
NSLog(@"%@",[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

NSString *AttributeName = 0;
NSString *AttributeType = 0;
NSString *KeyType = 0;
NSString *IndexArn = 0;
NSString *IndexName = 0;
int IndexSizeBytes;
int ItemCount;
NSString *ProjectionProjectionType = 0;
int j;
int count_j;

NSString *TableTableArn = [jsonResponse StringOf: @"Table.TableArn"];
NSString *TableCreationDateTime = [jsonResponse StringOf: @"Table.CreationDateTime"];
int TableItemCount = [[jsonResponse IntOf: @"Table.ItemCount"] intValue];
int TableProvisionedThroughputNumberOfDecreasesToday = [[jsonResponse IntOf: @"Table.ProvisionedThroughput.NumberOfDecreasesToday"] intValue];
int TableProvisionedThroughputReadCapacityUnits = [[jsonResponse IntOf: @"Table.ProvisionedThroughput.ReadCapacityUnits"] intValue];
int TableProvisionedThroughputWriteCapacityUnits = [[jsonResponse IntOf: @"Table.ProvisionedThroughput.WriteCapacityUnits"] intValue];
NSString *TableTableName = [jsonResponse StringOf: @"Table.TableName"];
int TableTableSizeBytes = [[jsonResponse IntOf: @"Table.TableSizeBytes"] intValue];
NSString *TableTableStatus = [jsonResponse StringOf: @"Table.TableStatus"];
int i = 0;
int count_i = [[jsonResponse SizeOfArray: @"Table.AttributeDefinitions"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: 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"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: 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"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: i];
    IndexArn = [jsonResponse StringOf: @"Table.LocalSecondaryIndexes[i].IndexArn"];
    IndexName = [jsonResponse StringOf: @"Table.LocalSecondaryIndexes[i].IndexName"];
    IndexSizeBytes = [[jsonResponse IntOf: @"Table.LocalSecondaryIndexes[i].IndexSizeBytes"] intValue];
    ItemCount = [[jsonResponse IntOf: @"Table.LocalSecondaryIndexes[i].ItemCount"] intValue];
    ProjectionProjectionType = [jsonResponse StringOf: @"Table.LocalSecondaryIndexes[i].Projection.ProjectionType"];
    j = 0;
    count_j = [[jsonResponse SizeOfArray: @"Table.LocalSecondaryIndexes[i].KeySchema"] intValue];
    while (j < count_j) {
        jsonResponse.J = [NSNumber numberWithInt: 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;
}