AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to CreateTableAsync.

Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateTableResponse CreateTable(
         CreateTableRequest request
)
Parameters
request
Type: Amazon.DynamoDBv2.Model.CreateTableRequest

Container for the necessary parameters to execute the CreateTable service method.

Return Value
The response from the CreateTable service method, as returned by DynamoDB.

Exceptions

ExceptionCondition
InternalServerErrorException An error occurred on the server side.
LimitExceededException The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10. Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously. The total limit of tables in the ACTIVE state is 250.
ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

Examples

This example shows how to create a new table with a single hash-key component.

CreateTable sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define table schema:
//  Table has a hash-key "Author" and a range-key "Title"
List schema = new List
{
    new KeySchemaElement
    {
        AttributeName = "Author", KeyType = "HASH"
    },
    new KeySchemaElement
    {
        AttributeName = "Title", KeyType = "RANGE"
    }
};

// Define key attributes:
//  The key attributes "Author" and "Title" are string types
List definitions = new List
{
    new AttributeDefinition
    {
        AttributeName = "Author", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Title", AttributeType = "S"
    }
};

// Define table throughput:
//  Table has capacity of 20 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 20,
    WriteCapacityUnits = 50
};

// Configure the CreateTable request
CreateTableRequest request = new CreateTableRequest
{
    TableName = "SampleTable",
    KeySchema = schema,
    ProvisionedThroughput = throughput,
    AttributeDefinitions = definitions
};

// View new table properties
TableDescription tableDescription = client.CreateTable(request).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Creation time: {0}", tableDescription.CreationDateTime);
Console.WriteLine("Item count: {0}", tableDescription.ItemCount);
Console.WriteLine("Table size (bytes): {0}", tableDescription.TableSizeBytes);
Console.WriteLine("Table status: {0}", tableDescription.TableStatus);

// List table key schema
List tableSchema = tableDescription.KeySchema;
for (int i = 0; i < tableSchema.Count; i++)
{
    KeySchemaElement element = tableSchema[i];
    Console.WriteLine("Key: Name = {0}, KeyType = {1}",
        element.AttributeName, element.KeyType);
}

// List attribute definitions
List attributeDefinitions = tableDescription.AttributeDefinitions;
for (int i = 0; i < attributeDefinitions.Count; i++)
{
    AttributeDefinition definition = attributeDefinitions[i];
    Console.WriteLine("Attribute: Name = {0}, Type = {1}",
        definition.AttributeName, definition.AttributeType);
}

Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

                

This example shows how to create a table similar to the previous sample, but with Local Secondary Indexes configured.
The new table will have two indexes: YearsIndex and SettingsIndex.

CreateTable Local Secondary Index sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define table schema:
//  Table has a hash-key "Author" and a range-key "Title"
List schema = new List
{
    new KeySchemaElement
    {
        AttributeName = "Author", KeyType = "HASH"
    },
    new KeySchemaElement
    {
        AttributeName = "Title", KeyType = "RANGE"
    }
};

// Define local secondary indexes:
//  Table has two indexes, one on "Year" and the other on "Setting"
List indexes = new List
{
    new LocalSecondaryIndex
    {
        IndexName = "YearsIndex",
        KeySchema = new List
        {
            // Hash key must match table hash key
            new KeySchemaElement { AttributeName = "Author", KeyType = "HASH" },
            // Secondary index on "Year" attribute
            new KeySchemaElement { AttributeName = "Year", KeyType = "RANGE" }
        },
        // Projection type is set to ALL, all attributes returned for this index
        Projection = new Projection
        {
            ProjectionType = "ALL"
        }
    },
    new LocalSecondaryIndex
    {
        IndexName = "SettingsIndex",
        KeySchema = new List
        {
            // Hash key must match table hash key
            new KeySchemaElement { AttributeName = "Author", KeyType = "HASH" },
            // Secondary index on "Setting" attribute
            new KeySchemaElement { AttributeName = "Setting", KeyType = "RANGE" }
        },
        // Projection type is set to INCLUDE, the specified attributes + keys are returned
        Projection = new Projection
        {
            ProjectionType = "INCLUDE",
            NonKeyAttributes = new List
            {
                "Pages", "Genres"
            }
        }
    }
};

// Define key attributes:
//  The key attributes "Author" and "Title" are string types.
//  The local secondary index attributes are "Year" (numerical) and "Setting" (string).
List definitions = new List
{
    new AttributeDefinition
    {
        AttributeName = "Author", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Title", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Year", AttributeType = "N"
    },
    new AttributeDefinition
    {
        AttributeName = "Setting", AttributeType = "S"
    }
};

// Define table throughput:
//  Table has capacity of 20 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 20,
    WriteCapacityUnits = 50
};

// Configure the CreateTable request
CreateTableRequest request = new CreateTableRequest
{
    TableName = "SampleTable",
    KeySchema = schema,
    ProvisionedThroughput = throughput,
    AttributeDefinitions = definitions,
    LocalSecondaryIndexes = indexes
};

// View new table properties
TableDescription tableDescription = client.CreateTable(request).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Creation time: {0}", tableDescription.CreationDateTime);
Console.WriteLine("Item count: {0}", tableDescription.ItemCount);
Console.WriteLine("Table size (bytes): {0}", tableDescription.TableSizeBytes);
Console.WriteLine("Table status: {0}", tableDescription.TableStatus);

// List table key schema
List tableSchema = tableDescription.KeySchema;
for (int i = 0; i < tableSchema.Count; i++)
{
    KeySchemaElement element = tableSchema[i];
    Console.WriteLine("Key: Name = {0}, KeyType = {1}",
        element.AttributeName, element.KeyType);
}

// List attribute definitions
List attributeDefinitions = tableDescription.AttributeDefinitions;
for (int i = 0; i < attributeDefinitions.Count; i++)
{
    AttributeDefinition definition = attributeDefinitions[i];
    Console.WriteLine("Attribute: Name = {0}, Type = {1}",
        definition.AttributeName, definition.AttributeType);
}

Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also