ServiceResource / Action / create_table

create_table#

DynamoDB.ServiceResource.create_table(**kwargs)#

The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

Request Syntax

table = dynamodb.create_table(
    AttributeDefinitions=[
        {
            'AttributeName': 'string',
            'AttributeType': 'S'|'N'|'B'
        },
    ],
    TableName='string',
    KeySchema=[
        {
            'AttributeName': 'string',
            'KeyType': 'HASH'|'RANGE'
        },
    ],
    LocalSecondaryIndexes=[
        {
            'IndexName': 'string',
            'KeySchema': [
                {
                    'AttributeName': 'string',
                    'KeyType': 'HASH'|'RANGE'
                },
            ],
            'Projection': {
                'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
                'NonKeyAttributes': [
                    'string',
                ]
            }
        },
    ],
    GlobalSecondaryIndexes=[
        {
            'IndexName': 'string',
            'KeySchema': [
                {
                    'AttributeName': 'string',
                    'KeyType': 'HASH'|'RANGE'
                },
            ],
            'Projection': {
                'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
                'NonKeyAttributes': [
                    'string',
                ]
            },
            'ProvisionedThroughput': {
                'ReadCapacityUnits': 123,
                'WriteCapacityUnits': 123
            },
            'OnDemandThroughput': {
                'MaxReadRequestUnits': 123,
                'MaxWriteRequestUnits': 123
            }
        },
    ],
    BillingMode='PROVISIONED'|'PAY_PER_REQUEST',
    ProvisionedThroughput={
        'ReadCapacityUnits': 123,
        'WriteCapacityUnits': 123
    },
    StreamSpecification={
        'StreamEnabled': True|False,
        'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
    },
    SSESpecification={
        'Enabled': True|False,
        'SSEType': 'AES256'|'KMS',
        'KMSMasterKeyId': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TableClass='STANDARD'|'STANDARD_INFREQUENT_ACCESS',
    DeletionProtectionEnabled=True|False,
    ResourcePolicy='string',
    OnDemandThroughput={
        'MaxReadRequestUnits': 123,
        'MaxWriteRequestUnits': 123
    }
)

Parameters:

AttributeDefinitions (list) –
[REQUIRED]

An array of attributes that describe the key schema for the table and indexes.
- (dict) –
  
  Represents an attribute for describing the schema for the table and indexes.
  - AttributeName (string) – [REQUIRED]
    
    A name for the attribute.
  - AttributeType (string) – [REQUIRED]
    
    The data type for the attribute, where:
    - S - the attribute is of type String
    - N - the attribute is of type Number
    - B - the attribute is of type Binary
TableName (string) –
[REQUIRED]

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
KeySchema (list) –
[REQUIRED]

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:
- AttributeName - The name of this key attribute.
- KeyType - The role that the key attribute will assume:
  - HASH - partition key
  - RANGE - sort key
Note
The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
- (dict) –
  
  Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
  
  A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
  
  A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
  - AttributeName (string) – [REQUIRED]
    
    The name of a key attribute.
  - KeyType (string) – [REQUIRED]
    
    The role that this key attribute will assume:
    - HASH - partition key
    - RANGE - sort key
    Note
    The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
LocalSecondaryIndexes (list) –
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:
- IndexName - The name of the local secondary index. Must be unique only for this table.
- KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.
- Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
  - ProjectionType - One of the following:
    - KEYS_ONLY - Only the index and primary keys are projected into the index.
    - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
    - ALL - All of the table attributes are projected into the index.
  - NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
- (dict) –
  
  Represents the properties of a local secondary index.
  - IndexName (string) – [REQUIRED]
    
    The name of the local secondary index. The name must be unique among all other indexes on this table.
  - KeySchema (list) – [REQUIRED]
    
    The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    Note
    The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - (dict) –
      
      Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
      
      A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
      
      A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
      - AttributeName (string) – [REQUIRED]
        
        The name of a key attribute.
      - KeyType (string) – [REQUIRED]
        
        The role that this key attribute will assume:
        
        HASH - partition key
        
        RANGE - sort key
        
        Note
        The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
        
        The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
  - Projection (dict) – [REQUIRED]
    
    Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    - ProjectionType (string) –
      
      The set of attributes that are projected into the index:
      - KEYS_ONLY - Only the index and primary keys are projected into the index.
      - INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      - ALL - All of the table attributes are projected into the index.
      When using the DynamoDB console, ALL is selected by default.
    - NonKeyAttributes (list) –
      
      Represents the non-key attribute names which will be projected into the index.
      
      For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
      - (string) –
GlobalSecondaryIndexes (list) –
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
- IndexName - The name of the global secondary index. Must be unique only for this table.
- KeySchema - Specifies the key schema for the global secondary index.
- Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
  - ProjectionType - One of the following:
    - KEYS_ONLY - Only the index and primary keys are projected into the index.
    - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
    - ALL - All of the table attributes are projected into the index.
  - NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
- ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
- (dict) –
  
  Represents the properties of a global secondary index.
  - IndexName (string) – [REQUIRED]
    
    The name of the global secondary index. The name must be unique among all other indexes on this table.
  - KeySchema (list) – [REQUIRED]
    
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    Note
    The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - (dict) –
      
      Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
      
      A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
      
      A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
      - AttributeName (string) – [REQUIRED]
        
        The name of a key attribute.
      - KeyType (string) – [REQUIRED]
        
        The role that this key attribute will assume:
        
        HASH - partition key
        
        RANGE - sort key
        
        Note
        The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
        
        The sort key of an item is also known as its range attribute. The term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
  - Projection (dict) – [REQUIRED]
    
    Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    - ProjectionType (string) –
      
      The set of attributes that are projected into the index:
      - KEYS_ONLY - Only the index and primary keys are projected into the index.
      - INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      - ALL - All of the table attributes are projected into the index.
      When using the DynamoDB console, ALL is selected by default.
    - NonKeyAttributes (list) –
      
      Represents the non-key attribute names which will be projected into the index.
      
      For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
      - (string) –
  - ProvisionedThroughput (dict) –
    
    Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
    - ReadCapacityUnits (integer) – [REQUIRED]
      
      The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
      
      If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
    - WriteCapacityUnits (integer) – [REQUIRED]
      
      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
      
      If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
  - OnDemandThroughput (dict) –
    
    The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    - MaxReadRequestUnits (integer) –
      
      Maximum number of read request units for the specified table.
      
      To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
    - MaxWriteRequestUnits (integer) –
      
      Maximum number of write request units for the specified table.
      
      To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
BillingMode (string) –
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
- PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
ProvisionedThroughput (dict) –
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
- ReadCapacityUnits (integer) – [REQUIRED]
  
  The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
  
  If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
- WriteCapacityUnits (integer) – [REQUIRED]
  
  The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
  
  If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
StreamSpecification (dict) –
The settings for DynamoDB Streams on the table. These settings consist of:
- StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
- StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table’s stream. Valid values for StreamViewType are:
  - KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
  - NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
  - OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
  - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
- StreamEnabled (boolean) – [REQUIRED]
  
  Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
- StreamViewType (string) –
  
  When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
  - KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
  - NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
  - OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
  - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
SSESpecification (dict) –
Represents the settings used to enable server-side encryption.
- Enabled (boolean) –
  
  Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
- SSEType (string) –
  
  Server-side encryption type. The only supported value is:
  - KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
- KMSMasterKeyId (string) –
  
  The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
Tags (list) –
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
- (dict) –
  
  Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
  
  Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
  
  For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
  - Key (string) – [REQUIRED]
    
    The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
  - Value (string) – [REQUIRED]
    
    The value of the tag. Tag values are case-sensitive and can be null.
TableClass (string) – The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
DeletionProtectionEnabled (boolean) – Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
ResourcePolicy (string) –
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
OnDemandThroughput (dict) –
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
- MaxReadRequestUnits (integer) –
  
  Maximum number of read request units for the specified table.
  
  To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
- MaxWriteRequestUnits (integer) –
  
  Maximum number of write request units for the specified table.
  
  To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

Return type:

dynamodb.Table

Returns:

Table resource